POST api/v1/lpa/documents/tagvehicle

Request Information

URI Parameters

None.

Body Parameters

Collection of DocHeaderMDL
NameDescriptionTypeAdditional information
DocType

string

None.

DocNumber

string

None.

CreatedDate

date

None.

ReferenceID

string

None.

ReferenceName

string

None.

VehicleNumber

string

None.

DriverName

string

None.

TransporterName

string

None.

SourceName

string

None.

DestinationName

string

None.

ewayBillNumber

string

None.

ewayBillDate

string

None.

expectedArrival

string

None.

remarks

string

None.

DocItems

Collection of DocItem

None.

CustomFields

Dictionary of string [key] and Object [value]

None.

AdditionalInfo

Dictionary of string [key] and Object [value]

None.

Children

Collection of DocChild

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 '[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 '[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 'FTSMDLClassLibrary.WebAPIMDL.LPA.DocChild' 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.DocChild' 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>