POST api/GetChangesV1_1

Provides status change logs for the shipments.

Request Information

URI Parameters

None.

Body Parameters

Request that contains WS_Key, Start (Optional, must match with an exact Start date that was returned from any previous call.), End (Optional, must match with an exact Start date and End date that was returned from any previous call.), SetInitialTimeStamp (Optional, mark a new timestamp with the current date)

TwoShipAPI.Controllers.GetChangesRequest

Name	Type	Additional information
WS_Key	string	None.
Start	date	None.
End	date	None.
SetInitialTimeStamp	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "Start": "2024-04-19T04:08:01.2675168-04:00",
  "End": "2024-04-19T04:08:01.2675168-04:00",
  "SetInitialTimeStamp": true
}

application/xml, text/xml

Sample:

<GetChangesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TwoShipAPI.Controllers">
  <End>2024-04-19T04:08:01.2675168-04:00</End>
  <SetInitialTimeStamp>true</SetInitialTimeStamp>
  <Start>2024-04-19T04:08:01.2675168-04:00</Start>
  <WS_Key>sample string 1</WS_Key>
</GetChangesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoShipAPI.Controllers.GetChangesRequest'.

Response Information

Resource Description

The shipments that have changed status since the last call of this service or for the given timeframe. The timeframe for the returned shipments list is also returned.

WS_Repository.Models.Responses.Ship.GetChangesResponse

Name	Description	Type	Additional information
Shipments	Shipments that have changed in 2Ship in the returned timeframe	Collection of WS_Repository.Models.Responses.Ship.CarrierShipResponse	None.
Start	Start date and time for the returned change set	date	None.
End	End date and time for the returned change set	date	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path 'Shipments[0].ShipmentDetails.Contents.Commodities[0].BundleComponents'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path 'Shipments[0].ShipmentDetails.Contents.Commodities[0].BundleComponents'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.