POST api/GetCloseManifests_V1
Get Close Manifests Function based on a manifest id returned by Close_V1 call
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Close.GetCloseManifestsRequestName | Description | Type | Additional information |
---|---|---|---|
WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
ManifestId |
(Mandatory) ManifestId - Returned by the Close call |
integer |
None. |
ManifestPrintPreferences |
(Optional) manifest printing preferences (Default is PDF) |
WS_Repository.Models.Requests.Close.ManifestPrintPreferencesType |
None. |
Request Formats
application/json, text/json
Sample:
{ "WS_Key": "sample string 1", "ManifestId": 2, "ManifestPrintPreferences": { "Encoding": 0, "RetrieveBase64StringDocuments": true } }
application/xml, text/xml
Sample:
<GetCloseManifestsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Close"> <ManifestId>2</ManifestId> <ManifestPrintPreferences> <Encoding>PDF</Encoding> <RetrieveBase64StringDocuments>true</RetrieveBase64StringDocuments> </ManifestPrintPreferences> <WS_Key>sample string 1</WS_Key> </GetCloseManifestsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
WS_Repository.Models.Responses.Close.GetCloseManifestsResponseName | Description | Type | Additional information |
---|---|---|---|
ManifestStatus |
ManifestId - used later for Run GetCloseManifests |
WS_Repository.Models.Responses.Close.ManifestStatusType |
None. |
CloseManifestDocuments |
Array of Close Documents - is available just if ManifestStatus = Success |
Collection of WS_Repository.Models.Responses.Close.CloseManifestDocument |
None. |
Message |
Message - clase message |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ManifestStatus": 0, "CloseManifestDocuments": [ { "Type": 0, "Href": "sample string 1", "DocumentBase64String": "sample string 2", "Encoding": 0, "DocumentName": "sample string 3" }, { "Type": 0, "Href": "sample string 1", "DocumentBase64String": "sample string 2", "Encoding": 0, "DocumentName": "sample string 3" } ], "Message": "sample string 1" }
application/xml, text/xml
Sample:
<GetCloseManifestsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Close"> <CloseManifestDocuments> <CloseManifestDocument> <DocumentBase64String>sample string 2</DocumentBase64String> <DocumentName>sample string 3</DocumentName> <Encoding>PDF</Encoding> <Href>sample string 1</Href> <Type>CarrierManifest</Type> </CloseManifestDocument> <CloseManifestDocument> <DocumentBase64String>sample string 2</DocumentBase64String> <DocumentName>sample string 3</DocumentName> <Encoding>PDF</Encoding> <Href>sample string 1</Href> <Type>CarrierManifest</Type> </CloseManifestDocument> </CloseManifestDocuments> <ManifestStatus>Running</ManifestStatus> <Message>sample string 1</Message> </GetCloseManifestsResponse>