Last active
July 13, 2023 09:37
-
-
Save aldidoanta/16d6176bfc54f8d401a93f20fd167211 to your computer and use it in GitHub Desktop.
Source: https://otm5.opentripmodel.org/#tag/Consignment/paths/~1api~1v5~1consignments~1%7BUUID%7D/get
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"id": "string", | |
"name": "string", | |
"creationDate": "string", | |
"lastModified": "string", | |
"contextEvents": [ | |
{ | |
"id": "fc6b2b0c-2f0a-40c6-a580-212c5c7984c8", | |
"name": "couple vehicle to trip", | |
"lifecycle": "planned", | |
"entity1": { | |
"uuid": "50824123-0924-4563-ac1e-ca0e37487823", | |
"entityType": "trip", | |
"associationType": "reference" | |
}, | |
"entity2": { | |
"entity": { | |
"id": "b9bb914d-845e-46f2-91ff-31fa4bac2fbe", | |
"name": "Bob's Boxtruck", | |
"vehicleType": "boxtruck", | |
"fuel": "electricity", | |
"loadCapacities": [ | |
{ | |
"value": 1000, | |
"unit": "kg" | |
} | |
], | |
"length": { | |
"value": 8, | |
"unit": "m" | |
}, | |
"height": { | |
"value": 2.8, | |
"unit": "m" | |
}, | |
"width": { | |
"value": 2, | |
"unit": "m" | |
}, | |
"licensePlate": "AB-12-CD", | |
"emptyWeight": { | |
"value": 2000, | |
"unit": "kg" | |
}, | |
"entityType": "vehicle" | |
}, | |
"associationType": "inline" | |
}, | |
"eventType": "associationCreatedEvent" | |
} | |
], | |
"externalAttributes": { | |
"property1": {}, | |
"property2": {} | |
}, | |
"description": "string", | |
"status": "draft", | |
"type": "string", | |
"goods": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "903807df-ee62-47aa-bf8e-7efd747618ce", | |
"description": "Box of bananas", | |
"remark": "Please deliver in time, we want fresh bananas", | |
"barCode": "CSE370", | |
"productType": "Fruit", | |
"packagingMaterial": "Box", | |
"constraint": { | |
"entity": { | |
"value": { | |
"and": [ | |
{ | |
"startTime": "2021-06-23T10:00:00Z", | |
"endTime": "2021-06-23T13:00:00Z", | |
"description": "alert-threshold", | |
"type": "timeWindowConstraint" | |
}, | |
{ | |
"constraintType": "maximum", | |
"maximum": { | |
"value": 5, | |
"unit": "C" | |
}, | |
"type": "temperatureConstraint" | |
}, | |
{ | |
"or": [ | |
{ | |
"fuelTypes": [ | |
"battery" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"fuelTypes": [ | |
"biodiesel" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"minimum": "euro5", | |
"type": "emissionStandardConstraint" | |
} | |
], | |
"type": "orConstraint" | |
} | |
], | |
"type": "andConstraint" | |
} | |
}, | |
"associationType": "inline" | |
}, | |
"type": "items" | |
}, | |
"description": "string" | |
} | |
], | |
"transportOrder": { | |
"associationType": "inline", | |
"entity": { | |
"id": "baa507c2-1d81-4092-a5c2-e80820ee4fd1", | |
"externalAttributes": { | |
"id": "OrderId" | |
}, | |
"description": "Transport order containing all consignments to be shipped.", | |
"consignments": [ | |
{ | |
"entity": { | |
"id": "e75a541b-e9d9-49e7-8bba-95492d682a6c", | |
"description": "Package for miss X." | |
}, | |
"associationType": "inline" | |
}, | |
{ | |
"entity": { | |
"id": "4a08bd61-720e-4a8c-81cf-028f1271c4da", | |
"description": "Package for mr Y." | |
}, | |
"associationType": "inline" | |
} | |
] | |
}, | |
"description": "string" | |
}, | |
"documents": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "cf32da57-5edc-4c46-9a97-58c97ae27cf8", | |
"name": "Photo of the PoD", | |
"content": { | |
"uri": "https://link-to-the-actual-document.org/1234", | |
"contentType": "link" | |
}, | |
"externalAttributes": { | |
"externalID": "photo1234" | |
}, | |
"documentType": "photo", | |
"filename": "my_photo.JPG", | |
"mimeType": "image/jpeg", | |
"description": "Proof that the goods are delivered by providing the photo that captures the moment", | |
"creator": { | |
"uuid": "655a2a4e-79b1-4637-9f13-b904730022ef", | |
"entityType": "actor", | |
"associationType": "reference" | |
}, | |
"owner": { | |
"uuid": "655a2a4e-79b1-4637-9f13-b904730022ef", | |
"entityType": "actor", | |
"associationType": "reference" | |
} | |
}, | |
"description": "string" | |
} | |
], | |
"remark": "string", | |
"actors": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "45db6ed0-28a7-4e4a-baba-3d5f8d171103", | |
"name": "Logistics manager", | |
"contactDetails": [ | |
{ | |
"value": "Simon Isaac", | |
"remark": "Wants to be called 'Sim'.", | |
"type": "firstName" | |
}, | |
{ | |
"value": "Macan", | |
"type": "lastName" | |
}, | |
{ | |
"value": "+312012345678", | |
"remark": "private cellphone of the CEO", | |
"language": "nld", | |
"type": "phone" | |
}, | |
{ | |
"value": "simon@macan", | |
"type": "email" | |
}, | |
{ | |
"value": "NL74BANK5890469479", | |
"type": "iban" | |
}, | |
{ | |
"value": "NL000099998B57", | |
"type": "vatCode" | |
} | |
] | |
}, | |
"description": "string", | |
"roles": [ | |
"shipper" | |
] | |
} | |
], | |
"actions": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "e81a7aa3-23a6-4089-b916-52b854c7b6f1", | |
"lifecycle": "planned", | |
"remark": "loading a consignment", | |
"consignment": { | |
"uuid": "047cfa4d-fd8b-47ba-b8e9-87067294d2fa", | |
"entityType": "consignment", | |
"associationType": "reference" | |
}, | |
"startTime": "2021-06-23T14:00:00Z", | |
"endTime": "2021-06-23T14:15:00Z", | |
"constraint": { | |
"entity": { | |
"id": "89a7bb4d-8720-4db9-aef7-4c3309186c3e", | |
"name": "Example combined constraint", | |
"value": { | |
"and": [ | |
{ | |
"startTime": "2021-06-23T10:00:00Z", | |
"endTime": "2021-06-23T13:00:00Z", | |
"description": "alert-threshold", | |
"type": "timeWindowConstraint" | |
}, | |
{ | |
"constraintType": "maximum", | |
"maximum": { | |
"value": 5, | |
"unit": "C" | |
}, | |
"type": "temperatureConstraint" | |
}, | |
{ | |
"or": [ | |
{ | |
"fuelTypes": [ | |
"battery" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"fuelTypes": [ | |
"biodiesel" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"minimum": "euro5", | |
"type": "emissionStandardConstraint" | |
} | |
], | |
"type": "orConstraint" | |
} | |
], | |
"type": "andConstraint" | |
} | |
}, | |
"associationType": "inline" | |
}, | |
"actionType": "load" | |
}, | |
"description": "string" | |
} | |
], | |
"constraint": { | |
"associationType": "inline", | |
"entity": { | |
"id": "89a7bb4d-8720-4db9-aef7-4c3309186c3e", | |
"name": "Example combined constraint", | |
"value": { | |
"and": [ | |
{ | |
"startTime": "2021-06-23T10:00:00Z", | |
"endTime": "2021-06-23T13:00:00Z", | |
"description": "alert-threshold", | |
"type": "timeWindowConstraint" | |
}, | |
{ | |
"constraintType": "maximum", | |
"maximum": { | |
"value": 5, | |
"unit": "C" | |
}, | |
"type": "temperatureConstraint" | |
}, | |
{ | |
"or": [ | |
{ | |
"fuelTypes": [ | |
"battery" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"fuelTypes": [ | |
"biodiesel" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"minimum": "euro5", | |
"type": "emissionStandardConstraint" | |
} | |
], | |
"type": "orConstraint" | |
} | |
], | |
"type": "andConstraint" | |
} | |
}, | |
"description": "string" | |
}, | |
"relatedConsignments": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "string", | |
"name": "string", | |
"creationDate": "string", | |
"lastModified": "string", | |
"externalAttributes": { | |
"property1": {}, | |
"property2": {} | |
}, | |
"description": "string", | |
"status": "draft", | |
"type": "string", | |
"goods": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "903807df-ee62-47aa-bf8e-7efd747618ce", | |
"description": "Box of bananas", | |
"remark": "Please deliver in time, we want fresh bananas", | |
"barCode": "CSE370", | |
"productType": "Fruit", | |
"packagingMaterial": "Box", | |
"constraint": { | |
"entity": { | |
"value": { | |
"and": [ | |
{ | |
"startTime": "2021-06-23T10:00:00Z", | |
"endTime": "2021-06-23T13:00:00Z", | |
"description": "alert-threshold", | |
"type": "timeWindowConstraint" | |
}, | |
{ | |
"constraintType": "maximum", | |
"maximum": { | |
"value": 5, | |
"unit": "C" | |
}, | |
"type": "temperatureConstraint" | |
}, | |
{ | |
"or": [ | |
{ | |
"fuelTypes": [ | |
"battery" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"fuelTypes": [ | |
"biodiesel" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"minimum": "euro5", | |
"type": "emissionStandardConstraint" | |
} | |
], | |
"type": "orConstraint" | |
} | |
], | |
"type": "andConstraint" | |
} | |
}, | |
"associationType": "inline" | |
}, | |
"type": "items" | |
}, | |
"description": "string" | |
} | |
], | |
"transportOrder": { | |
"associationType": "inline", | |
"entity": { | |
"id": "baa507c2-1d81-4092-a5c2-e80820ee4fd1", | |
"externalAttributes": { | |
"id": "OrderId" | |
}, | |
"description": "Transport order containing all consignments to be shipped.", | |
"consignments": [ | |
{ | |
"entity": { | |
"id": "e75a541b-e9d9-49e7-8bba-95492d682a6c", | |
"description": "Package for miss X." | |
}, | |
"associationType": "inline" | |
}, | |
{ | |
"entity": { | |
"id": "4a08bd61-720e-4a8c-81cf-028f1271c4da", | |
"description": "Package for mr Y." | |
}, | |
"associationType": "inline" | |
} | |
] | |
}, | |
"description": "string" | |
}, | |
"documents": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "cf32da57-5edc-4c46-9a97-58c97ae27cf8", | |
"name": "Photo of the PoD", | |
"content": { | |
"uri": "https://link-to-the-actual-document.org/1234", | |
"contentType": "link" | |
}, | |
"externalAttributes": { | |
"externalID": "photo1234" | |
}, | |
"documentType": "photo", | |
"filename": "my_photo.JPG", | |
"mimeType": "image/jpeg", | |
"description": "Proof that the goods are delivered by providing the photo that captures the moment", | |
"creator": { | |
"uuid": "655a2a4e-79b1-4637-9f13-b904730022ef", | |
"entityType": "actor", | |
"associationType": "reference" | |
}, | |
"owner": { | |
"uuid": "655a2a4e-79b1-4637-9f13-b904730022ef", | |
"entityType": "actor", | |
"associationType": "reference" | |
} | |
}, | |
"description": "string" | |
} | |
], | |
"remark": "string", | |
"actors": [ | |
{ | |
"associationType": "inline", | |
"entity": { | |
"id": "45db6ed0-28a7-4e4a-baba-3d5f8d171103", | |
"name": "Logistics manager", | |
"contactDetails": [ | |
{ | |
"value": "Simon Isaac", | |
"remark": "Wants to be called 'Sim'.", | |
"type": "firstName" | |
}, | |
{ | |
"value": "Macan", | |
"type": "lastName" | |
}, | |
{ | |
"value": "+312012345678", | |
"remark": "private cellphone of the CEO", | |
"language": "nld", | |
"type": "phone" | |
}, | |
{ | |
"value": "simon@macan", | |
"type": "email" | |
}, | |
{ | |
"value": "NL74BANK5890469479", | |
"type": "iban" | |
}, | |
{ | |
"value": "NL000099998B57", | |
"type": "vatCode" | |
} | |
] | |
}, | |
"description": "string", | |
"roles": [ | |
"shipper" | |
] | |
} | |
], | |
"constraint": { | |
"associationType": "inline", | |
"entity": { | |
"id": "89a7bb4d-8720-4db9-aef7-4c3309186c3e", | |
"name": "Example combined constraint", | |
"value": { | |
"and": [ | |
{ | |
"startTime": "2021-06-23T10:00:00Z", | |
"endTime": "2021-06-23T13:00:00Z", | |
"description": "alert-threshold", | |
"type": "timeWindowConstraint" | |
}, | |
{ | |
"constraintType": "maximum", | |
"maximum": { | |
"value": 5, | |
"unit": "C" | |
}, | |
"type": "temperatureConstraint" | |
}, | |
{ | |
"or": [ | |
{ | |
"fuelTypes": [ | |
"battery" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"fuelTypes": [ | |
"biodiesel" | |
], | |
"type": "fuelTypeConstraint" | |
}, | |
{ | |
"minimum": "euro5", | |
"type": "emissionStandardConstraint" | |
} | |
], | |
"type": "orConstraint" | |
} | |
], | |
"type": "andConstraint" | |
} | |
}, | |
"description": "string" | |
}, | |
"relatedConsignments": [ | |
{} | |
] | |
}, | |
"description": "string", | |
"relation": "split" | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment