AbodeONE

<back to all web services

UpdateGuestCheck

Requires Authentication
Required role:Admin
The following routes are available for this service:
PATCH/guest_check
UpdateGuestCheck Parameters:
NameParameterData TypeRequiredDescription
GuestCheckIdqueryintNo
GuestIdqueryint?No
CheckDtqueryDateTime?No
CheckClassquerystringNo
GuestCheckResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestCheckDTONo
ResponseStatusformResponseStatusNo
GuestCheckDTO Parameters:
NameParameterData TypeRequiredDescription
GuestCheckIdformintNo
GuestIdformintNo
NightOfformDateTimeNo
CheckDtformDateTime?No
CheckClassformstringNo
CreatedByformstringNo
CreatedDtformDateTime?No
ModifiedByformstringNo
ModifiedDtformDateTime?No
GuestFirstNameformstringNo
GuestLastNameformstringNo
GuestFullNameformstringNo

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_check HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	guestCheckId: 0,
	guestId: 0,
	checkDt: 0001-01-01,
	checkClass: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		guestCheckId: 0,
		guestId: 0,
		nightOf: 0001-01-01,
		checkDt: 0001-01-01,
		checkClass: String,
		createdBy: String,
		createdDt: 0001-01-01,
		modifiedBy: String,
		modifiedDt: 0001-01-01,
		guestFirstName: String,
		guestLastName: String,
		guestFullName: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}