POST LookupListValue/GetCodeDetailsByCode

Returns a full detailed list of codes based on the codes passed in

Request Information

URI Parameters

None.

Body Parameters

LookupListDetailRequestDTO
NameDescriptionTypeAdditional information
Codes

Available codes

Collection of string

None.

ListID

List of id's

Lists

None.

Request Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "Codes": [
        "sample string 1",
        "sample string 2"
      ],
      "ListID": 1
    }
  ]
}

text/javascript

Sample:
{"results":[{"Codes":["sample string 1","sample string 2"],"ListID":1}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<LookupListDetailRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <Codes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Codes>
  <ListID>GenericName</ListID>
</LookupListDetailRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of LookupListValueDTO
NameDescriptionTypeAdditional information
ListId

List of id's

Lists

None.

CategoryId

Return Category id

integer

None.

ItemName

Item Name

string

None.

ItemCode

Item Code

string

None.

ItemCodeWithNoPeriod

Item code with No Period

string

None.

ExpireDate

Item code Expiration date

date

None.

ID

Returns ID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "ListId": 1,
      "CategoryId": 1,
      "ItemName": "sample string 2",
      "ItemCode": "sample string 3",
      "ItemCodeWithNoPeriod": "sample string 4",
      "ExpireDate": "2024-05-13T23:10:25Z",
      "ID": 5
    },
    {
      "ListId": 1,
      "CategoryId": 1,
      "ItemName": "sample string 2",
      "ItemCode": "sample string 3",
      "ItemCodeWithNoPeriod": "sample string 4",
      "ExpireDate": "2024-05-13T23:10:25Z",
      "ID": 5
    }
  ]
}

text/javascript

Sample:
{"results":[{"ListId":1,"CategoryId":1,"ItemName":"sample string 2","ItemCode":"sample string 3","ItemCodeWithNoPeriod":"sample string 4","ExpireDate":"2024-05-13T23:10:25Z","ID":5},{"ListId":1,"CategoryId":1,"ItemName":"sample string 2","ItemCode":"sample string 3","ItemCodeWithNoPeriod":"sample string 4","ExpireDate":"2024-05-13T23:10:25Z","ID":5}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<ArrayOfLookupListValueDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <LookupListValueDTO>
    <CategoryId>1</CategoryId>
    <ExpireDate>2024-05-13T23:10:25.9821862-04:00</ExpireDate>
    <ID>5</ID>
    <ItemCode>sample string 3</ItemCode>
    <ItemCodeWithNoPeriod>sample string 4</ItemCodeWithNoPeriod>
    <ItemName>sample string 2</ItemName>
    <ListId>GenericName</ListId>
  </LookupListValueDTO>
  <LookupListValueDTO>
    <CategoryId>1</CategoryId>
    <ExpireDate>2024-05-13T23:10:25.9821862-04:00</ExpireDate>
    <ID>5</ID>
    <ItemCode>sample string 3</ItemCode>
    <ItemCodeWithNoPeriod>sample string 4</ItemCodeWithNoPeriod>
    <ItemName>sample string 2</ItemName>
    <ListId>GenericName</ListId>
  </LookupListValueDTO>
</ArrayOfLookupListValueDTO>