POST api/v1/lpa/documents/hierarchy/fetch

Request Information

URI Parameters

None.

Body Parameters

FetchDocHierarchyRequest
NameDescriptionTypeAdditional information
docId

string

None.

docType

string

None.

responseType

string

None.

Request Formats

application/json, text/json

Sample:
{
  "docId": "sample string 1",
  "docType": "sample string 2",
  "responseType": "sample string 3"
}

application/xml, text/xml

Sample:
<FetchDocHierarchyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <docId>sample string 1</docId>
  <docType>sample string 2</docType>
  <responseType>sample string 3</responseType>
</FetchDocHierarchyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LogisticsDocumentFetchMDL
NameDescriptionTypeAdditional information
response

integer

None.

message

string

None.

flatResponse

Object

None.

treeResponse

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "response": 1,
  "message": "sample string 2",
  "flatResponse": {},
  "treeResponse": {}
}

application/xml, text/xml

Sample:
<LogisticsDocumentFetchMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <flatResponse />
  <message>sample string 2</message>
  <response>1</response>
  <treeResponse />
</LogisticsDocumentFetchMDL>