Export Health Certificate Reference Data API

API

This API enables traders to check reference data needed for export health certificates. This is the first step towards enabling digital integration for moving agri-food goods.

Operations

The following operations are available for this API. Expand the sections to find out more about each, including the parameters and request/response structures.

Get /border-control-post

Find Border Control Posts in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
id

Filter by Id containing value.

Data type: string
Parameter location: Query
Is mandatory: No
schemaName

Filter by SchemaName containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Border Control Posts.

Here is an example response for this BorderControlPostPagedResult schema: 

{
  "data": [
    {
      "id": {
        "id": "string",
        "name": "string",
        "schemaId": "string",
        "schemaName": "string",
        "agencyId": "string",
        "agencyName": "string",
        "versionId": "string",
        "uniformResourceId": "string",
        "schemaUniformResourceId": "string",
        "language": "EN"
      },
      "name": "string"
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /certifier

Find Certifier details in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
postcode

Filter by Postcode containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Certifier details.

Here is an example response for this PartyPagedResult schema: 

{
  "data": [
    {
      "uid": [
        {
          "id": "string",
          "name": "string",
          "schemaId": "string",
          "schemaName": "string",
          "agencyId": "string",
          "agencyName": "string",
          "versionId": "string",
          "uniformResourceId": "string",
          "schemaUniformResourceId": "string",
          "language": "EN"
        }
      ],
      "name": "",
      "address": {
        "postCode": "string",
        "coordinates": {
          "latitude": 51.509865,
          "longitude": -0.118092
        },
        "what3Words": {
          "wordOne": "",
          "wordTwo": "",
          "wordThree": ""
        },
        "unlocode": "string",
        "lineOne": "string",
        "lineTwo": "string",
        "lineThree": "string",
        "lineFour": "string",
        "lineFive": "string",
        "city": "string",
        "country": {
          "countryId": {
            "id": "string",
            "name": "string",
            "schemaId": "string",
            "schemaName": "string",
            "agencyId": "string",
            "agencyName": "string",
            "versionId": "string",
            "uniformResourceId": "string",
            "schemaUniformResourceId": "string",
            "language": "EN"
          },
          "countrySubDivisionId": [
            {
              "id": "string",
              "name": "string",
              "schemaId": "string",
              "schemaName": "string",
              "agencyId": "string",
              "agencyName": "string",
              "versionId": "string",
              "uniformResourceId": "string",
              "schemaUniformResourceId": "string",
              "language": "EN"
            }
          ],
          "market": "string"
        },
        "approvalNumber": {
          "id": "string",
          "name": "string",
          "schemaId": "string",
          "schemaName": "string",
          "agencyId": "string",
          "agencyName": "string",
          "versionId": "string",
          "uniformResourceId": "string",
          "schemaUniformResourceId": "string",
          "language": "EN"
        }
      },
      "contact": [
        {
          "name": "",
          "fullName": {
            "title": "Mr",
            "givenName": "Steven",
            "middleNames": "John",
            "surname": "Smith"
          },
          "contactDetail": {
            "phoneNumber": "string",
            "emailAddress": "string"
          },
          "certification": [
            {
              "id": "string",
              "name": "string",
              "schemaId": "string",
              "schemaName": "string",
              "agencyId": "string",
              "agencyName": "string",
              "versionId": "string",
              "uniformResourceId": "string",
              "schemaUniformResourceId": "string",
              "language": "EN"
            }
          ]
        }
      ],
      "specifiedPerson": {
        "name": "",
        "fullName": {
          "title": "Mr",
          "givenName": "Steven",
          "middleNames": "John",
          "surname": "Smith"
        },
        "contactDetail": {
          "phoneNumber": "string",
          "emailAddress": "string"
        },
        "certification": [
          {
            "id": "string",
            "name": "string",
            "schemaId": "string",
            "schemaName": "string",
            "agencyId": "string",
            "agencyName": "string",
            "versionId": "string",
            "uniformResourceId": "string",
            "schemaUniformResourceId": "string",
            "language": "EN"
          }
        ]
      }
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /country

Find Country details in Reference Data.

Parameters
Name Description
id

Filter by Id containing value.

Data type: string
Parameter location: Query
Is mandatory: No
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Country details.

Here is an example response for this CountryPagedResult schema: 

{
  "data": [
    {
      "countryId": {
        "id": "string",
        "name": "string",
        "schemaId": "string",
        "schemaName": "string",
        "agencyId": "string",
        "agencyName": "string",
        "versionId": "string",
        "uniformResourceId": "string",
        "schemaUniformResourceId": "string",
        "language": "EN"
      },
      "countrySubDivisionId": [
        {
          "id": "string",
          "name": "string",
          "schemaId": "string",
          "schemaName": "string",
          "agencyId": "string",
          "agencyName": "string",
          "versionId": "string",
          "uniformResourceId": "string",
          "schemaUniformResourceId": "string",
          "language": "EN"
        }
      ],
      "market": "string"
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /measurement-temperature

Find Measurement Temperature details in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
description

Filter by Description containing value.

Data type: string
Parameter location: Query
Is mandatory: No
code

Filter by Code containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Measurement Temperature data.

Here is an example response for this ReferenceDataResultPagedResult schema: 

{
  "data": [
    {
      "code": "string",
      "name": "string",
      "description": "string",
      "language": "string"
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /measurement-weight

Find Measurement Weight in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
description

Filter by Description containing value.

Data type: string
Parameter location: Query
Is mandatory: No
code

Filter by Code containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Measurement Weight.

Here is an example response for this ReferenceDataResultPagedResult schema: 

{
  "data": [
    {
      "code": "string",
      "name": "string",
      "description": "string",
      "language": "string"
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /metadata

Retrieve a list of Export Health Certificate Reference Data metadata.

Parameters
There are no parameters needed for this operation.


Responses application/json
Code Description
200

Result of Export Health Certificate Reference Data end points.

Here is an example response for this MetadataGet200ApplicationJsonResponse schema: 

[
  {
    "_links": [
      {
        "href": "string",
        "rel": "string",
        "method": "string"
      }
    ],
    "name": "Name",
    "description": "Summary description"
  }
]
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}

Get /package-type

Find Package Types in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
id

Filter by Id containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Package Types.

Here is an example response for this PackagePagedResult schema: 

{
  "data": [
    {
      "level": {
        "id": "string",
        "name": "string",
        "schemaId": "string",
        "schemaName": "string",
        "agencyId": "string",
        "agencyName": "string",
        "versionId": "string",
        "uniformResourceId": "string",
        "schemaUniformResourceId": "string",
        "language": "EN"
      },
      "type": {
        "id": "string",
        "name": "string",
        "schemaId": "string",
        "schemaName": "string",
        "agencyId": "string",
        "agencyName": "string",
        "versionId": "string",
        "uniformResourceId": "string",
        "schemaUniformResourceId": "string",
        "language": "EN"
      },
      "itemQuantity": {
        "value": 0.0,
        "unit": "string",
        "version": "string",
        "measureNote": "string"
      },
      "nominalGrossWeight": {
        "value": 0.0,
        "unit": "string",
        "version": "string",
        "measureNote": "string"
      },
      "nominalGrossVolume": {
        "value": 0.0,
        "unit": "string",
        "version": "string",
        "measureNote": "string"
      }
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Get /transport-means

Find Transport Means in Reference Data.

Parameters
Name Description
name

Filter by Name containing value.

Data type: string
Parameter location: Query
Is mandatory: No
description

Filter by Description containing value.

Data type: string
Parameter location: Query
Is mandatory: No
code

Filter by Code containing value.

Data type: string
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
400

Request failed validation. Errors can be found in the response body.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}
200

Paged result of Transport Means.

Here is an example response for this ReferenceDataResultPagedResult schema: 

{
  "data": [
    {
      "code": "string",
      "name": "string",
      "description": "string",
      "language": "string"
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}

Schemas

The following section shows the model definitions that are used by the operations above when sending and receiving data to the API.

Address

Address details.

Property Value
postCode

Postcode.
Data type: string
Is mandatory: No
coordinates

Geographic co-ordinates.
Data type: object using the model Coordinates
Is mandatory: No
what3Words

What 3 Words location identifier details.
Data type: object using the model What3Words
Is mandatory: No
unlocode

United Nations Code for Trade and Transport Locations.
Data type: string
Is mandatory: No
lineOne

Address line one.
Data type: string
Is mandatory: No
lineTwo

Address line two.
Data type: string
Is mandatory: No
lineThree

Address line three.
Data type: string
Is mandatory: No
lineFour

Address line four.
Data type: string
Is mandatory: No
lineFive

Address line five.
Data type: string
Is mandatory: No
city

City.
Data type: string
Is mandatory: No
country

Country details.
Data type: object using the model Country
Is mandatory: No
approvalNumber

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No

BorderControlPost

Border control post information.

Property Value
id

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
name

Name of the BCP.
Data type: string
Is mandatory: No

BorderControlPostPagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model BorderControlPost
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

CommonProblemDetails

Common API problem format for describing system and user error HTTP API responses based on https://tools.ietf.org/html/rfc7807.

Property Value
type

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
Data type: string
Is mandatory: No
title

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see[RFC7231], Section 3.4).
Data type: string
Is mandatory: No
status

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
Data type: integer with format int32
Is mandatory: No
detail

A human-readable explanation specific to this occurrence of the problem.
Data type: string
Is mandatory: No
instance

A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced.
Data type: string
Is mandatory: No
errors

Errors associated with the request.
Is mandatory: No

ContactDetail

Person contact detail.

Property Value
phoneNumber

Contact telephone number.
Data type: string
Is mandatory: No
emailAddress

Contact email address.
Data type: string
Is mandatory: No

Coordinates

Geographic co-ordinates.

Property Value
latitude

Latitude.
Data type: number with format double
For example: 51.509865
Is mandatory: No
longitude

Longitude.
Data type: number with format double
For example: -0.118092
Is mandatory: No

Country

Country details.

Property Value
countryId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
countrySubDivisionId

ISO country sub division code identifier.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No
market

The trading market / block the country is part of.
Data type: string
Is mandatory: No

CountryPagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model Country
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

DatasetMetadata

Reference Data meta-data.

Property Value
_links

Hypermedia as the Engine of Application State (HATEOAS) links to related resources.
Data type: array [object] using the model ResourceLink
Is mandatory: No
name

Reference Data name.
Data type: string
For example: Name
Is mandatory: No
description

Description.
Data type: string
For example: Summary description
Is mandatory: No

Measure

A numeric value determined by measuring an object along with the specified unit of measure.

Property Value
value

The numeric value determined by measuring an object.
Data type: number with format double
Is mandatory: No
unit

Type of unit describing the measure.
Data type: string
Is mandatory: No
version

The version of the measure unit code list.
Data type: string
Is mandatory: No
measureNote

Information or additional detail regarding the measure.
Data type: string
Is mandatory: No

Package

A physical package for a trade line item.

Property Value
level

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
type

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
itemQuantity

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
nominalGrossWeight

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
nominalGrossVolume

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No

PackagePagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model Package
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

Party

The definition of a responsible party in the chain.

Property Value
uid

Identifier the party is known by.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No
name

Name of the party.
Data type: string
For example:
Is mandatory: No
address

Address details.
Data type: object using the model Address
Is mandatory: No
contact

Details of relevant persons at the Party.
Data type: array [object] using the model Person
Is mandatory: No
specifiedPerson

Persons details.
Data type: object using the model Person
Is mandatory: No

PartyPagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model Party
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

Person

Persons details.

Property Value
name

Unstructured / preferred name as text.
Data type: string
For example:
Is mandatory: No
fullName

Structured name for a person.
Data type: object using the model PersonName
Is mandatory: No
contactDetail

Person contact detail.
Data type: object using the model ContactDetail
Is mandatory: No
certification

Details of the certifications the representative holds if applicable.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No

PersonName

Structured name for a person.

Property Value
title

Title.
Data type: string
For example: Mr
Is mandatory: No
givenName

Given / first name.
Data type: string
For example: Steven
Is mandatory: No
middleNames

Middle names.
Data type: string
For example: John
Is mandatory: No
surname

Surname / last name.
Data type: string
For example: Smith
Is mandatory: No

ReferenceDataResult

Property Value
code

Code supplied from source
Data type: string
Is mandatory: No
name

Name
Data type: string
Is mandatory: No
description

Description
Data type: string
Is mandatory: No
language

Language, defaults to EN
Data type: string
Is mandatory: No

ReferenceDataResultPagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model ReferenceDataResult
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

ResourceLink

Hypermedia as the Engine of Application State (HATEOAS) resource link.

Property Value
href

Uniform Resource Identifier of the resource being linked to.
Data type: string
Is mandatory: No
rel

Relationship of the resource.
Data type: string
Is mandatory: No
method

HTTP method to use when calling the resource.
Data type: string
Is mandatory: No

TradeIdentifier

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.

Property Value
id

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects within the same scheme.
Data type: string
Is mandatory: No
name

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute.
Data type: string
Is mandatory: No
schemaId

The identification of the identification scheme.
Data type: string
Is mandatory: No
schemaName

The name of the identification scheme.
Data type: string
Is mandatory: No
agencyId

The identification of the agency that maintains the identification scheme.
Data type: string
Is mandatory: No
agencyName

The name of the agency that maintains the identification scheme.
Data type: string
Is mandatory: No
versionId

The Version of the identification scheme.
Data type: string
Is mandatory: No
uniformResourceId

The Uniform Resource Identifier that identifies where the identification scheme data is located.
Data type: string
Is mandatory: No
schemaUniformResourceId

The Uniform Resource Identifier that identifies where the identification scheme is located.
Data type: string
Is mandatory: No
language

The identifier of the language used in the corresponding text string.
Data type: string
For example: EN
Is mandatory: No

What3Words

What 3 Words location identifier details.

Property Value
wordOne

Word one.
Data type: string
For example:
Is mandatory: No
wordTwo

Word two.
Data type: string
For example:
Is mandatory: No
wordThree

Word three.
Data type: string
For example:
Is mandatory: No

Downloads

This API follows the OpenApi specification and is available for export and download in the following formats:

Download the OpenAPI 3 JSON file

OpenAPI 3 JSON

JSON, 4 KB

This file contains the JSON Format for OpenApi 3.

Download the OpenAPI 3 YAML file

OpenAPI 3 YAML

YAML, 4 KB

This file contains the YAML Format for OpenApi 3.