SWAP - Track & Trace API Documentation

⌘K
  2. Home
  4. Docs
  6. SWAP – Track &...
  8. API calls
  10. Metadata Management

Metadata Management

Metadata (or variable data) is attached to registration records. Metadata is shown during authentication event to the user.
Registration records can all have the same metadata or they can each have different metadata depending on the use case. Only authorized users can update or remove metadata.

Add / Update Metadata – Static

POST

/api/v1/update_bulk_metadata

IMPLEMENTATION NOTES

This endpoint helps manage metadata for a single or multiple records. The record in the series will have the same metadata. Any existing metadata will be replaced with the new metadata.

Authorization is required to perform the operation.

AUTHORIZATION

Only authorized users can perform the operation.

PARAMETER

QUERY

None

BODY

Field Type Optional Description
from String   Series start number eg. TEST10001 or 10001
to String   Series end number eg. TEST10010 or 10010
metadata String   Text data (include unicode data) to be updated.
RESPONSE STATUS

Success – 200 HTTP_OK
Failure – 4XX

EXAMPLES
  • Update metadata for a series. Authentication information is passed via user credentials.
REQUEST

POST /api/v1/update_bulk_metadata HTTP/1.1
Host: 35.215.117.72:8015
Content-Type: application/json
Username: testuser
Password: testpass

 

{
"from": "TEST10001",

"to": "TEST10010",
"metadata": "This is my test metadata"
}

 

RESPONSE
{
"message": "Updated Successfully",
"modified": "11 records updated",
"success": true,
}

Add / Update Metadata – Variable

POST

/api/v1/update_bulk_metadata

IMPLEMENTATION NOTES

This endpoint helps manage metadata for a single or multiple records. The record in the series can have different metadata. Any existing metadata will be replaced with the new metadata.

Authorization is required to perform the operation.

AUTHORIZATION

Only authorized users can perform the operation.

PARAMETER

QUERY

None

BODY

Field Type Optional Description
metadata String   List of Variable metadata for each unique tracking code.
RESPONSE STATUS

Success – 200 HTTP_OK
Failure – 4XX

EXAMPLES
  • Update metadata for a series. Authentication information is passed via user credentials.
REQUEST

POST /api/v1/update_bulk_metadata HTTP/1.1
Host: 35.215.117.72:8015
Content-Type: application/json
Username: testuser
Password: testpass

{
"metadata" : {
"TEST10001": "This is first",
"TEST10002": "This is second"}
}

 

RESPONSE
{
"message": "Updated Successfully",
"modified": "2 records updated",
"success": true,
}

Delete Metadata

POST

/api/v1/update_bulk_metadata

IMPLEMENTATION NOTES

This endpoint helps delete metadata for a single or multiple records.

Authorization is required to perform the operation.

AUTHORIZATION

Only authorized users can perform the operation.

PARAMETER

QUERY

None

BODY

Field Type Optional Description
action String   Delete action. e.g. {"action":"delete", "from": "TEST10001", "to":"TEST1003"}
from String   Series start number
to String   Series end number. In case only operation need to be performed, from and to should have same value.
RESPONSE STATUS

Success – 200 HTTP_OK
Failure – 4XX

EXAMPLES
  • Update metadata for a series. Authentication information is passed via user credentials.
REQUEST

POST /api/v1/update_bulk_metadata HTTP/1.1
Host: 35.215.117.72:8015
Content-Type: application/json
Username: testuser
Password: testpass

{
"action": "delete",
"from": "TEST10001",
"to": "TEST10003"
}

 

RESPONSE
{
"message": "Updated Successfully",
"modified": "3 records updated",
"success": true,
}
Tags , , ,

How can we help?