PUT v1/event/{eventId}/register

Registers a single guest for the given EventId.

Request Information

URI Parameters

Name	Description	Type	Additional information
eventId	The unique identifier of an event.	integer	Required

Body Parameters

Encapsulates a guest object with applicable values. See definition.

ViewerGuest

Name	Description	Type	Additional information
Email	The email address of the guest.	string	None.
FirstName	The first name of the guest.	string	None.
LastName	The last name of the guest.	string	None.
Company	Optional company to which the guest belongs.	string	None.
Address1	Optional street mailing address of the guest.	string	None.
City	Optional city of the guest.	string	None.
State	Optional state of the guest.	string	None.
Zip	Optional zip code of the guest.	string	None.
RsvpStatus	The guest's RSVP. True if they're attending; false if they're not.	boolean	None.
TicketId	The ID of the ticket the guest will be purchasing for this event.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Company": "sample string 4",
  "Address1": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zip": "sample string 8",
  "RsvpStatus": true,
  "TicketId": 10
}

application/xml, text/xml

Sample:

<ViewerGuest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_client.Models">
  <Address1>sample string 5</Address1>
  <City>sample string 6</City>
  <Company>sample string 4</Company>
  <Email>sample string 1</Email>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <RsvpStatus>true</RsvpStatus>
  <State>sample string 7</State>
  <TicketId>10</TicketId>
  <Zip>sample string 8</Zip>
</ViewerGuest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ViewerGuest'.

Response Information

Resource Description

A boolean indicating whether the call succeeded in registering the guest. If it succeeded, the "Message" value will be the url to the guest's RSVP confirmation page. If it did not succeed, there will either be an error message in the "Message" node, or the "Errors" node will contain 1 or more error messages.

ValidationReturn

Name	Type	Additional information
Errors	Collection of ValidationProperty	None.
ErrorSummary	string	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Errors": null,
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ValidationReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Greenvelope.Logic.JSON.Validation">
  <Message xmlns="http://schemas.datacontract.org/2004/07/Greenvelope.Shared">sample string 2</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Greenvelope.Shared">true</Success>
  <Errors i:nil="true" />
</ValidationReturn>