POST api/Ship/Piece/GetList

Request Information

URI Parameters

None.

Body Parameters

ShipmentPieceParm

Name	Description	Type	Additional information
UserGUID	Unique user GUID assigned for security purposes	string	Required Max length: 36
ShipmentGUID	Unique user GUID assigned for security purposes	string	Required Max length: 36

Name

Description

Type

Additional information

UserGUID

Unique user GUID assigned for security purposes

string

Required

Max length: 36

ShipmentGUID

Unique user GUID assigned for security purposes

string

Required

Max length: 36

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ShipmentGUID": "sample string 2"
}

application/xml, text/xml

Sample:

<ShipmentPieceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <UserGUID>sample string 1</UserGUID>
</ShipmentPieceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentPieceResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Pieces	Listing of pieces on shipment	Collection of ShipmentPieceItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Pieces": null
}

application/xml, text/xml

Sample:

<ShipmentPieceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Pieces i:nil="true" />
</ShipmentPieceResp>