POST api/v1/sweepstakes/entry

Use this call to submit an entry for a given program. Creates a record of the entry.

Request Information

URI Parameters

None.

Body Parameters

The Entry Request encapsulates the id of the program and additional user-identifying data. For testing in the stage environment, please use the programId = "1001CBA3-DC87-4ABA-948C-AC345D19A8B9".

Entry Request

Name	Description	Type	Additional information
programId	A GUID identifying the sweepstakes program. Provided by GMR.	globally unique identifier	Required
name	The full name of the sweepstakes registrant.	string	Max length: 200
emailAddress	The email address of the sweepstakes registrant.	string	Max length: 200
address	The address of the sweepstakes registrant.	Address	None.
phoneNumber	The phone number of the sweepstakes registrant.	string	Max length: 50
trackingId	An id the client can use for tracking requests.	string	Max length: 100

Request Formats

application/json, text/json

Sample:

{
  "programId": "c6c29f74-6398-4793-ba90-0bdc0a845ba0",
  "name": "sample string 4",
  "emailAddress": "sample string 7",
  "address": {
    "addressLine1": "sample string 1",
    "city": "sample string 2",
    "state": "sample string 3",
    "zip": "sample string 4"
  },
  "phoneNumber": "sample string 9",
  "trackingId": "sample string 11"
}

Response Information

Resource Description

A request successfully resulting in an entry will give a response of 200 OK and a value of true in the success property and a null message.
A (non-error) request that does not result in an entry will give a response of 200 OK and a value of false in the success property with an indication of the reason for failure given in the message.

Entry Response

Name	Description	Type	Additional information
success		boolean	None.
message		string	None.

Response Formats

application/json

Sample:

{"success":true,"message": null}

text/json

Sample:

{"success":false,"message":"Entries are not being accepted at this time."}