Cancellations

Cancellations

findReservationsCancelled

Query for cancelled reservations

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
BeginTime	iCalTimeString	Find cancelled reservations from. Check getCurrentDateTime
EndTime	iCalTimeString	Find cancelled reservations to
BeginModified	iCalTimeString	Find cancelled reservations that have been cancelled starting from this date and time (including this date time). Check getOffsetDateTime
EndModified	iCalTimeString	Find cancelled reservations that have been cancelled before this date and time (excluding this date time)
SearchObjects	Object[]	Objects that should be present on the cancelled reservations
TemplateGroup	String	Reservation situations to search for
Types	String[]	For typed cancelled reservations
ReservationStatusList	String[]	Reservation statuses to search for
AllReservations	Boolean	Find all cancelled reservations or only those deleted by the authenticated user
SortOrder	String	The sorting order for the cancelled reservations matching the query
ReturnFields	String[]	The fields to include on the cancelled reservations matching the query
ReturnTypes	TypeField[]	Array of the object types and fields for each object type to include on the matching cancelled reservations
SkipRestoredCancellations	Boolean	By setting this to false all cancelled reservations, including cancellations that have been restored, will be returned. Default value is true
BeginIndex	Int	Index of the first cancelled reservations to return (for pagination)
NumberOfObjects	Int	Maximum number of cancelled reservations to return (capped at 1000 per query, use BeginIndex to paginate over the cancelled reservations)

Returns

Return	Type	Description
Reservations	Reservation[]	Array of all reservations matching the query, with the fields and objects specified in ReturnFields and ReturnTypes
TotalNumOfReservations	Int	Total number of reservations matching the query

Example

Request

XML

<tns:begintime>20191201T000000</tns:begintime>
<tns:endtime>20191224T000000</tns:endtime>
<tns:beginmodified></tns:beginmodified>
<tns:endmodified></tns:endmodified>
<tns:searchobjects>
  <object>
    <type>room</type>
    <field>
      <extid>room.building</extid>
      <value>A-House</value>
    </field>
  </object>
</tns:searchobjects>
<tns:templategroup></tns:templategroup>
<tns:types>
  <type>room</type>
</tns:types>
<tns:reservationstatuslist>
  <status>B_COMPLETE</status>
  <status>B_INCOMPLETE</status>
  <status>C_CONFIRMED</status>
  <status>C_PRELIMINARY</status>
</tns:reservationstatuslist>
<tns:allreservations>true</tns:allreservations>
<tns:sortorder>MODIFIED_DESCENDING</tns:sortorder>
<tns:returnfields>
  <field>reservation.commment</field>
</tns:returnfields>
<tns:returntypes>
  <typefield>
    <typefield>
    <type>room</type>
    <field>room.name</field>
    <field>room.seats</field>
  </typefield>
    <type>course</type>
    <field>course.name</field>
    <field>course.code</field>
  </typefield>
</tns:returntypes>
<tns:beginindex>0</tns:beginindex>
<tns:numberofreservations>1000</tns:numberofreservations>

getReservationsCancelled

Get cancelled reservations by cancelled reservation ids

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
Reservations	String[]	Array of ids for the cancelled reservations to get
ReturnTypes	TypeField[]	Array of the object types and fields for each object type to include on the matching cancelled reservations
UseUTC	Boolean	Indicate whether the reservation timestamps should be in UTC or in local time

Returns

Return	Type	Description
Reservations	Reservation[]	Array of the requested cancelled reservations

Example

Request

XML

<tns:reservations>
  <reservation>47216</reservation>
</tns:reservations>
<tns:returntypes>
  <typefield>
    <type>room</type>
    <field>room.name</field>
    <field>room.seats</field>
  </typefield>
</tns:returntypes>
<tns:useutc>false</tns:useutc>

getReservationCancelledSortOrders

Get available sort orders for cancelled reservations

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key

Returns

Return	Type	Description
SortOrders	String[]	Array of available sort orders for cancelled reservations

Example

Request

XML

-