POST api/v1/lpa/documents/hierarchy/create

Request Information

URI Parameters

None.

Body Parameters

Collection of LPADocHierarchyMDL
NameDescriptionTypeAdditional information
docId

string

None.
docType

string

None.
children

Collection of LPADocHierarchyMDL

None.
CustomFields

Dictionary of string [key] and Object [value]

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.LPADocHierarchyMDL'. Path '[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.LPADocHierarchyMDL'. Path '[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 'FTSMDLClassLibrary.WebAPIMDL.LPA.LPADocHierarchyMDL' 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 'FTSMDLClassLibrary.WebAPIMDL.LPA.LPADocHierarchyMDL' 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 'List`1'.

Response Information

Resource Description

LogisticsDocumentMDL
NameDescriptionTypeAdditional information
response

integer

None.
message

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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