NGngpvan

/codes

Changed on

Use this endpoint to find Codes available in the current context using a number of filter options.

By default, this endpoint returns 50 records per request. A maximum of 200 records per request is allowed via the $top parameter.

The only valid expansion property is: supportedEntities.

The only valid orderby property is: dateModified.

get/codes

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/codes
  • Auth
    HTTP basic

Query parameters

supportedEntitiesstring

Filters to Codes that are searchable or applicable to this comma separated list of Entities

namestring

Filters to Codes with names that contain the given input

parentCodeIdinteger

Filters to Codes that are direct children of the given Code ID

codeTypestring

Filters to Codes which match the specified Code Type; must be a Code Type available to the API key, as determined by GET /codeTypes

$expandstring

Optional; comma-delimited list of expansion properties: supportedEntities

$orderbystring

Optional; sorts results in ascending (asc) or descending (desc) order by a comma-delimited list of properties: dateModified. Note that a space is required between the property and asc or desc.

Response

200

nextPageLinkstring
countinteger

Example response

{
  "items": [
    {
      "codeId": 20515,
      "parentCodeId": 20513,
      "name": "Labor",
      "codeType": "Tag",
      "dateCreated": "2015-04-05T12:59:00Z",
      "dateModified": "2015-05-01T09:59:00Z",
      "supportedEntities": [
        {
          "name": "Organizations",
          "isSearchable": true
        }
      ]
    }
  ],
  "nextPageLink": "https://api.securevan.com:443/v4/codes?parentCodeId=20513&$expand=supportedEntities&$top=1&$skip=1",
  "count": 1
}

Changes