POST api/OmsSalesRecap

Request Information

URI Parameters

None.

Body Parameters

SalesRecapRequest

NameDescriptionTypeAdditional information
SiteCode

string

None.

VerificationKey

string

None.

TimestampUTC

string

None.

StartDateUTC

string

None.

EndDateUTC

string

None.

Recipients

string

None.

FromEmail

string

None.

APIUsername

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "StartDateUTC": "sample string 4",
  "EndDateUTC": "sample string 5",
  "Recipients": "sample string 6",
  "FromEmail": "sample string 7",
  "APIUsername": "sample string 8"
}

application/xml, text/xml

Sample:
<SalesRecapRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
  <APIUsername>sample string 8</APIUsername>
  <EndDateUTC>sample string 5</EndDateUTC>
  <FromEmail>sample string 7</FromEmail>
  <Recipients>sample string 6</Recipients>
  <SiteCode>sample string 1</SiteCode>
  <StartDateUTC>sample string 4</StartDateUTC>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</SalesRecapRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional information
ResponseCode

APIResponseCodes

None.

Message

string

None.

Response Formats

application/json, text/json

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

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">
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>