POST api/{module}/Separation

Request Information

URI Parameters

Name	Description	Type	Additional information
module		string	None.

Body Parameters

SeparationDocument

Name	Type	Additional information
ProcessName	string	None.
Document	BaseDocument	None.
DocumentType	Type	None.
ProductCode	string	None.
Quantity	decimal number	None.
Local	string	None.
Id	string	None.
UserTableFields	Collection of Object	None.
CreationUser	string	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,
    "creationUser": "sample string 6"
  },
  "documentType": null,
  "productCode": "sample string 2",
  "quantity": 3.1,
  "local": "sample string 4",
  "id": "sample string 6",
  "userTableFields": null,
  "creationUser": "sample string 7"
}

application/xml, text/xml

Sample:

<SeparationDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Extra.Collectors.Separation">
  <CreationUser xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 7</CreationUser>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 6</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">
    <CreationUser xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 6</CreationUser>
    <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>
  <Local>sample string 4</Local>
  <ProcessName>sample string 1</ProcessName>
  <ProductCode>sample string 2</ProductCode>
  <Quantity>3.1</Quantity>
</SeparationDocument>

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

Response Information

Resource Description

ProcessDone

Name	Type	Additional 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>