POST api/v2/sweepstakes/entry

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientID	string	Required
OfferID	string	Required
Vendor	string	None.
SecurityToken	string	None.
ConsumerInfo	SweepStakeEntry	None.
EntryInfo	DailyEntry	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": "sample string 1",
  "OfferID": "sample string 2",
  "Vendor": "sample string 3",
  "SecurityToken": "sample string 4",
  "ConsumerInfo": {
    "SweepstakesCode": "sample string 1",
    "ExternalID": "sample string 2",
    "Email": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "PostalCode": "sample string 10",
    "County": "sample string 11",
    "Country": "sample string 12",
    "Phone": "sample string 13",
    "AltPhone": "sample string 14",
    "BirthDate": "2021-09-22T23:51:17.8806599-05:00",
    "OptIn1": true,
    "OptIn2": true,
    "OptIn3": true,
    "Company": "sample string 16",
    "StoreName": "sample string 17",
    "TagInfo": "sample string 18",
    "TrxNumber": "sample string 19",
    "UserDefined1": "sample string 20",
    "UserDefined2": "sample string 21",
    "UserDefined3": "sample string 22",
    "EntryUserDefined1": "sample string 23",
    "EntryUserDefined3": "sample string 24",
    "EntryAdditionalData": "sample string 25",
    "IpAddress": "sample string 26",
    "Browser": "sample string 27",
    "Captcha": "sample string 28",
    "token": "sample string 29",
    "tokenseed": "sample string 30",
    "EntryOrigin": "sample string 31",
    "EntryMethodID": "sample string 32",
    "CaptchaType": "sample string 33",
    "EntryType": "sample string 34",
    "ItemCode": "sample string 35"
  },
  "EntryInfo": {
    "EntryType": "sample string 1",
    "UserDefined3": "sample string 2",
    "EntryDate": "2021-09-22T23:51:17.8806599-05:00"
  }
}

application/xml, text/xml

Sample:

<SubmissionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YA.Common.SweepStakes.API.Models">
  <ClientID>sample string 1</ClientID>
  <ConsumerInfo>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <AltPhone>sample string 14</AltPhone>
    <BirthDate>2021-09-22T23:51:17.8806599-05:00</BirthDate>
    <Browser>sample string 27</Browser>
    <Captcha>sample string 28</Captcha>
    <CaptchaType>sample string 33</CaptchaType>
    <City>sample string 8</City>
    <Company>sample string 16</Company>
    <Country>sample string 12</Country>
    <County>sample string 11</County>
    <Email>sample string 3</Email>
    <EntryAdditionalData>sample string 25</EntryAdditionalData>
    <EntryMethodID>sample string 32</EntryMethodID>
    <EntryOrigin>sample string 31</EntryOrigin>
    <EntryType>sample string 34</EntryType>
    <EntryUserDefined1>sample string 23</EntryUserDefined1>
    <EntryUserDefined3>sample string 24</EntryUserDefined3>
    <ExternalID>sample string 2</ExternalID>
    <FirstName>sample string 4</FirstName>
    <IpAddress>sample string 26</IpAddress>
    <ItemCode>sample string 35</ItemCode>
    <LastName>sample string 5</LastName>
    <OptIn1>true</OptIn1>
    <OptIn2>true</OptIn2>
    <OptIn3>true</OptIn3>
    <Phone>sample string 13</Phone>
    <PostalCode>sample string 10</PostalCode>
    <State>sample string 9</State>
    <StoreName>sample string 17</StoreName>
    <SweepstakesCode>sample string 1</SweepstakesCode>
    <TagInfo>sample string 18</TagInfo>
    <TrxNumber>sample string 19</TrxNumber>
    <UserDefined1>sample string 20</UserDefined1>
    <UserDefined2>sample string 21</UserDefined2>
    <UserDefined3>sample string 22</UserDefined3>
    <token>sample string 29</token>
    <tokenseed>sample string 30</tokenseed>
  </ConsumerInfo>
  <EntryInfo>
    <EntryDate>2021-09-22T23:51:17.8806599-05:00</EntryDate>
    <EntryType>sample string 1</EntryType>
    <UserDefined3>sample string 2</UserDefined3>
  </EntryInfo>
  <OfferID>sample string 2</OfferID>
  <SecurityToken>sample string 4</SecurityToken>
  <Vendor>sample string 3</Vendor>
</SubmissionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SubmissionResponse

Name	Type	Additional information
Status	string	None.
ErrorCode	string	None.
ErrorMessage	string	None.
ConsumerGuid	string	None.
IsWinner	boolean	None.
WinnerCode	string	None.
WinnerDescription	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "ConsumerGuid": "sample string 4",
  "IsWinner": true,
  "WinnerCode": "sample string 6",
  "WinnerDescription": "sample string 7"
}

application/xml, text/xml

Sample:

<SubmissionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YA.Common.SweepStakes.API.Models">
  <ConsumerGuid>sample string 4</ConsumerGuid>
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <IsWinner>true</IsWinner>
  <Status>sample string 1</Status>
  <WinnerCode>sample string 6</WinnerCode>
  <WinnerDescription>sample string 7</WinnerDescription>
</SubmissionResponse>