AbodeONE

<back to all web services

UpdateGuest

Requires Authentication
Requires any of the roles:Admin, Guest, HeadChaperone
The following routes are available for this service:
PATCH/guest
UpdateGuest Parameters:
NameParameterData TypeRequiredDescription
GuestIdqueryintNo
StudentIdqueryint?No
ChaperoneIdqueryint?No
PasswordquerystringNo
FirstNamequerystringNo
LastNamequerystringNo
GuestTypequerystringNo
GenderquerystringNo
Address1querystringNo
Address2querystringNo
CityquerystringNo
StatequerystringNo
PostalquerystringNo
CountryquerystringNo
PhonequerystringNo
EmailquerystringNo
SchoolOrgquerystringNo
NotesquerystringNo
TshirtSizequerystringNo
SchoolidquerystringNo
GroupStatusqueryGroupStatusEnum?No
IsPaidquerybool?No
GroupStatusEnum Enum:
Invited
Member
Requested
None
GuestResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestDTONo
ResponseStatusformResponseStatusNo
GuestDTO Parameters:
NameParameterData TypeRequiredDescription
GuestIdformintNo
StudentIdformint?No
SchoolidformstringNo
ChaperoneIdformint?No
GuestEventIdformint?No
UsernameformstringNo
FirstNameformstringNo
LastNameformstringNo
GuestTypeformstringNo
GenderformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
PhoneformstringNo
EmailformstringNo
SchoolOrgformstringNo
CodeformstringNo
NotesformstringNo
GroupStatusformstringNo
PaidAmountformdecimalNo
IsPaidformboolNo
AppliedAmountformdecimal?No
AppliedByformdecimal?No
TshirtSizeformstringNo
InvitedDtformDateTime?No
LastLoginDtformDateTime?No
FullNameformstringNo
StudentFullNameformstringNo
ChaperoneFullNameformstringNo
ChaperonePhoneformstringNo
ChaperoneHotelformstringNo
ChaperoneHotelPhoneformstringNo
GuestEventNameformstringNo
PasswordResetLinkformstringNo

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.

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

{
	guestId: 0,
	studentId: 0,
	chaperoneId: 0,
	password: String,
	firstName: String,
	lastName: String,
	guestType: String,
	gender: String,
	address1: String,
	address2: String,
	city: String,
	state: String,
	postal: String,
	country: String,
	phone: String,
	email: String,
	schoolOrg: String,
	notes: String,
	tshirtSize: String,
	schoolid: String,
	groupStatus: Invited,
	isPaid: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		guestId: 0,
		studentId: 0,
		schoolid: String,
		chaperoneId: 0,
		guestEventId: 0,
		username: String,
		firstName: String,
		lastName: String,
		guestType: String,
		gender: String,
		address1: String,
		address2: String,
		city: String,
		state: String,
		postal: String,
		country: String,
		phone: String,
		email: String,
		schoolOrg: String,
		code: String,
		notes: String,
		groupStatus: String,
		paidAmount: 0,
		isPaid: False,
		appliedAmount: 0,
		appliedBy: 0,
		tshirtSize: String,
		invitedDt: 0001-01-01,
		lastLoginDt: 0001-01-01,
		fullName: String,
		studentFullName: String,
		chaperoneFullName: String,
		chaperonePhone: String,
		chaperoneHotel: String,
		chaperoneHotelPhone: String,
		guestEventName: String,
		passwordResetLink: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}