POST api/v1/lpa/documents/push

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
REQUEST		Collection of DocHeaderMDL	None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'FTSMDLClassLibrary.WebAPIMDL.LPA.DocChild'. Path 'REQUEST[0].Children[0].Children'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'FTSMDLClassLibrary.WebAPIMDL.LPA.DocChild'. Path 'REQUEST[0].Children[0].Children'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FTSMDLClassLibrary.WebAPIMDL.LPA.DocChild, FTSMDLClassLibrary, 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 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FTSMDLClassLibrary.WebAPIMDL.LPA.DocChild, FTSMDLClassLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LogisticsDocumentRequest'.

Response Information

Resource Description

LogisticsDocumentAPIResponseMDL

Name	Type	Additional information
TotalCount	integer	None.
SuccessCount	integer	None.
FailedCount	integer	None.
Data	Collection of LogisticsDocumentMDL	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "SuccessCount": 2,
  "FailedCount": 3,
  "Data": [
    {
      "DocNumber": "sample string 1",
      "response": 2,
      "message": "sample string 3"
    },
    {
      "DocNumber": "sample string 1",
      "response": 2,
      "message": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<LogisticsDocumentAPIResponseMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <Data>
    <LogisticsDocumentMDL>
      <DocNumber>sample string 1</DocNumber>
      <message>sample string 3</message>
      <response>2</response>
    </LogisticsDocumentMDL>
    <LogisticsDocumentMDL>
      <DocNumber>sample string 1</DocNumber>
      <message>sample string 3</message>
      <response>2</response>
    </LogisticsDocumentMDL>
  </Data>
  <FailedCount>3</FailedCount>
  <SuccessCount>2</SuccessCount>
  <TotalCount>1</TotalCount>
</LogisticsDocumentAPIResponseMDL>