POST api/submissions

Request Information

URI Parameters

None.

Body Parameters

SubmissionEntry
NameDescriptionTypeAdditional information
ReceiptOfferId

integer

None.

OfferId

integer

None.

ClientId

integer

None.

Is2Step

boolean

None.

EntryOrigin

string

None.

FirstName

string

Max length: 25

LastName

string

Max length: 25

Company

string

Max length: 50

Address1

string

Max length: 50

Address2

string

Max length: 50

City

string

Max length: 30

State

string

Max length: 2

Country

string

Max length: 2

PostalCode

string

Max length: 10

Telephone1

string

Max length: 20

Email1

string

Max length: 255

BirthDate

date

None.

IPAddress

string

Max length: 15

Browser

string

Max length: 75

ItemCode

string

None.

OptIn1

string

None.

minAge

integer

None.

ExternalId

string

None.

AdditionalProperties

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "ReceiptOfferId": 1,
  "OfferId": 2,
  "ClientId": 3,
  "Is2Step": true,
  "EntryOrigin": "sample string 5",
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "Company": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "City": "sample string 11",
  "State": "sample string 12",
  "Country": "sample string 13",
  "PostalCode": "sample string 14",
  "Telephone1": "sample string 15",
  "Email1": "sample string 16",
  "BirthDate": "2019-11-19T21:55:34.3955976-06:00",
  "IPAddress": "sample string 18",
  "Browser": "sample string 19",
  "ItemCode": "sample string 20",
  "OptIn1": "sample string 21",
  "minAge": 22,
  "ExternalId": "sample string 23",
  "AdditionalProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<SubmissionEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YA.Common.SweepStakes.API.Models">
  <AdditionalProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </AdditionalProperties>
  <Address1>sample string 9</Address1>
  <Address2>sample string 10</Address2>
  <BirthDate>2019-11-19T21:55:34.3955976-06:00</BirthDate>
  <Browser>sample string 19</Browser>
  <City>sample string 11</City>
  <ClientId>3</ClientId>
  <Company>sample string 8</Company>
  <Country>sample string 13</Country>
  <Email1>sample string 16</Email1>
  <EntryOrigin>sample string 5</EntryOrigin>
  <ExternalId>sample string 23</ExternalId>
  <FirstName>sample string 6</FirstName>
  <IPAddress>sample string 18</IPAddress>
  <Is2Step>true</Is2Step>
  <ItemCode>sample string 20</ItemCode>
  <LastName>sample string 7</LastName>
  <OfferId>2</OfferId>
  <OptIn1>sample string 21</OptIn1>
  <PostalCode>sample string 14</PostalCode>
  <ReceiptOfferId>1</ReceiptOfferId>
  <State>sample string 12</State>
  <Telephone1>sample string 15</Telephone1>
  <minAge>22</minAge>
</SubmissionEntry>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RebateResult
NameDescriptionTypeAdditional information
Status

InsertResponse

None.

ConsumerGuid

string

None.

ReturnInfo

string

None.

Success

boolean

None.

Message

string

None.

ISubmitID

integer

None.

TrackingID

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "ConsumerGuid": "sample string 1",
  "ReturnInfo": "sample string 2",
  "Success": true,
  "Message": "sample string 4",
  "ISubmitID": 5,
  "TrackingID": "sample string 6"
}

application/xml, text/xml

Sample:
<RebateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YA.Common.PromoAdmin.Client.Models">
  <ISubmitID xmlns="http://schemas.datacontract.org/2004/07/YA.Common.PromoAdmin.Client.Models.Helios">5</ISubmitID>
  <Message xmlns="http://schemas.datacontract.org/2004/07/YA.Common.PromoAdmin.Client.Models.Helios">sample string 4</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/YA.Common.PromoAdmin.Client.Models.Helios">true</Success>
  <TrackingID xmlns="http://schemas.datacontract.org/2004/07/YA.Common.PromoAdmin.Client.Models.Helios">sample string 6</TrackingID>
  <ConsumerGuid>sample string 1</ConsumerGuid>
  <ReturnInfo>sample string 2</ReturnInfo>
  <Status>NonWinner</Status>
</RebateResult>