POST api/OmsEdi820

Request Information

URI Parameters

None.

Body Parameters

EdiRequestJson

NameDescriptionTypeAdditional Information
SiteCode

string

None.
VerificationKey

string

None.
TimestampUTC

string

None.
APIUsername

string

None.
StartDateUTC

date

None.
EndDateUTC

date

None.
TimeZone

string

None.
ForceRun

boolean

None.
PluginName

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4",
  "StartDateUTC": "2025-12-20T18:22:51.6399405+00:00",
  "EndDateUTC": "2025-12-20T18:22:51.6399405+00:00",
  "TimeZone": "sample string 7",
  "ForceRun": true,
  "PluginName": "sample string 9"
}

application/xml, text/xml

Sample: 
<EdiRequestJson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts">
  <APIUsername>sample string 4</APIUsername>
  <EndDateUTC>2025-12-20T18:22:51.6399405+00:00</EndDateUTC>
  <ForceRun>true</ForceRun>
  <PluginName>sample string 9</PluginName>
  <SiteCode>sample string 1</SiteCode>
  <StartDateUTC>2025-12-20T18:22:51.6399405+00:00</StartDateUTC>
  <TimeZone>sample string 7</TimeZone>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</EdiRequestJson>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.
Message

string

None.
CorrelationId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample: 
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>