GET api/v{version}/cancelcodes

Gets the available system and user defined cancellation codes.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns each cancellation code's short code as well as description.

Collection of CancelCode
NameDescriptionTypeAdditional information
Code

The value of the cancellation code

 string

None.
Name

The name of the cancellation code

 string

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "code": "400",
    "name": "Advance"
  },
  {
    "code": "410",
    "name": "Late"
  },
  {
    "code": "420",
    "name": "At Door"
  },
  {
    "code": "430",
    "name": "Same Day"
  },
  {
    "code": "440",
    "name": "Site Closure"
  },
  {
    "code": "450",
    "name": "User Error"
  },
  {
    "code": "460",
    "name": "Client Inactive"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCancelCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <CancelCode>
    <Code>400</Code>
    <Name>Advance</Name>
  </CancelCode>
  <CancelCode>
    <Code>410</Code>
    <Name>Late</Name>
  </CancelCode>
  <CancelCode>
    <Code>420</Code>
    <Name>At Door</Name>
  </CancelCode>
  <CancelCode>
    <Code>430</Code>
    <Name>Same Day</Name>
  </CancelCode>
  <CancelCode>
    <Code>440</Code>
    <Name>Site Closure</Name>
  </CancelCode>
  <CancelCode>
    <Code>450</Code>
    <Name>User Error</Name>
  </CancelCode>
  <CancelCode>
    <Code>460</Code>
    <Name>Client Inactive</Name>
  </CancelCode>
</ArrayOfCancelCode>