Web Hook Message Models
There are two possible messages that will be sent to your web endpoints as web hooks. They are "GmrCancelTransport" and "GmrEditTransport". The models for these messages are as follows:
GmrCancelTransport:
This model will be used when GMR needs to notify your organization that a transport has been cancelled. It will contain the reason for the cancellation as well as the time the cancellation occurred.
TransportRequestId:
Required string property contains the original RequestId identifier for the transport assigned by GMR.
ProviderId:
Required string property contains the Short Name for your organization you provided when you registered for the Provider Service.
CancelReason:
Required integer property contains code representing reason for the cancellation,
CancelTime:
Required DateTime property contains the time the cancellation occurred.
GmrEditTransport:
There is no fixed model for editing information for a transport. Instead, a JSON string will be sent which is intended to be merged with the JSON representing the transport as it was originally sent to your organization. The JSON string will include identifiers for the transport and its legs (if any are changed) in addition to the properties that have been changed. So, at a minimum, the JSON string will always include the “RequestId” property for the parent transport request object as well as any changed properties.
Additionally, if a leg of the transport is changed, the “TripLegs” array property of the transport request will be present and will include an element for each leg regardless of whether the leg is changed or not. If the leg is not changed, it will only include the “TransportLegId” property for the leg. If there are changes to the leg, the changed properties for the leg will also be included.