AbodeONE

<back to all web services

CancelReservation

Requires Authentication
The following routes are available for this service:
All Verbs/reservation/{ReservationId}/cancel
CancelReservation Parameters:
NameParameterData TypeRequiredDescription
ReservationIdpathintNo
TermIdqueryint?No
StudentIdqueryint?No
OverrideWarningsquerybool?No
ReservationResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformReservationDTONo
ResponseStatusformResponseStatusNo
ReservationDTO Parameters:
NameParameterData TypeRequiredDescription
ReservationIdformintNo
StudentIdformintNo
BedIdformintNo
TermIdformintNo
AppIdformint?No
MealPlanIdformint?No
RoomRateIdformint?No
ReserveStatusformstringNo
SelfReservedformboolNo
ExpectedArrivalDtformDateTime?No
ReserveAsSingleformboolNo
LockedformboolNo
RequiresApprovalformboolNo
ApprovedformboolNo
ApprovalReasonformstringNo
ApprovedByformstringNo
ApprovedDtformDateTime?No
RequiresConfirmformboolNo
ConfirmedformboolNo
ConfirmedByformstringNo
ConfirmedDtformDateTime?No
CommentsformstringNo
CreatedDtformDateTime?No
CreatedByformstringNo
LastModifiedDtformDateTime?No
LastModifiedByformstringNo

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

{
	reservationId: 0,
	termId: 0,
	studentId: 0,
	overrideWarnings: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		reservationId: 0,
		studentId: 0,
		bedId: 0,
		termId: 0,
		appId: 0,
		mealPlanId: 0,
		roomRateId: 0,
		reserveStatus: String,
		selfReserved: False,
		expectedArrivalDt: 0001-01-01,
		reserveAsSingle: False,
		locked: False,
		requiresApproval: False,
		approved: False,
		approvalReason: String,
		approvedBy: String,
		approvedDt: 0001-01-01,
		requiresConfirm: False,
		confirmed: False,
		confirmedBy: String,
		confirmedDt: 0001-01-01,
		comments: String,
		createdDt: 0001-01-01,
		createdBy: String,
		lastModifiedDt: 0001-01-01,
		lastModifiedBy: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}