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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CancelReservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <OverrideWarnings>false</OverrideWarnings>
  <ReservationId>0</ReservationId>
  <StudentId>0</StudentId>
  <TermId>0</TermId>
</CancelReservation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <AppId>0</AppId>
    <ApprovalReason>String</ApprovalReason>
    <Approved>false</Approved>
    <ApprovedBy>String</ApprovedBy>
    <ApprovedDt>0001-01-01T00:00:00</ApprovedDt>
    <BedId>0</BedId>
    <Comments>String</Comments>
    <Confirmed>false</Confirmed>
    <ConfirmedBy>String</ConfirmedBy>
    <ConfirmedDt>0001-01-01T00:00:00</ConfirmedDt>
    <CreatedBy>String</CreatedBy>
    <CreatedDt>0001-01-01T00:00:00</CreatedDt>
    <ExpectedArrivalDt>0001-01-01T00:00:00</ExpectedArrivalDt>
    <LastModifiedBy>String</LastModifiedBy>
    <LastModifiedDt>0001-01-01T00:00:00</LastModifiedDt>
    <Locked>false</Locked>
    <MealPlanId>0</MealPlanId>
    <RequiresApproval>false</RequiresApproval>
    <RequiresConfirm>false</RequiresConfirm>
    <ReservationId>0</ReservationId>
    <ReserveAsSingle>false</ReserveAsSingle>
    <ReserveStatus>String</ReserveStatus>
    <RoomRateId>0</RoomRateId>
    <SelfReserved>false</SelfReserved>
    <StudentId>0</StudentId>
    <TermId>0</TermId>
  </Result>
</ReservationResponse>