POST api/{module}/Expedition

Request Information

URI Parameters

NameDescriptionTypeAdditional information
module

string

None.

Body Parameters

ExpeditionDocument
NameDescriptionTypeAdditional information
ProcessName

string

None.

Document

BaseDocument

None.

DocumentType

Type

None.

Volume

string

None.

Id

string

None.

UserTableFields

Collection of Object

None.

Request Formats

application/json, text/json

Sample:
{
  "processName": "sample string 1",
  "document": {
    "document": 1,
    "series": "sample string 2",
    "notes": "sample string 3",
    "id": "sample string 5",
    "userTableFields": null
  },
  "documentType": null,
  "volume": "sample string 2",
  "id": "sample string 4",
  "userTableFields": null
}

application/xml, text/xml

Sample:
<ExpeditionDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Extra.Collectors.Expedition">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 4</Id>
  <UserTableFields i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common" />
  <Document xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Admin">
    <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 5</Id>
    <UserTableFields i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common" />
    <d2p1:Document>1</d2p1:Document>
    <d2p1:Notes>sample string 3</d2p1:Notes>
    <d2p1:Series>sample string 2</d2p1:Series>
  </Document>
  <ProcessName>sample string 1</ProcessName>
  <Volume>sample string 2</Volume>
</ExpeditionDocument>

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 'ExpeditionDocument'.

Response Information

Resource Description

ProcessDone
NameDescriptionTypeAdditional information
DoneOK

boolean

None.

Finished

boolean

None.

Message

string

None.

Id

string

None.

Response Formats

application/json, text/json

Sample:
{
  "doneOK": true,
  "finished": true,
  "message": "sample string 3",
  "id": "sample string 4"
}

application/xml, text/xml

Sample:
<ProcessDone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">
  <DoneOK>true</DoneOK>
  <Finished>true</Finished>
  <Id>sample string 4</Id>
  <Message>sample string 3</Message>
</ProcessDone>