This endpoint registers tags that are not associated with drug information.
Request
Method
POST {data-service}/v3/tags
The URL will have a .json, .csv, or .xml filename extension appended to it. This will specify the content-type of the API response. If the filename extension is omitted from the URL, .json will be assumed.Resource
Header
Api-Key: 0123456789ABCDEF Content-Type: application/json
Body
NOTE: An actual body would have either the (tag_quantity) or (epc_list), but not both.
Body Fields
| Field | Data Type | Description |
|---|---|---|
| batch_information | hash | Required. Defines attributes about the tags and batch handling. |
| tag_roll_id | string | Required. |
| tag_restricted | boolean | Required, true or false, not null. |
| epc_generation_method | string | Required. Allowed values: kc, tagger. Consult with your Kit Check representative before selecting a method. Once you select a method, you should never change it; otherwise, you risk an EPC collision.
kc – This specifies that Kit Check will be inventing the EPCs for this batch of items being tagged. Kit Check will increment from the last serial number used, within the context of the appropriate tag issuer ID. For this method, the quantity field is required, and the epc_list field must be null. tagger – This specifies that the tagging party (the caller of this API, typically) is inventing their own EPCs for this batch of items being created. For this method, the quantity field must be null, and the epc_list field is required. |
| tag_quantity | integer | Required for kc method. The number of EPCs/tags and items that will be created. If you are creating an additional tag for batch control purposes or other record keeping, please include that tag in this quantity.
Should be null for tagger method. |
| tag_list | array [string] | (required, if “tagger” method) The list of EPCs and TIDs of the tag that make up this batch.
TID list accepts 24 hex characters If using quantities higher than 500 in a single call, please consult with your Kit Check representative first. |
| tag_type_id | integer | Required. This is an ID defined by Kit Check, please consult with your Kit Check representative to get this value. |
Body Example, with TID
{
"batch_information": {
"tag_roll_id": "ABC123",
"tag_restricted": "false",
"epc_generation_method": "tagger",
"tag_quantity": null,
"tag_list":[{ "epc": "800100000000000000000000", "tid": "a90a796b5a43688341318743"}, { "epc": "800100000000000000000001", "tid": "0de6d45a1ad95e3017eff59b"}, { "epc": "800100000000000000000002", "tid": "b07b876a4b7154802143265"}],
"tag_type_id": 99 } }
Body Example, without TID
{
"batch_information": {
"tag_roll_id": "ABC123",
"tag_restricted": "false",
"epc_generation_method": "tagger",
"tag_quantity": null,
"tag_list":[{ "epc": "800100000000000000000000"}, { "epc": "800100000000000000000001"}, { "epc": "800100000000000000000002"}],
"tag_type_id": 99 } }
Tag Issuer ID Notes
Background
- The API will infer the user’s “current hospital” from the bearer token.
- Each hospital has 0 or 1 tag issuer IDs.
Behaviour
- If the hospital has no tag issuer ID, the API call will completely fail.
Response
HTTP status codes
- 201 Created
- 404 Not Found
- 422 Conflict — Represents a wide range of errors. See JSON document in response body for more details on all errors.