GET api/Lookups

Gets the current lookup for a given type.
To get the lookup for a type and code use: GET .../api/Lookups?type={type}&code={code}
To get all lookups for a given type use: GET .../api/Lookups?type={type}
To get all lookups use: GET .../api/Lookup/ or: GET .../api/LookupList/

Request Information

URI Parameters

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

Name	Description	Type	Additional information
type	The type of lookups to be returned	string	None.
page	The page number to return using the pageSize parameter to define pages. Defaults to 1.	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 1000.	integer	Default value is 1000

Body Parameters

None.

Response Information

Resource Description

The returned resource is a list of LookupViews followed by a PageInfo object that provides pagination information that is also contained in the X-PAGINATION header for backwards compatibility.

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:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>