GET api/LookupList

Use to get all the lookups regardless of type or code.This could be a large list!
To get all lookups for a given type and code use: GET .../api/Lookups?type={type}&code={code}
To get all lookups for a given type regardless of code: GET .../api/Lookups?type={type}

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

Name	Description	Type	Additional information
page	The page number to return using the pageSize parameter to define pages. Defaults to 1000.	integer	Default value is 1
pageSize	The page size (number of records) to be used to find the record for the page requested. Defaults to 10.	integer	Default value is 1000

Body Parameters

None.

Response Information

Resource Description

The requested lookups as a PagedObject of type LookupView

PagedObjectOfLookupView

Name	Description	Type	Additional information
Items		Collection of LookupView	None.
PageInfo		PagedListPageInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "type": "sample string 1",
      "code": "sample string 2",
      "description": "sample string 3",
      "active": true
    },
    {
      "type": "sample string 1",
      "code": "sample string 2",
      "description": "sample string 3",
      "active": true
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "countThisPage": 5,
    "hasPreviousPage": true,
    "hasNextPage": true,
    "errorMessage": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<PagedObjectOfLookupView xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Items>
    <LookupView>
      <Type>sample string 1</Type>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <Active>true</Active>
    </LookupView>
    <LookupView>
      <Type>sample string 1</Type>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <Active>true</Active>
    </LookupView>
  </Items>
  <PageInfo>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
    <CountThisPage>5</CountThisPage>
    <HasPreviousPage>true</HasPreviousPage>
    <HasNextPage>true</HasNextPage>
    <ErrorMessage>sample string 8</ErrorMessage>
  </PageInfo>
</PagedObjectOfLookupView>