POST api/v1/TSC/{AgentID}
Create Subscription with WIN Services
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
AgentID |
Define this parameter in the request URI. |
|
payload |
Define this parameter in the request body. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "BookingNumber": "sample string 1", "ShipmentID": "sample string 2", "ShipmentShipUnits": [ { "UnitID": "sample string 1" }, { "UnitID": "sample string 1" }, { "UnitID": "sample string 1" } ] }
application/xml, text/xml
Sample:
<TSCSubscriptionDTO> <BookingNumber>sample string 1</BookingNumber> <ShipmentID>sample string 2</ShipmentID> <ShipmentShipUnits> <ShipmentShipUnitIdDTO> <UnitID>sample string 1</UnitID> </ShipmentShipUnitIdDTO> <ShipmentShipUnitIdDTO> <UnitID>sample string 1</UnitID> </ShipmentShipUnitIdDTO> <ShipmentShipUnitIdDTO> <UnitID>sample string 1</UnitID> </ShipmentShipUnitIdDTO> </ShipmentShipUnits> </TSCSubscriptionDTO>
Response Information
Response body formats
application/json, text/json
Sample:
[ { "AgentID": 1, "JobMasterNo": "sample string 2", "JobHouseNo": "sample string 3", "ContainerNumber": "sample string 4", "BookingNumber": "sample string 5", "ShipmentID": "sample string 6", "ShipmentShipUnitID": "sample string 7" }, { "AgentID": 1, "JobMasterNo": "sample string 2", "JobHouseNo": "sample string 3", "ContainerNumber": "sample string 4", "BookingNumber": "sample string 5", "ShipmentID": "sample string 6", "ShipmentShipUnitID": "sample string 7" }, { "AgentID": 1, "JobMasterNo": "sample string 2", "JobHouseNo": "sample string 3", "ContainerNumber": "sample string 4", "BookingNumber": "sample string 5", "ShipmentID": "sample string 6", "ShipmentShipUnitID": "sample string 7" } ]
application/xml, text/xml
Sample:
<ArrayOfSubscriptionResultDTO> <SubscriptionResultDTO> <AgentID>1</AgentID> <JobMasterNo>sample string 2</JobMasterNo> <JobHouseNo>sample string 3</JobHouseNo> <ContainerNumber>sample string 4</ContainerNumber> <BookingNumber>sample string 5</BookingNumber> <ShipmentID>sample string 6</ShipmentID> <ShipmentShipUnitID>sample string 7</ShipmentShipUnitID> </SubscriptionResultDTO> <SubscriptionResultDTO> <AgentID>1</AgentID> <JobMasterNo>sample string 2</JobMasterNo> <JobHouseNo>sample string 3</JobHouseNo> <ContainerNumber>sample string 4</ContainerNumber> <BookingNumber>sample string 5</BookingNumber> <ShipmentID>sample string 6</ShipmentID> <ShipmentShipUnitID>sample string 7</ShipmentShipUnitID> </SubscriptionResultDTO> <SubscriptionResultDTO> <AgentID>1</AgentID> <JobMasterNo>sample string 2</JobMasterNo> <JobHouseNo>sample string 3</JobHouseNo> <ContainerNumber>sample string 4</ContainerNumber> <BookingNumber>sample string 5</BookingNumber> <ShipmentID>sample string 6</ShipmentID> <ShipmentShipUnitID>sample string 7</ShipmentShipUnitID> </SubscriptionResultDTO> </ArrayOfSubscriptionResultDTO>