Message Examples

The Message Examples section is where fully populated message examples for both the request and response are located. Select the drop-down option associated with the example you wish to view and the example displays:

Line numbers and syntax highlights are only available in the online version of the guide.

Example

{
    "t": {
    	"v": 1,
    	"m": "sem--set-event--v1",
    	"app-id": "D29A8B05-F8A7-4F35-9C7D-84344E0BE095"
    },
    "p": {
        "eventTime": "2018-06-05T01:33:35Z",
        "serialNumberList": [
            {
                "serialNumber":"PK009FF8895F416984B",
                "lotNumber":"TEST2C9588146D",
                "expirationDate":"230531",
                "packagingCode":"86740665964858",
                "packagingCodeType": "GTIN-14"
            }
        ],
        "eventType": "AVAILABLE",
        "locationType": "SGLN",
        "locationValue": "030058.123456.0",
        "extensionData": [
            {
                "extensionKey": "market",
                "extensionValue": "SZ"
            }
        ],
        "customData": [
            {
                "extensionKey": "reason",
                "extensionValue": "Verified that product is valid for sale. Issue #394985. Approved by J. Martin."
            }
        ]
    }
}
{
    "t": {
    	"v": 1,
    	"m": "sem—set-event-Response—v1",
    	"app-id": "393C3176-6F7C-438D-B06F-DDCDA21C2E5C",
    	"cid": "b6269930-b08e-44b7-b318-49238d189ffb",
    	"errc": "200_SUCCESSFUL_OPERATION",
    	"errm": "Successful Operation. Request completed successfully."
    },
    "p": {
        "eventId": "671397ed-9964-41e9-8670-8ad2c743008a",
        "eventTime": "2018-06-05T01:33:34.711Z",
            {
                "serialNumber":"PK009FF8895F416984B",
                "lotNumber":"TEST2C9588146D",
                "expirationDate":"230531",
                "packagingCode":"86740665964858",
                "packagingCodeType": "GTIN-14"
            }
            },
            "eventType": "AVAILABLE",
            "locationType": "SGLN",
            "locationValue": "030058.123456.0",
            "extensionData": [
                {
                    "extensionKey": "market",
                    "extensionValue": "SZ",
                    "extensionKey ": "status",
                    "extensionValue ": "SUCCESS"
                }
            ] ,
            "customData": [
                {
                    "extensionKey": "reason",
                    "extensionValue": "Verified that product is valid for sale. Issue #394985. Approved by J. Martin."
                }
        ]
}

Copy and Paste Instructions

  1. Create a blank text file and it save locally.
  2. Navigate to the message sample within the appropriate API Guide.
  3. Select the Copy to Clipboard icon (Copy to Clipboard).

    The Copied to Clipboard icon (Copied to Clipboard) displays for 2 seconds, indicating that the copy is successful.

  4. Navigate to the first row of the saved text file and select Paste.

    The message example's structure is maintained.

    Syntax highlights will not reflect unless enabled in the file editor.