Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Get details of a specific series by ID.

get/apps/at-pt/v1/entry/{silo_entry_id}/series/{id}

Path parameters

silo_entry_idstring required

Silo entry ID of the supplier to get the series for.

Example:347c5b04-cde2-11ed-afa1-0242ac120002

Silo entry ID of the supplier to get the series for.

idstring required

UUID of the series to get the details for.

Example:1d8ab49a-bd14-11ef-925f-325096b39f47

UUID of the series to get the details for.

Response

Series details.

idstring

Series ID.

codestring

Full series code (document type + base code).

basestring

Base code for the series.

document_typestring

Document type for the series.

typestring

Type of the series.

validation_codestring

AT validation code for the series used to generate ATCUD codes.

Example response

{
  "id": "1d8ab49a-bd14-11ef-925f-325096b39f47",
  "code": "FT SERIES-A",
  "base": "SERIES-A",
  "document_type": "FT",
  "type": "N",
  "validation_code": "AAJFJ3N5YS"
}