GET api/ListMaintenance/ListDefinitions

Get a full list of list definitions, including routes and special lists.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of list definitions

Collection of ListDefinition

Name	Description	Type	Additional information
ListReferenceId	Unique List Reference Id	integer	None.
ListTypeId	List Type Id	integer	None.
ListTypeDescription	List type description	string	None.
ClientId	Client ID	integer	None.
CompanyCode	Company Code	string	None.
ShortDescription	Short Description	string	None.
LongDescription	Long description	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ListReferenceId": 1,
    "ListTypeId": 2,
    "ListTypeDescription": "sample string 3",
    "ClientId": 4,
    "CompanyCode": "sample string 5",
    "ShortDescription": "sample string 6",
    "LongDescription": "sample string 7"
  },
  {
    "ListReferenceId": 1,
    "ListTypeId": 2,
    "ListTypeDescription": "sample string 3",
    "ClientId": 4,
    "CompanyCode": "sample string 5",
    "ShortDescription": "sample string 6",
    "LongDescription": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfListMaintenanceController.ListDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <ListMaintenanceController.ListDefinition>
    <ClientId>4</ClientId>
    <CompanyCode>sample string 5</CompanyCode>
    <ListReferenceId>1</ListReferenceId>
    <ListTypeDescription>sample string 3</ListTypeDescription>
    <ListTypeId>2</ListTypeId>
    <LongDescription>sample string 7</LongDescription>
    <ShortDescription>sample string 6</ShortDescription>
  </ListMaintenanceController.ListDefinition>
  <ListMaintenanceController.ListDefinition>
    <ClientId>4</ClientId>
    <CompanyCode>sample string 5</CompanyCode>
    <ListReferenceId>1</ListReferenceId>
    <ListTypeDescription>sample string 3</ListTypeDescription>
    <ListTypeId>2</ListTypeId>
    <LongDescription>sample string 7</LongDescription>
    <ShortDescription>sample string 6</ShortDescription>
  </ListMaintenanceController.ListDefinition>
</ArrayOfListMaintenanceController.ListDefinition>