For a higher-level overview, see Registry.

Overview

• GET /package-descriptions allows pharmaceutical manufacturers to look up package descriptions.

Request

Method

POST {registry}/api/v1/package-descriptions

Header

Example Header

http-api-key: token
Content-Type: application/json

NOTE: Token should be replaced with your actual API token.

Response

Header

The response header will supply a standard HTTP status code. Currently, the following are supported for application-specific errors.

• 200 OK
• 422 Unprocessable Entity

You may still received other error codes, for example 5xx codes for Server errors. But those aren’t specific to the business logic of this endpoint.

The response header will also contain a transaction ID that can be useful for troubleshooting.

transaction-id: 32f63f5f-0936-4446-864f-8742763a80c5

Body

Example Body — 200 Success

In the event of a 200, information will be returned in the body so you can perform additional validations.

{ 
   "package_descriptions": [ 
      { 
         "id": 1, 
         "abbreviation": "AM", 
         "name": "Ampule" 
      }, 
      { 
         "id": 2, 
         "abbreviation": "AT", 
         "name": "Atomizer" 
      }, 
      { 
         "id": 3, 
         "abbreviation": "BG", 
         "name": "Bag" 
      }, 
      { 
         "id": 4, 
         "abbreviation": "BL", 
         "name": "Blister" 
      } 
   ] 
}

Example Body — 4xx and 5xx Errors

In the event of a non-200 response status (see description in Response Header above), additional information about the error can be found in the response body.

Make sure to log the error IDs so that Kit Check can help you troubleshoot more efficiently.

{
  "errors" : [
    {
      "status": 422,
      "detail": "A human-readable description of the error",
      "id": "32f63f5f-0936-4446-864f-8742763a80c5"
    }
  ]
}