Container VerticalSamples

Sample 1Create a containerization event

  1. Look for "POST/containertags/events/containerization".
  2. Copy and edit the example below into Notepad/Editor. Remember to update event time, created time, and origin date to current date and time.
  3. Copy and paste the edited value and execute.
{
  		"event-type": "CONTAINERIZATION",
  		"tag": "AKE12345EK",
  		"secondary-identifiers": [
    	 {
      		"identifier": "ADH_TUTORIAL",
      		"created": "2999-03-04T11:58:51.119Z",
      		"source": "airline"
    	 }
  		],
  		"segments": [
    	 {
      		"sequence-number": 0,
      		"identifier": {
        	"carrier": "EK",
        	"flight-number": 41,
        	"operational-suffix": "01",
        	"origin-date": "2999-03-04",
        	"origin-iata-code": "DXB",
        	"destination-iata-code": "FRA"
      		}
    	}
  	],
  	"activity": {
    	"type": "CONTAINERIZATION",
    	"timestamp": "2999-03-04T11:58:51.119Z",
    	"location": "AT2",
    	"geo-coordinate": {
      		"latitude": 0,
      		"longitude": 0
    	},
    	"source": "terminal",
    	"function": "LOAD",
    	"aircraft-compartment": {
      		"compartment": "cargo",
      		"hold": "lower"
    	},
    	"load-position": "left"
  	}
}
  1. Run “GET/containertags” with "AKE12345EK" as the tag number.
  2. In the response body, you should find a container tag with a “tag-id” created by ADH.

Note: As this container has not yet been registered, the “container-type” is unknown. The next exercise will show you how to create a registration event.

Sample 2Create a container registration event

  1. Look for "POST/container/events/registration".
  2. Copy and edit the example below into Notepad/Editor. Remember to update event time, created time, and origin date to current date and time.
  3. Copy and paste the edited value and execute.



{
  		"event-type": "REGISTRATION",
  		"tag": "AKE12345EK",
  		"secondary-identifiers": [
    	 {
      		"identifier": "ADH_TUTORIAL",
      		"created": "2999-03-04T12:25:03.620Z",
      		"source": "airline"
    	 }
  		],
  		"segments": [
    	 {
      		"sequence-number": 0,
      		"identifier": {
        	"carrier": "EK",
        	"flight-number": 41,
        	"operational-suffix": "01",
        	"origin-date": "2999-03-04",
        	"origin-iata-code": "DXB",
        	"destination-iata-code": "FRA"
      		}
    	}
  	],
  	"activity": {
    	"type": "REGISTRATION",
    	"timestamp": "2999-03-04T12:25:03.620Z",
    	"location": "AT2",
    	"geo-coordinate": {
      		"latitude": 0,
      		"longitude": 0
    	},
    	"source": "airport",
    	"function": "REGISTER",
    	"container-number": "12345",
    	"container-subtype": "AKE",
    	"container-type": "ULD",
    	"commodity-code": "86090000"
}
}
  1. Run “GET/containertags” with "AKE12345EK" as the tag number and execute.
  2. Because we created the registration event for the same tag number, in the response body, you should find a container tag with the same “tag-id” as the previous exercise.

Now because the container type is given by the registration event, the “container-type” attribute is updated with the value “ULD”.

Note: ADH recognizes the same container tag number and updates its information, even if events are created in random order.

Sample 3Adding new attribute to registration event

  1. Look for "POST/container/events/registration".
  2. Copy and edit the example value below into Notepad/ Editor. Remember to update event time, created time, and origin date to current date and time.
  3. Copy and paste the edited value and execute.
{
  		"event-type": "REGISTRATION",
  		"tag": "AKE54321EK",
  		"secondary-identifiers": [
    	 {
      		"identifier": "ADH_TUTORIAL",
      		"created": "2999-03-23T12:25:03.620Z",
      		"source": "airline"
    	 }
  		],
  		"segments": [
    	 {
      		"sequence-number": 0,
      		"identifier": {
        	"carrier": "EK",
        	"flight-number": 41,
        	"operational-suffix": "01",
        	"origin-date": "2999-03-23",
        	"origin-iata-code": "DXB",
        	"destination-iata-code": "FRA"
      		}
    	}
  	],
  	"activity": {
    	"type": "REGISTRATION",
    	"timestamp": "2999-03-23T12:25:03.620Z",
    	"location": "AT2",
    	"geo-coordinate": {
      		"latitude": 0,
      		"longitude": 0
    	},
    	"source": "airport",
    	"function": "REGISTER",
    "container-number": "54321",
    	"container-subtype": "AKE",
    	"container-type": "ULD",
    	"commodity-code": "86090000",
		"segment": "1"
}
}
  1. Run “GET/containertags” with "AKE54321EK" as the tag number.
  2. In the response body, you should find a container tag with the added attribute “segment”.