AbodeONE

<back to all web services

CreateGuestChaperone

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/chaperone
CreateGuestChaperone Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdbodyintNo
PasswordbodystringNo
FirstNamebodystringNo
LastNamebodystringNo
GenderbodystringNo
PhonebodystringNo
EmailbodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StatebodystringNo
PostalbodystringNo
CountrybodystringNo
ExpectedArrivalDtbodyDateTime?No
ExpectedDepartureDtbodyDateTime?No
AmtPaidbodydecimal?No
TshirtSizebodystringNo
SchoolOrgbodystringNo
HotelNamebodystringNo
HotelPhonebodystringNo
CodebodystringNo
NeedsTransportbodyboolNo
TransportDestbodystringNo
TransportDetailsbodystringNo
HeadChaperoneIdbodyint?No
GroupStatusbodyChaperoneGroupStatusEnum?No
InvitedDtbodyDateTime?No
ChaperoneGroupStatusEnum Enum:
Head
Invited
Member
Requested
None
GuestChaperoneResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestChaperoneDTONo
ResponseStatusformResponseStatusNo
GuestChaperoneDTO Parameters:
NameParameterData TypeRequiredDescription
ChaperoneIdformintNo
GuestEventIdformintNo
FirstNameformstringNo
LastNameformstringNo
UsernameformstringNo
GenderformstringNo
PhoneformstringNo
EmailformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
ExpectedArrivalDtformDateTime?No
ExpectedDepartureDtformDateTime?No
AmtPaidformdecimal?No
AppliedAmountformdecimal?No
AppliedByformstringNo
TshirtSizeformstringNo
SchoolOrgformstringNo
HotelNameformstringNo
HotelPhoneformstringNo
CodeformstringNo
InviteCodeformstringNo
TotalPaidAmountformdecimalNo
AvailableAmountformdecimalNo
NeedsTransportformboolNo
TransportDestformstringNo
TransportDetailsformstringNo
HeadChaperoneIdformint?No
IsPaidformboolNo
InvitedDtformDateTime?No
LastLoginDtformDateTime?No
GroupStatusformstringNo
FullNameformstringNo
HeadChaperoneFullNameformstringNo
GuestEventNameformstringNo
PasswordResetLinkformstringNo
EventStartDtformDateTime?No
EventEndDtformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //chaperone HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	guestEventId: 0,
	password: String,
	firstName: String,
	lastName: String,
	gender: String,
	phone: String,
	email: String,
	address1: String,
	address2: String,
	city: String,
	state: String,
	postal: String,
	country: String,
	expectedArrivalDt: 0001-01-01,
	expectedDepartureDt: 0001-01-01,
	amtPaid: 0,
	tshirtSize: String,
	schoolOrg: String,
	hotelName: String,
	hotelPhone: String,
	code: String,
	needsTransport: False,
	transportDest: String,
	transportDetails: String,
	headChaperoneId: 0,
	groupStatus: Head,
	invitedDt: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		chaperoneId: 0,
		guestEventId: 0,
		firstName: String,
		lastName: String,
		username: String,
		gender: String,
		phone: String,
		email: String,
		address1: String,
		address2: String,
		city: String,
		state: String,
		postal: String,
		country: String,
		expectedArrivalDt: 0001-01-01,
		expectedDepartureDt: 0001-01-01,
		amtPaid: 0,
		appliedAmount: 0,
		appliedBy: String,
		tshirtSize: String,
		schoolOrg: String,
		hotelName: String,
		hotelPhone: String,
		code: String,
		inviteCode: String,
		totalPaidAmount: 0,
		availableAmount: 0,
		needsTransport: False,
		transportDest: String,
		transportDetails: String,
		headChaperoneId: 0,
		isPaid: False,
		invitedDt: 0001-01-01,
		lastLoginDt: 0001-01-01,
		groupStatus: String,
		fullName: String,
		headChaperoneFullName: String,
		guestEventName: String,
		passwordResetLink: String,
		eventStartDt: 0001-01-01,
		eventEndDt: 0001-01-01
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}