Dela via


StarRez REST v1

The StarRez resident and property management platform is the perfect tool to help your community thrive. With the StarRez REST API, you can automate regular tasks, import and export data and streamline your business processes.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name StarCare
URL https://support.starrez.com
Email starcare@starrez.com
Connector Metadata
Publisher StarRez, Inc.
Website https://www.starrez.com/
Privacy policy https://www.starrez.com/legal/privacy
Categories Data

For StarRez customers, that need to integrate with our REST API, our StarRez Custom Connector is a wrapper around our REST API that allows users to read and write from/to our backend database directly & make sure of other connectors within the Microsoft Power Automate ecosystem.

Prerequisites

To use this integration, you will need a StarRez account with a Rest API License. You will also need a Microsoft Premium License.

How to get credentials

To configure the custom connector, you will need to provide a username, password and base URL.

Please contact the StarCare team at https://support.starrez.com or starcare@starrez.com to obtain these credentials. Alternatively you can reach out to your Account Manager for more information.

You can then create a connection that links the StarRez custom connector to your StarRez instance.

Get started with your connector

Get your REST API Connection Settings:

  1. Log in to StarRez and click on Account in the top left > Account

  2. Web Service Tokens > Create New

  3. Copy the token to your clipboard and give it a name

  4. Refer to our API documentation to find your RestAPI URL (https://support.starrez.com/hc/en-us/articles/360056850292-StarRez-REST-2-0-Web-Services-API-Guide)

  5. Keep a record of these credentials

For MS Power Automate - ‘Send an email to all Entries Checked in in the last hour’

  1. Log in to Microsoft Power Automate

  2. Start with a Trigger for example ‘schedule’ > set the frequency that you would like to query the API

  3. New Step

  4. Search for ‘StarRez’ and select the StarRez REST v1 connector

    a. you will now need to authenticate your connection, use the credentials from the steps above

  5. Now choose the action you would like to perform, in this case we want to ‘Get Entry’

  6. We want to get today’s date so we use the ‘Expressions’ and find our current time in the time zone we are in for example utcNow(+10) or utcNow(-5)

  7. Next Step

  8. Choose an Action of ‘Mail’ or 'Outlook'

  9. Under ‘To’ use the StarRez data you have to get the Entry’s email

  10. Add in your email content, you can use StarRez data to add in dynamic content

  11. Click Save

  12. Power Automate will then give you the option to test your flow before it runs

Known issues and limitations

The current version of the StarRez REST custom connector does not include all API functionality.

At present, operations are available for 12 of the most used tables. Please refer to StarCare documentation for more details.

Other operations such as ListAttachments and GetPhoto are not currently supported.

'Get' actions allow for basic filtering of records in the relevant table. Records are matched based on the fields supplied.

Complex queries cannot be created using this version of the connector. If more complex queries are required, the HttpRequest connector should be used instead.

Common errors and remedies

Check to see if there are any issues here with the rest API?

FAQ

How do I connect to the StarRez Rest API Service?

Please refer to StarCare documentation https://support.starrez.com/hc/en-us/articles/360056850292-StarRez-REST-2-0-Web-Services-API-Guide

Please Refer to the StarRez Rest API Learning Plan https://support.starrez.com/hc/en-us/articles/208606766-Create-Token-for-REST-API-calls

How do I use Expressions when using the connector?

Please refer to Microsoft documentation to learn about expressions https://powerautomate.microsoft.com/en-us/blog/use-expressions-in-actions/

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Username string The username for the StarRez REST API. True
Password securestring The password for the StarRez REST API. True
Base URL string The base URL for the StarRez REST API. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Booking

Creates a new record in the Booking table.

Create Entry

Creates a new record in the Entry table.

Create Entry Application

Creates a new record in the Entry Application table.

Create Entry Enrollment

Creates a new record in the Entry Enrollment table.

Create Room Space

Creates a new record in the Room Space table.

Create Room Space Maintenance

Creates a new record in the Room Space Maintenance table.

Create Transaction

Creates a new record in the Transaction table.

Delete

Deletes a record from the specified table.

Get Booking

Retrieves one or more records from the Booking table.

Get Entry

Retrieves one or more records from the Entry table.

Get Entry Address

Retrieves one or more records from the Entry Address table.

Get Entry Application

Retrieves one or more records from the Entry Application table.

Get Entry Custom Field

Retrieves one or more records from the Entry Custom Field table.

Get Entry Detail

Retrieves one or more records from the Entry Detail table.

Get Entry Enrollment

Retrieves one or more records from the Entry Enrollment table.

Get Room Location

Retrieves one or more records from the Room Location table.

Get Room Space

Retrieves one or more records from the Room Space table.

Get Room Space Maintenance

Retrieves one or more records from the Room Space Maintenance table.

Get Term

Retrieves one or more records from the Term table.

Get Term Session

Retrieves one or more records from the Term Session table.

Get Transaction

Retrieves one or more records from the Transaction table.

Update Booking

Updates an existing record in the Booking table.

Update Entry

Updates an existing record in the Entry table.

Update Entry Address

Updates an existing record in the Entry Address table.

Update Entry Application

Updates an existing record in the Entry Application table.

Update Entry Custom Field

Updates an existing record in the Entry Custom Field table.

Update Entry Detail

Updates an existing record in the Entry Detail table.

Update Entry Enrollment

Updates an existing record in the Entry Enrollment table.

Update Room Space Maintenance

Updates an existing record in the Room Space Maintenance table.

Create Booking

Creates a new record in the Booking table.

Parameters

Name Key Required Type Description
Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
CheckInDate date-time

Main (contract) check-in date.

Check-In Date Actual
CheckInDateActual date-time

Actual date the entry arrives.

Check-Out Date
CheckOutDate date-time

Main (contract) check-out date.

Check-Out Date Actual
CheckOutDateActual date-time

Actual date the entry departs.

Comments
Comments string

Comments

Contract Date End
ContractDateEnd date-time

Contact chargeable date end.

Contract Date Start
ContractDateStart date-time

Contact chargeable date start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom Date 3
CustomDate3 date-time

Custom date field value.

Custom Date 4
CustomDate4 date-time

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
DateBilled date-time

Date when this booking was processed for billing.

Date Charged To
DateChargedTo date-time

Date this booking has been charged up to (using reservation charges).

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID True integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA date-time

Date and time of estimated arrival.

ETD
ETD date-time

Date and time of estimated departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
PaidTo date-time

Date the booking is paid to.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Returns

Name Path Type Description
Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking ID
BookingID integer

Unique ID for this booking record.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
CheckInDate string

Main (contract) check-in date.

Check-In Date Actual
CheckInDateActual string

Actual date the entry arrives.

Check-Out Date
CheckOutDate string

Main (contract) check-out date.

Check-Out Date Actual
CheckOutDateActual string

Actual date the entry departs.

Comments
Comments string

Comments

Contract Date End
ContractDateEnd string

Contact chargeable date end.

Contract Date Start
ContractDateStart string

Contact chargeable date start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
DateBilled string

Date when this booking was processed for billing.

Date Charged To
DateChargedTo string

Date this booking has been charged up to (using reservation charges).

Date Modified Billing
DateModifiedBilling string

Indicates when critical booking fields are modified.

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA string

Date and time of estimated arrival.

ETD
ETD string

Date and time of estimated departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
PaidTo string

Date the booking is paid to.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Create Entry

Creates a new record in the Entry table.

Parameters

Name Key Required Type Description
Address Type ID
AddressTypeID integer

Address type of the entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
DOB date-time

Date of birth.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
LastCheckInOutDate date-time

The last date a check-in or check-out was performed.

Name First
NameFirst True string

The first or given name of the entry.

Name Initials
NameInitials string

Name initials.

Name Last
NameLast True string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Password
Password password

Password

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

The email that is used by the student to login to the portal.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing User.

Returns

Name Path Type Description
Address Type ID
AddressTypeID integer

Address type of the entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
DOB string

Date of birth.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry ID
EntryID integer

Unique ID for this Entry field.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
LastCheckInOutDate string

The last date a check-in or check-out was performed.

Name First
NameFirst string

The first or given name of the entry.

Name Initials
NameInitials string

Initials in name.

Name Last
NameLast string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Password
Password string

Password

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

Portal email.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing user.

Create Entry Application

Creates a new record in the Entry Application table.

Parameters

Name Key Required Type Description
Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
ApplicationDate date-time

Date of application.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
CancelDate date-time

Cancellation date.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
CompleteDate date-time

Completion date.

Contract Signed Date
ContractSignedDate date-time

Date contract was signed.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom Date 3
CustomDate3 date-time

Custom date field value.

Custom Date 4
CustomDate4 date-time

Custom date field value.

Enquiry Date
EnquiryDate date-time

Date of enquiry.

Entry ID
EntryID True integer

Pointer to the entry record.

Expected Arrival Date
ExpectedArrivalDate date-time

Date entry is expected to arrive.

Expected Arrival Date Latest
ExpectedArrivalDateLatest date-time

Latest expected arrival date.

Expected Departure Date
ExpectedDepartureDate date-time

Date entry is expected to depart.

Offered Date
OfferedDate date-time

Date application was offered.

Offer Reply Date
OfferReplyDate date-time

Date offer was replied to.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
OfferSentDate date-time

Date offer sent.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
ReceivedDate date-time

Date received.

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received deposit.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent deposit payment that was attempted.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
ReceivedDepositDate date-time

Date deposit was received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
ReceivedFeeDate date-time

Date fee was received.

Received Photo Date
ReceivedPhotoDate date-time

Date photo was received.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

Room Mate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

Room Mate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

Room Mate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Returns

Name Path Type Description
Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
ApplicationDate string

Date of application.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
CancelDate string

Cancellation date.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
CompleteDate string

Completion date.

Contract Signed Date
ContractSignedDate string

Date contract was signed.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Entry Application ID
EntryApplicationID integer

Unique ID for this entry application record.

Enquiry Date
EnquiryDate string

Date of enquiry.

Entry ID
EntryID integer

Pointer to the entry record.

Expected Arrival Date
ExpectedArrivalDate string

Date entry is expected to arrive.

Expected Arrival Date Latest
ExpectedArrivalDateLatest string

Latest expected arrival date.

Expected Departure Date
ExpectedDepartureDate string

Date entry is expected to depart.

Offered Date
OfferedDate string

Date application was offered.

Offer Reply Date
OfferReplyDate string

Date offer was replied to.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
OfferSentDate string

Date offer sent.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
ReceivedDate string

Date received.

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received deposit.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent deposit payment that was attempted.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
ReceivedDepositDate string

Date deposit was received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
ReceivedFeeDate string

Date fee was received.

Received Photo Date
ReceivedPhotoDate string

Date photo was received.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

Room Mate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

Room Mate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

Room Mate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Create Entry Enrollment

Creates a new record in the Entry Enrollment table.

Parameters

Name Key Required Type Description
Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

Course ID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
DateEnd date-time

Date enrollment ends.

Date Start
DateStart date-time

Date enrollment starts.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry ID
EntryID True integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
GraduationDate date-time

Date of graduation.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Returns

Name Path Type Description
Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

CourseID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
DateEnd string

Date enrollment ends.

Date Start
DateStart string

Date enrollment starts.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry Enrollment ID
EntryEnrollmentID integer

Unique ID for this entry enrollment record.

Entry ID
EntryID integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
GraduationDate string

Date of graduation.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Create Room Space

Creates a new record in the Room Space table.

Parameters

Name Key Required Type Description
Allocate Exclude
AllocateExclude boolean

Room Allocation - Do not include room in allocations.

Allocate Sort Order
AllocateSortOrder integer

Room Allocation - Allows allocating nicer rooms first.

Bathrooms
Bathrooms integer

The number of bathrooms available.

Bed Capacity
BedCapacity integer

The number of beds available.

Comments
Comments string

Room space comments.

Description
Description string

The actual room name.

Extension ID
ExtensionID integer

Link to extension table. 0 means no phone in the room.

Hold
Hold boolean

Space is held for any reason. Will warn the user when allocating this space.

Networked
Networked boolean

Indicates if the room space is networked.

Record Type Enum
RecordTypeEnum string

Record type.

Room Base ID
RoomBaseID integer

Pointer to the room base record.

Room ID
RoomID integer

Pointer to the room record.

Room Rate ID
RoomRateID integer

Default tariff rate.

Room Space Type Enum
RoomSpaceTypeEnum string

Room space type.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Sort Order
SortOrder integer

Use to control where the room space is shown when part of a list.

Street
Street string

Street

Street 2
Street2 string

Street

Web Description
WebDescription string

The room space displayed in the Portal.

Zip Postcode
ZipPostcode string

Zip/Postcode

Returns

Name Path Type Description
Allocate Exclude
AllocateExclude boolean

Room Allocation - Do not include room in allocations.

Allocate Sort Order
AllocateSortOrder integer

Room Allocation - allows allocating nicer rooms first.

Bathrooms
Bathrooms integer

The number of bathrooms available.

Bed Capacity
BedCapacity integer

The number of beds available.

Comments
Comments string

Room space comments.

Description
Description string

The actual room name.

Extension ID
ExtensionID integer

Link to extension table. 0 means no phone in the room.

Hold
Hold boolean

Space is held for any reason. Will warn the user when allocating this space.

Networked
Networked boolean

Indicates if the room space is networked.

Record Type Enum
RecordTypeEnum string

Record type.

Room Base ID
RoomBaseID integer

Pointer to the room base record.

Room ID
RoomID integer

Pointer to the room record.

Room Rate ID
RoomRateID integer

Default tariff rate.

Room Space ID
RoomSpaceID integer

Unique ID for this room space record.

Room Space Type Enum
RoomSpaceTypeEnum string

Room space type.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Sort Order
SortOrder integer

Use to control where the room space is shown when part of a list.

Street
Street string

Street

Street 2
Street2 string

Street

Web Description
WebDescription string

The room space displayed in the Portal.

Zip Postcode
ZipPostcode string

Zip/Postcode

Create Room Space Maintenance

Creates a new record in the Room Space Maintenance table.

Parameters

Name Key Required Type Description
Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
CompleteDate date-time

Complete date.

Contact ID
ContactID integer

Pointer to the contact record.

Contract Date
ContractDate date-time

Contract date.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
ContractorDate date-time

Contractor date.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
CustomDate1 date-time

Custom date 1.

Custom Date 2
CustomDate2 date-time

Custom date 2.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Due
DateDue date-time

Date due.

Date Reported
DateReported date-time

Date reported.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID True integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
StartDate date-time

Start date.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Returns

Name Path Type Description
Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
CompleteDate string

Complete date.

Contact ID
ContactID integer

Pointer to the contact record.

Contract Date
ContractDate string

Contract date.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
ContractorDate string

Contractor date.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
CustomDate1 string

Custom date 1.

Custom Date 2
CustomDate2 string

Custom date 2.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Created
DateCreated string

Date created.

Date Due
DateDue string

Date due.

Date Modified
DateModified string

Date modified.

Date Reported
DateReported string

Date reported.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance ID
RoomSpaceMaintenanceID integer

Unique ID for this room space maintenance record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
StartDate string

Start date.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Create Transaction

Creates a new record in the Transaction table.

Parameters

Name Key Required Type Description
Amount
Amount True double

The total amount for this transaction (including tax).

Call Type Enum
CallTypeEnum string

Call type.

Charge Group ID
ChargeGroupID True integer

Pointer to the charge group record.

Charge Item ID
ChargeItemID integer

This is only required for Adjustments and Charges.

Comments
Comments string

Transaction comments.

Description
Description string

Transaction description.

Due Date
DueDate date-time

Due date.

Duration
Duration integer

Phone call duration in seconds.

End Of Session ID
EndOfSessionID integer

Pointer to the end of session record.

Entry ID
EntryID integer

Pointer to the entry record.

Excess
Excess double

Excess amount.

Extension
Extension integer

Extension qty.

External ID
ExternalID integer

Stores the (unique) ID from an external system - for imported transactions.

External Receipt ID
ExternalReceiptID string

Pointer to the external receipt record.

Invoice ID
InvoiceID integer

Pointer to the invoice record.

Paid From
PaidFrom date-time

Paid from date.

Paid To
PaidTo date-time

Paid to date.

Payment ID
PaymentID integer

Pointer to the payment record.

Processed Date
ProcessedDate date-time

Date transaction was processed.

Reference Booking ID
Reference_BookingID integer

The booking (if any) that this transaction relates to.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Table ID
TableID integer

Link to a referencing record (e.g. a BookingID for pro-rating).

Table Name
TableName string

Reference link table.

Tag
Tag string

Transaction tag.

Tag Finance
TagFinance string

Finance tag.

Tax Amount
TaxAmount double

Tax amount

Tax Amount 2
TaxAmount2 double

Tax amount

Tax Amount 3
TaxAmount3 double

Tax amount

Term Session ID
TermSessionID integer

Pointer to the term session record.

Transaction Date
TransactionDate date-time

Date of the transaction.

Transaction Type Enum
TransactionTypeEnum string

Transaction type.

Returns

Name Path Type Description
Amount
Amount double

The total amount for this transaction (including tax).

Call Type Enum
CallTypeEnum string

Call type.

Charge Group ID
ChargeGroupID integer

Pointer to the charge group record.

Charge Item ID
ChargeItemID integer

Pointer to the charge item record.

Comments
Comments string

Transaction comments.

Description
Description string

Transaction description.

Due Date
DueDate string

Due date.

Duration
Duration integer

Phone call duration in seconds.

End Of Session ID
EndOfSessionID integer

Pointer to the end of session record.

Entry ID
EntryID integer

Pointer to the entry record.

Excess
Excess double

Excess amount.

Extension
Extension integer

Extension qty.

External ID
ExternalID integer

Stores the (unique) ID from an external system - for imported transactions.

External Receipt ID
ExternalReceiptID string

Pointer to the external receipt record.

Invoice ID
InvoiceID integer

Pointer to the invoice record.

Paid From
PaidFrom string

Paid from date.

Paid To
PaidTo string

Paid to date.

Payment ID
PaymentID integer

Pointer to the payment record.

Processed Date
ProcessedDate string

Date transaction was processed.

Reference Booking ID
Reference_BookingID integer

The booking (if any) that this transaction relates to.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Table ID
TableID integer

Link to a referencing record (e.g. a BookingID for pro-rating).

Table Name
TableName string

Reference link table.

Tag
Tag string

Transaction tag.

Tag Finance
TagFinance string

Finance tag.

Tax Amount
TaxAmount double

Tax amount

Tax Amount 2
TaxAmount2 double

Tax amount

Tax Amount 3
TaxAmount3 double

Tax amount

Term Session ID
TermSessionID integer

Pointer to the term session record.

Transaction Date
TransactionDate string

Date of the transaction.

Transaction ID
TransactionID integer

Unique ID for this transaction record.

Transaction Type Enum
TransactionTypeEnum string

Transaction type.

Delete

Deletes a record from the specified table.

Parameters

Name Key Required Type Description
Table Name
TableName True string

Name of the table to delete record from.

Row ID
RowID True integer

Row ID

Returns

response
object

Get Booking

Retrieves one or more records from the Booking table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking ID
BookingID integer

Unique ID for this booking record.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
Value date-time

Main (contract) check-in date.

Check-In Date.Operator
_operator string

The comparison operator to use.

Check-In Date Actual
Value date-time

Actual date the entry arrives.

Check-In Date Actual.Operator
_operator string

The comparison operator to use.

Check-Out Date
Value date-time

Main (contract) check-out date.

Check-Out Date.Operator
_operator string

The comparison operator to use.

Check-Out Date Actual
Value date-time

Actual date the entry departs.

Check-Out Date Actual.Operator
_operator string

The comparison operator to use.

Comments
Comments string

Comments

Contract Date End
Value date-time

Contact chargeable date end.

Contract Date End.Operator
_operator string

The comparison operator to use.

Contract Date Start
Value date-time

Contact chargeable date start.

Contract Date Start.Operator
_operator string

The comparison operator to use.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
Value date-time

Custom date field value.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date field value.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom Date 3
Value date-time

Custom date field value.

Custom Date 3.Operator
_operator string

The comparison operator to use.

Custom Date 4
Value date-time

Custom date field value.

Custom Date 4.Operator
_operator string

The comparison operator to use.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
Value date-time

Date when this booking was processed for billing.

Date Billed.Operator
_operator string

The comparison operator to use.

Date Charged To
Value date-time

Date this booking has been charged up to (using reservation charges).

Date Charged To.Operator
_operator string

The comparison operator to use.

Date Created
Value date-time

Date record was created.

Date Created.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Date Modified Billing
Value date-time

Indicates when critical booking fields are modified.

Date Modified Billing.Operator
_operator string

The comparison operator to use.

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA string

Minutes since midnight for estimated time of arrival.

ETD
ETD string

Minutes since midnight for estimated time of departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
Value date-time

Date the booking is paid to.

Paid To.Operator
_operator string

The comparison operator to use.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Returns

Name Path Type Description
array of object
Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking ID
BookingID integer

Unique ID for this booking record.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
CheckInDate string

Main (contract) check-in date.

Check-In Date Actual
CheckInDateActual string

Actual date the entry arrives.

Check-Out Date
CheckOutDate string

Main (contract) check-out date.

Check-Out Date Actual
CheckOutDateActual string

Actual date the entry departs.

Comments
Comments string

Comments

Contract Date End
ContractDateEnd string

Contact chargeable date end.

Contract Date Start
ContractDateStart string

Contact chargeable date start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
DateBilled string

Date when this booking was processed for billing.

Date Charged To
DateChargedTo string

Date this booking has been charged up to (using reservation charges).

Date Created
DateCreated string

Date record was created.

Date Modified
DateModified string

Date record was last modified.

Date Modified Billing
DateModifiedBilling string

Indicates when critical booking fields are modified.

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA string

Date and time of estimated arrival.

ETD
ETD string

Date and time of estimated departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
PaidTo string

Date the booking is paid to.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Get Entry

Retrieves one or more records from the Entry table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Address Type ID
AddressTypeID integer

Address type of the entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Date Created
Value date-time

Date record was created.

Date Created.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
Value date-time

Date of birth.

DOB.Operator
_operator string

The comparison operator to use.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry ID
EntryID integer

Unique ID for this Entry field.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
Value date-time

The last date a check-in or check-out was performed.

Last Check In Out Date.Operator
_operator string

The comparison operator to use.

Name First
NameFirst string

The first or given name of the entry.

Name Initials
NameInitials string

Name initials.

Name Last
NameLast string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

The email that is used by the student to login to the portal.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing User.

Returns

Name Path Type Description
array of object
Address Type ID
AddressTypeID integer

Address type of the entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Date Created
DateCreated string

Date record was created.

Date Modified
DateModified string

Date record was last modified.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
DOB string

Date of birth.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry ID
EntryID integer

Unique ID for this Entry field.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
LastCheckInOutDate string

The last date a check-in or check-out was performed.

Name First
NameFirst string

The first or given name of the entry.

Name Initials
NameInitials string

Name initials.

Name Last
NameLast string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

The email that is used by the student to login to the portal.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing User.

Get Entry Address

Retrieves one or more records from the Entry Address table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Active Date End
Value date-time

End active date.

Active Date End.Operator
_operator string

The comparison operator to use.

Active Date Start
Value date-time

Date when this address becomes active.

Active Date Start.Operator
_operator string

The comparison operator to use.

Address Type ID
AddressTypeID integer

Pointer to the address type record.

City
City string

City

Comments
Comments string

Address comments.

Contact Name
ContactName string

Contact name.

Contact Name 2
ContactName2 string

Contact name 2.

Country ID
CountryID integer

Pointer to the country record.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Email
Email string

Email

Entry Address ID
EntryAddressID integer

Unique ID for this entry address record.

Entry ID
EntryID integer

Pointer to the entry record.

Phone
Phone string

Phone

Phone Mobile Cell
PhoneMobileCell string

Mobile/Cell

Phone Other
PhoneOther string

Alternative phone.

Phone Other 2
PhoneOther2 string

Alternative phone 2.

Reference
Reference string

Reference

Relationship
Relationship string

Relationship this address has to the entry.

Salutation
Salutation string

Salutation

State Province
StateProvince string

State/Province

Street
Street string

Street

Street 2
Street2 string

Street

Zip Postcode
ZipPostcode string

Zip/Postcode

Returns

Name Path Type Description
array of object
Active Date End
ActiveDateEnd string

End active date.

Active Date Start
ActiveDateStart string

Date when this address becomes active.

Address Type ID
AddressTypeID integer

Pointer to the address type record.

City
City string

City

Comments
Comments string

Address comments.

Contact Name
ContactName string

Contact name.

Contact Name 2
ContactName2 string

Contact name 2.

Country ID
CountryID integer

Pointer to the country record.

Date Modified
DateModified string

Date record was last modified.

Email
Email string

Email

Entry Address ID
EntryAddressID integer

Unique ID for this entry address record.

Entry ID
EntryID integer

Pointer to the entry record.

Phone
Phone string

Phone

Phone Mobile Cell
PhoneMobileCell string

Mobile/Cell

Phone Other
PhoneOther string

Alternative phone.

Phone Other 2
PhoneOther2 string

Alternative phone 2.

Reference
Reference string

Reference

Relationship
Relationship string

Relationship this address has to the entry.

Salutation
Salutation string

Salutation

State Province
StateProvince string

State/Province

Street
Street string

Street

Street 2
Street2 string

Street

Zip Postcode
ZipPostcode string

Zip/Postcode

Get Entry Application

Retrieves one or more records from the Entry Application table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
Value date-time

Date of application.

Application Date.Operator
_operator string

The comparison operator to use.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
Value date-time

Cancellation date.

Cancel Date.Operator
_operator string

The comparison operator to use.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
Value date-time

Completion date.

Complete Date.Operator
_operator string

The comparison operator to use.

Contract Signed Date
Value date-time

Date contract was signed.

Contract Signed Date.Operator
_operator string

The comparison operator to use.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
Value date-time

Custom date field value.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date field value.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom Date 3
Value date-time

Custom date field value.

Custom Date 3.Operator
_operator string

The comparison operator to use.

Custom Date 4
Value date-time

Custom date field value.

Custom Date 4.Operator
_operator string

The comparison operator to use.

Date Created
Value date-time

Date record was created.

Date Created.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Enquiry Date
Value date-time

Date of enquiry.

Enquiry Date.Operator
_operator string

The comparison operator to use.

Entry Application ID
EntryApplicationID integer

Unique ID for this entry application record.

Entry ID
EntryID integer

Pointer to the entry record.

Expected Arrival Date
Value date-time

Date entry is expected to arrive.

Expected Arrival Date.Operator
_operator string

The comparison operator to use.

Expected Arrival Date Latest
Value date-time

Latest expected arrival date.

Expected Arrival Date Latest.Operator
_operator string

The comparison operator to use.

Expected Departure Date
Value date-time

Date entry is expected to depart.

Expected Departure Date.Operator
_operator string

The comparison operator to use.

Offered Date
Value date-time

Date application was offered.

Offered Date.Operator
_operator string

The comparison operator to use.

Offer Reply Date
Value date-time

Date offer was replied to.

Offer Reply Date.Operator
_operator string

The comparison operator to use.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
Value date-time

Date offer sent.

Offer Sent Date.Operator
_operator string

The comparison operator to use.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
Value date-time

Date received.

Received Date.Operator
_operator string

The comparison operator to use.

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received fee.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent fee payment that was attempted.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
Value date-time

Date deposit was received.

Received Deposit Date.Operator
_operator string

The comparison operator to use.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
Value date-time

Date fee was received.

Received Fee Date.Operator
_operator string

The comparison operator to use.

Received Photo Date
Value date-time

Date photo was received.

Received Photo Date.Operator
_operator string

The comparison operator to use.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

Room Mate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

Room Mate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

Room Mate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Returns

Name Path Type Description
array of object
Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
ApplicationDate string

Date of application.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
CancelDate string

Cancellation date.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
CompleteDate string

Completion date.

Contract Signed Date
ContractSignedDate string

Date contract was signed.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Date Created
DateCreated string

Date record was created.

Date Modified
DateModified string

Date record was last modified.

Entry Application ID
EntryApplicationID integer

Unique ID for this entry application record.

Entry ID
EntryID integer

Pointer to the entry record.

Enquiry Date
EnquiryDate string

Date of enquiry.

Expected Arrival Date
ExpectedArrivalDate string

Date entry is expected to arrive.

Expected Arrival Date Latest
ExpectedArrivalDateLatest string

Latest expected arrival date.

Expected Departure Date
ExpectedDepartureDate string

Date entry is expected to depart.

Offered Date
OfferedDate string

Date application was offered.

Offer Reply Date
OfferReplyDate string

Date offer was replied to.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
OfferSentDate string

Date offer sent.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
ReceivedDate string

Date received

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent deposit payment that was attempted.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received deposit.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
ReceivedDepositDate string

Date deposit was received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
ReceivedFeeDate string

Date fee was received.

Received Photo Date
ReceivedPhotoDate string

Date photo was received.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

Room Mate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

Room Mate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

Room Mate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Get Entry Custom Field

Retrieves one or more records from the Entry Custom Field table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Custom Field Definition ID
CustomFieldDefinitionID integer

Pointer to the custom field definition record.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Entry Custom Field ID
EntryCustomFieldID integer

Unique ID for this entry custom field record.

Entry ID
EntryID integer

Pointer to the entry record.

Field DataType Enum
FieldDataTypeEnum string

Field data type.

Value Boolean
ValueBoolean boolean

Boolean value.

Value Date
Value date-time

Date Value

Value Date.Operator
_operator string

The comparison operator to use.

Value Integer
ValueInteger integer

Integer value.

Value Money
ValueMoney double

Money value.

Value String
ValueString string

String value.

Returns

Name Path Type Description
array of object
Custom Field Definition ID
CustomFieldDefinitionID integer

Pointer to the custom field definition record.

Date Modified
DateModified string

Date record was last modified.

Entry Custom Field ID
EntryCustomFieldID integer

Unique ID for this entry custom field record.

Entry ID
EntryID integer

Pointer to the entry record.

Field DataType Enum
FieldDataTypeEnum string

Field data type.

Value Boolean
ValueBoolean boolean

Boolean value.

Value Date
ValueDate string

Date value.

Value Integer
ValueInteger integer

Integer value.

Value Money
ValueMoney double

Money value.

Value String
ValueString string

String value.

Get Entry Detail

Retrieves one or more records from the Entry Detail table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Academic Hold
AcademicHold boolean

Indicates if the academic hold flag has been set.

Account Payment Type ID
Account_PaymentTypeID integer

Pointer to the payment type record.

Account Hold
AccountHold boolean

Indicates if the account hold flag has been set.

Account Bank Name
AccountBankName string

Account bank name.

Account Bank Number
AccountBankNumber string

Account bank number.

Account Code
AccountCode string

Account code.

Account Comments
AccountComments string

Account comments.

Account Detail 1
AccountDetail1 string

Account detail.

Account Detail 2
AccountDetail2 string

Account detail.

Account Detail 3
AccountDetail3 string

Account detail.

Account Detail 4
AccountDetail4 string

Account detail.

Account Date Paid To
Value date-time

Value

Account Date Paid To.Operator
_operator string

The comparison operator to use.

Athlete
Athlete boolean

Indicates if the athlete flag has been set.

Athlete Team
AthleteTeam string

Athlete team.

Attendee Status Enum
AttendeeStatusEnum string

Attendee status.

Career
Career string

Intended career.

Career Comments
CareerComments string

Reasons for choosing intended career.

Citizenship Country ID
Citizenship_CountryID integer

Pointer to the citizenship record.

Classification ID
ClassificationID integer

Pointer to the classification record.

Classification Override
ClassificationOverride boolean

Classification override.

Comments
Comments string

Comments.

Country Of Birth Country ID
CountryOfBirth_CountryID integer

Pointer to the country of birth record.

Country Of Residence Country ID
CountryOfResidence_CountryID integer

Pointer to the country of residence record.

Cumulative GPA
CumulativeGPA double

Cumulative GPA.

Cumulative Hours
CumulativeHours double

Cumulative hours.

Current GPA
CurrentGPA double

Current GPA.

Current Hours
CurrentHours double

Current hours.

Current Major
CurrentMajor string

The major chosen by the Entry.

Current Minor
CurrentMinor string

The minor chosen by the Entry.

Date Entry
Value date-time

Value.

Date Entry.Operator
_operator string

The comparison operator to use.

Date Exit
Value date-time

Value

Date Exit.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Value

Date Modified.Operator
_operator string

The comparison operator to use.

Deceased
Deceased boolean

Indicates if the Entry is deceased.

Deceased Date
Value date-time

Value

Deceased Date.Operator
_operator string

The comparison operator to use.

Dietary
Dietary string

Dietary requirements.

Disability
Disability string

Disability.

Employment Details
EmploymentDetails string

Employment details.

Enrollment Class
EnrollmentClass string

First year, freshman, sophomore, etc.

Enrollment Level
EnrollmentLevel string

Undergraduate, post graduate, etc.

Enrollment Status
EnrollmentStatus string

Newly admitted, current, active, etc.

Enrollment Term
EnrollmentTerm string

Spring, fall, post graduate, etc.

Enrollment Year
EnrollmentYear integer

Year/Level of enrollment.

Entry Detail ID
EntryDetailID integer

Unique ID for this entry detail record.

Entry ID
EntryID integer

Pointer to the entry record.

Ethnicity
Ethnicity string

Ethnicity.

Event Registration Fee ID
EventRegistrationFeeID integer

Pointer to the event registration fee record.

Expected Graduation Date
Value date-time

Value

Expected Graduation Date.Operator
_operator string

The comparison operator to use.

Financial Comments
FinancialComments string

Financial support comments.

Financial Support ID
FinancialSupportID integer

Pointer to the financial support record.

Hear About Us
HearAboutUs string

How did the Entry hear about us.

Honors Indicator
HonorsIndicator boolean

Honors indicator.

Immunizations Hold
ImmunizationsHold boolean

Immunizations hold.

Incident Hold
IncidentHold boolean

Incident hold.

Incident Hold Comments
IncidentHoldComments string

Incident hold comments.

International
International boolean

Indicates if the Entry is considered an international student.

International Details
InternationalDetails string

International details.

Living With Dependents
LivingWithDependents boolean

Living with dependents.

Married
Married boolean

Indicates if the Entry is married.

Medical
Medical string

Medical details.

Nationality ID
NationalityID integer

Pointer to the nationality record.

Occupation
Occupation string

Occupation.

Photo Path
PhotoPath string

Photo path.

Previous Member Name
PreviousMemberName string

Previous member name.

Previous Member Relationship
PreviousMemberRelationship string

Previous member relationship.

Previous Membership
PreviousMembership string

Previous membership.

Previous Membership Years
PreviousMembershipYears string

Previous membership years.

Previous Member Years
PreviousMemberYears string

Previous member years.

Profile Interests
ProfileInterests string

Profile interests.

Region Of Birth ID
RegionOfBirthID integer

Pointer to the Region of birth record.

Religion
Religion string

Religion.

Residency
Residency string

Residency.

Resident Status
ResidentStatus string

Resident status.

Resident Year
ResidentYear integer

Resident year.

Situation Response Comments
SituationResponseComments string

Situation response comments.

Situation Response Detail
SituationResponseDetail string

Situation response detail.

Situation Response Enum
SituationResponseEnum string

Situation response.

Situation Response Expiry Date
Value date-time

Value

Situation Response Expiry Date.Operator
_operator string

The comparison operator to use.

Situation Response Modified Date
Value date-time

Value

Situation Response Modified Date.Operator
_operator string

The comparison operator to use.

Situation Response Situation
SituationResponseSituation string

Situation response situation.

Special Needs
SpecialNeeds string

Special needs.

Staff ID
StaffID integer

Pointer to the staff record.

Uses Screen Reader
UsesScreenReader boolean

Uses screen reader.

Vehicle Details
VehicleDetails string

Vehicle details.

Vehicle Permit
VehiclePermit string

Vehicle permit.

Vehicle Registration
VehicleRegistration string

Vehicle registration.

Veteran Status
VeteranStatus string

Veteran status.

Visa
Visa boolean

Indicates if the Entry holds a visa.

Visa Details
VisaDetails string

Visa details.

Visitor Hold
VisitorHold boolean

Visitor hold.

Returns

Name Path Type Description
array of object
Academic Hold
AcademicHold boolean

Indicates if the academic hold flag has been set.

Account Payment Type ID
Account_PaymentTypeID integer

Pointer to the preferred payment type record.

Account Bank Name
AccountBankName string

Account bank name.

Account Bank Number
AccountBankNumber string

Account bank number.

Account Code
AccountCode string

Account code.

Account Comments
AccountComments string

Account comments.

Account Detail 1
AccountDetail1 string

Account detail.

Account Detail 2
AccountDetail2 string

Account detail.

Account Detail 3
AccountDetail3 string

Account detail.

Account Detail 4
AccountDetail4 string

Account detail.

Account Data Paid To
AccountDueDate string

Paid to date.

Account Hold
AccountHold boolean

Indicates if the account hold flag has been set.

Athlete
Athlete boolean

Indicates if the athlete flag has been set.

Athlete Team
AthleteTeam string

Athlete team.

Attendee Status Enum
AttendeeStatusEnum string

Attendee status.

Career
Career string

Intended career.

Career Comments
CareerComments string

Reasons for choosing intended career.

Citizenship Country ID
Citizenship_CountryID integer

Pointer to the citizenship record.

Classification ID
ClassificationID integer

Pointer to the classification record.

Classification Override
ClassificationOverride boolean

Classification override.

Comments
Comments string

Comments.

Country Of Birth Country ID
CountryOfBirth_CountryID integer

Pointer to the country of birth record.

Country Of Residence Country ID
CountryOfResidence_CountryID integer

Pointer to the country of residence record.

Cumulative GPA
CumulativeGPA double

Cumulative GPA.

Cumulative Hours
CumulativeHours double

Cumulative hours.

Current GPA
CurrentGPA double

Current GPA.

Current Hours
CurrentHours double

Current hours.

Current Major
CurrentMajor string

The major chosen by the Entry.

Current Minor
CurrentMinor string

The minor chosen by the Entry.

Date Entry
DateEntry string

Entry date.

Date Exit
DateExit string

Exit date.

Date Modified
DateModified string

Date record was last modified.

Deceased
Deceased boolean

Indicates if the Entry is deceased.

Deceased Date
DeceasedDate string

Deceased date.

Dietary
Dietary string

Dietary requirements.

Disability
Disability string

Disability.

Employment Details
EmploymentDetails string

Employment details.

Enrollment Class
EnrollmentClass string

First year, freshman, sophomore, etc.

Enrollment Level
EnrollmentLevel string

Undergraduate, post graduate, etc.

Enrollment Status
EnrollmentStatus string

Newly admitted, current, active, etc.

Enrollment Term
EnrollmentTerm string

Spring, fall, post graduate, etc.

Enrollment Year
EnrollmentYear integer

Year/Level of enrollment.

Entry Detail ID
EntryDetailID integer

Unique ID for this entry detail record.

Entry ID
EntryID integer

Pointer to the entry record.

Ethnicity
Ethnicity string

Ethnicity.

Event Registration Fee ID
EventRegistrationFeeID integer

Pointer to the event registration fee record.

Expected Graduation Date
ExpectedGraduationDate string

Expected graduation date.

Financial Comments
FinancialComments string

Financial support comments.

Financial Support ID
FinancialSupportID integer

Pointer to the financial support record.

Hear About Us
HearAboutUs string

How did the Entry hear about us.

Honors Indicator
HonorsIndicator boolean

Honors indicator.

Immunizations Hold
ImmunizationsHold boolean

Immunizations hold.

Incident Hold
IncidentHold boolean

Incident hold.

Incident Hold Comments
IncidentHoldComments string

Incident hold comments.

International
International boolean

Indicates if the Entry is considered an international student.

International Details
InternationalDetails string

International details.

Living With Dependents
LivingWithDependents boolean

Living with dependents.

Married
Married boolean

Indicates if the Entry is married.

Medical
Medical string

Medical details.

Nationality ID
NationalityID integer

Pointer to the nationality record.

Occupation
Occupation string

Occupation.

Photo Path
PhotoPath string

Photo path.

Previous Member Name
PreviousMemberName string

Previous member name.

Previous Member Relationship
PreviousMemberRelationship string

Previous member relationship.

Previous Membership
PreviousMembership string

Previous membership.

Previous Membership Years
PreviousMembershipYears string

Previous membership years.

Previous Member Years
PreviousMemberYears string

Previous member years.

Profile Interests
ProfileInterests string

Profile interests.

Region Of Birth ID
RegionOfBirthID integer

Pointer to the region of birth record.

Religion
Religion string

Religion.

Residency
Residency string

Residency.

Resident Status
ResidentStatus string

Resident status.

Resident Year
ResidentYear integer

Resident year.

Situation Response Comments
SituationResponseComments string

Situation response comments.

Situation Response Detail
SituationResponseDetail string

Situation response detail.

Situation Response Enum
SituationResponseEnum string

Situation response.

Situation Response Expiry Date
SituationResponseExpiryDate string

The date when the response ends (e.g because the emergency is over)

Situation Response Modified Date
SituationResponseModifiedDate string

The date the response was last modified.

Situation Response Situation
SituationResponseSituation string

Situation response situation.

Special Needs
SpecialNeeds string

Special needs.

Staff ID
StaffID integer

Pointer to the staff record.

Uses Screen Reader
UsesScreenReader boolean

Uses screen reader.

Vehicle Details
VehicleDetails string

Vehicle details.

Vehicle Permit
VehiclePermit string

Vehicle permit.

Vehicle Registration
VehicleRegistration string

Vehicle registration.

Veteran Status
VeteranStatus string

Veteran status.

Visa
Visa boolean

Indicates if the Entry holds a visa.

Visa Details
VisaDetails string

Visa details.

Visitor Hold
VisitorHold boolean

Visitor hold.

Get Entry Enrollment

Retrieves one or more records from the Entry Enrollment table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

Course ID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
Value date-time

Custom date field value.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date field value.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
Value date-time

Date enrollment ends.

Date End.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Date Start
Value date-time

Date enrollment starts.

Date Start.Operator
_operator string

The comparison operator to use.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry Enrollment ID
EntryEnrollmentID integer

Unique ID for this entry enrollment record.

Entry ID
EntryID integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
Value date-time

Date of graduation.

Graduation Date.Operator
_operator string

The comparison operator to use.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Returns

Name Path Type Description
array of object
Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

Course ID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
DateEnd string

Date enrollment ends.

Date Modified
DateModified string

Date record was last modified.

Date Start
DateStart string

Date enrollment starts.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry Enrollment ID
EntryEnrollmentID integer

Unique ID for this entry enrollment record.

Entry ID
EntryID integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
GraduationDate string

Date of graduation.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Get Room Location

Retrieves one or more records from the Room Location table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Allocate Sort Order
AllocateSortOrder integer

Allocate sort order.

Category ID
CategoryID integer

Pointer to the category record.

City
City string

City

Comments
Comments string

Room location comments.

Country ID
CountryID integer

Pointer to the country record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
Value date-time

Custom date field value.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date field value.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Description
Description string

Room location description.

Gender Type Enum
GenderTypeEnum string

Gender type suitability.

Lease
Lease boolean

Indicates if the room location is leased.

Managed Externally
ManagedExternally boolean

Indicates if the room location is managed externally.

Non Residential
NonResidential boolean

Indicates if the room location is non residential.

Record Type Enum
RecordTypeEnum string

Record type.

Room Location Area ID
RoomLocationAreaID integer

Pointer to the room location area record.

Room Location ID
RoomLocationID integer

Unique ID for this room location record.

State Province
StateProvince string

State/Province

View On Web
ViewOnWeb boolean

Indicates if the room space is viewable on the web.

Web Comments
WebComments string

Comments to display if visible on the web.

Web Description
WebDescription string

Description to display if visible on the web.

Web Image Alt Text
WebImageAltText string

Alternate text to display for the image when displayed on the web.

Web Image Location
WebImageLocation string

Path for the web image.

Zip Postcode
ZipPostcode string

Zip/Postcode.

Returns

Name Path Type Description
array of object
Allocate Sort Order
AllocateSortOrder integer

Allocate sort order.

Category ID
CategoryID integer

Pointer to the category record.

City
City string

City

Comments
Comments string

Room location comments.

Country ID
CountryID integer

Pointer to the country record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date Modified
DateModified string

Date record was last modified.

Description
Description string

Room location description.

Gender Type Enum
GenderTypeEnum string

Gender type suitability.

Lease
Lease boolean

Indicates if the room location is leased.

Managed Externally
ManagedExternally boolean

Indicates if the room location is managed externally.

Non Residential
NonResidential boolean

Indicates if the room location is non residential.

Record Type Enum
RecordTypeEnum string

Record type.

Room Location Area ID
RoomLocationAreaID integer

Pointer to the room location area record.

Room Location ID
RoomLocationID integer

Unique ID for this room location record.

State Province
StateProvince string

State/Province

View On Web
ViewOnWeb boolean

Indicates if the room space is viewable on the web.

Web Comments
WebComments string

Comments to display if visible on the web.

Web Description
WebDescription string

Description to display if visible on the web.

Web Image Alt Text
WebImageAltText string

Alternate text to display for the image when displayed on the web.

Web Image Location
WebImageLocation string

Path for the web image.

Zip Postcode
ZipPostcode string

Zip/Postcode.

Get Room Space

Retrieves one or more records from the Room Space table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Allocate Exclude
AllocateExclude boolean

Room Allocation - Do not include room in allocations.

Allocate Sort Order
AllocateSortOrder integer

Room Allocation - Allows allocating nicer rooms first.

Bathrooms
Bathrooms integer

The number of bathrooms available.

Bed Capacity
BedCapacity integer

The number of beds available.

Comments
Comments string

Room space comments.

Date Modified
Value date-time

Value

Date Modified.Operator
_operator string

The comparison operator to use.

Description
Description string

The actual room name.

Extension ID
ExtensionID integer

Link to extension table. 0 means no phone in the room.

Hold
Hold boolean

Space is held for any reason. Will warn the user when allocating this space.

Networked
Networked boolean

Indicates if the room space is networked.

Record Type Enum
RecordTypeEnum string

Record type.

Room Base ID
RoomBaseID integer

Pointer to the room base record.

Room ID
RoomID integer

Pointer to the room record.

Room Rate ID
RoomRateID integer

Default tariff rate.

Room-Space ID
RoomSpaceID integer

Unique ID for this room space record.

Room-Space Type Enum
RoomSpaceTypeEnum string

Room space type.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Sort Order
SortOrder integer

Use to control where the room space is shown when part of a list.

Street
Street string

Street

Street 2
Street2 string

Street

Web Description
WebDescription string

The room space displayed in the Portal.

Zip Postcode
ZipPostcode string

Zip/Postcode

Returns

Name Path Type Description
array of object
Allocate Exclude
AllocateExclude boolean

Room Allocation - Do not include room in allocations.

Allocate Sort Order
AllocateSortOrder integer

Room Allocation - Allows allocating nicer rooms first.

Bathrooms
Bathrooms integer

The number of bathrooms available.

Bed Capacity
BedCapacity integer

The number of beds available.

Comments
Comments string

Room space Comments.

Date Modified
DateModified string

Date record was last modified.

Description
Description string

The actual room name.

Extension ID
ExtensionID integer

Link to extension table. 0 means no phone in the room.

Hold
Hold boolean

Space is held for any reason. Will warn the user when allocating this space.

Networked
Networked boolean

Indicates if the room space is networked.

Record Type Enum
RecordTypeEnum string

Record type.

Room Base ID
RoomBaseID integer

Pointer to the room base record.

Room ID
RoomID integer

Pointer to the room record.

Room Rate ID
RoomRateID integer

Default tariff rate.

Room Space ID
RoomSpaceID integer

Unique ID for this room space record.

Room Space Type Enum
RoomSpaceTypeEnum string

Room space type.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Sort Order
SortOrder integer

Use to control where the room space is shown when part of a list.

Street
Street string

Street

Street 2
Street2 string

Street

Web Description
WebDescription string

The room space displayed in the Portal.

Zip Postcode
ZipPostcode string

Zip/Postcode

Get Room Space Maintenance

Retrieves one or more records from the Room Space Maintenance table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
Value date-time

Complete date.

Complete Date.Operator
_operator string

The comparison operator to use.

Contact ID
ContactID integer

Pointer to the contact record.

Contract Date
Value date-time

Contract date.

Contract Date.Operator
_operator string

The comparison operator to use.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
Value date-time

Contractor date.

Contractor Date.Operator
_operator string

The comparison operator to use.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Created By Security User
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
Value date-time

Custom date 1.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date 2.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Created
Value date-time

Date created.

Date Created.Operator
_operator string

The comparison operator to use.

Date Due
Value date-time

Date due.

Date Due.Operator
_operator string

The comparison operator to use.

Date Modified
Value date-time

Date modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Date Reported
Value date-time

Date reported.

Date Reported.Operator
_operator string

The comparison operator to use.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance ID
RoomSpaceMaintenanceID integer

Unique ID for this room space maintenance record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
Value date-time

Start date.

Start Date.Operator
_operator string

The comparison operator to use.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Returns

Name Path Type Description
array of object
Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
CompleteDate string

Complete date.

Contact ID
ContactID integer

Pointer to the contact record.

Contract Date
ContractDate string

Contract date.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
ContractorDate string

Contractor date.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
CustomDate1 string

Custom date 1.

Custom Date 2
CustomDate2 string

Custom date 2.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Created
DateCreated string

Date created.

Date Due
DateDue string

Date due.

Date Modified
DateModified string

Date modified.

Date Reported
DateReported string

Date reported.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance ID
RoomSpaceMaintenanceID integer

Unique ID for this room space maintenance record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
StartDate string

Start date.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Get Term

Retrieves one or more records from the Term table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Active
Active boolean

Current active state.

Active Date Close
Value date-time

Date term closes.

Active Date Close.Operator
_operator string

The comparison operator to use.

Active Date Open
Value date-time

Date term opens.

Active Date Open.Operator
_operator string

The comparison operator to use.

Category ID
CategoryID integer

Pointer to the category record.

Comments
Comments string

Term comments.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Description
Description string

Term description.

Record Type Enum
RecordTypeEnum string

Record type.

Term Code
TermCode string

Term code.

Term ID
TermID integer

Unique ID for this term record.

Term Type ID
TermTypeID integer

Pointer to the term type record.

Web Description
WebDescription string

Term displayed in the Portal.

Returns

Name Path Type Description
array of object
Active
Active boolean

Current active state.

Active Date Close
ActiveDateClose string

Date term closes.

Active Date Open
ActiveDateOpen string

Date term opens.

Category ID
CategoryID integer

Pointer to the category record.

Comments
Comments string

Term comments.

Date Modified
DateModified string

Date record was last modified.

Description
Description string

Term description.

Record Type Enum
RecordTypeEnum string

Record type.

Term Code
TermCode string

Term code.

Term ID
TermID integer

Unique ID for this term record.

Term Type ID
TermTypeID integer

Pointer to the term type record.

Web Description
WebDescription string

Term displayed in the Portal.

Get Term Session

Retrieves one or more records from the Term Session table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Cancel Booking Default End Reason
CancelBookingDefaultEnd_BookingReasonID integer

The default booking end reason when cancelling a booking.

Cancel Booking Update End Reason
CancelBookingUpdateEndBookingReason_BooleanAskEnum string

Update booking end reason on booking cancel.

Check-In Date
Value date-time

Date of check-in.

Check-In Date.Operator
_operator string

The comparison operator to use.

Check In Date Actual Decrease
CheckInDateActualDecrease_BooleanAskEnum string

Update CheckInDateActual if check-in date moves backward (in the past).

Check In Date Actual Increase
CheckInDateActualIncrease_BooleanAskEnum string

Update CheckInDateActual if check-in date moves forward (in the future).

Check In Default Start Reason
CheckInDefaultStart_BookingReasonID integer

The default booking start reason when checking in.

Check In Update Start Reason
CheckInUpdateStartBookingReason_BooleanAskEnum string

Update booking start reason on check-in.

Check-Out Date
Value date-time

Date of check-out.

Check-Out Date.Operator
_operator string

The comparison operator to use.

Check Out Date Actual Decrease
CheckOutDateActualDecrease_BooleanAskEnum string

Update CheckOutDateActual if check-in date moves backward (in the past).

Check Out Date Actual Increase
CheckOutDateActualIncrease_BooleanAskEnum string

Update CheckOutDateActual if check-in date moves forward (in the future).

Check Out Default End Reason
CheckOutDefaultEnd_BookingReasonID integer

The default booking end reason when checking out.

Check Out Update End Reason
CheckOutUpdateEndBookingReason_BooleanAskEnum string

Update booking end reason on check-out.

Contract Date Check In Decrease
ContractDateCheckInDecrease_BooleanAskEnum string

Update Charge Dates if check-in date moves backward (in the past).

Contract Date Check In Increase
ContractDateCheckInIncrease_BooleanAskEnum string

Update Charge Dates if check-in date moves forward (in the future).

Contract Date Check Out Decrease
ContractDateCheckOutDecrease_BooleanAskEnum string

Update Charge Dates if check-out date moves backward (in the past).

Contract Date Check Out Increase
ContractDateCheckOutIncrease_BooleanAskEnum string

Update Charge Dates if check-out date moves forward (in the future).

Contract Date End
Value date-time

Date of contract end.

Contract Date End.Operator
_operator string

The comparison operator to use.

Contract Date Start
Value date-time

Date of contract start.

Contract Date Start.Operator
_operator string

The comparison operator to use.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
Value date-time

Custom date field value.

Custom Date 1.Operator
_operator string

The comparison operator to use.

Custom Date 2
Value date-time

Custom date field value.

Custom Date 2.Operator
_operator string

The comparison operator to use.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Description
Description string

Term description.

End Booking Reason ID
End_BookingReasonID integer

Pointer to the end booking reason record.

Entry Status Enum
EntryStatusEnum string

Entry status.

ETA
ETA string

Minutes since midnight for estimated time of arrival.

ETD
ETD string

Minutes since midnight for estimated time of departure.

Housekeeping ID
HousekeepingID integer

Pointer to the house-keeping record.

Record Type Enum
RecordTypeEnum string

Record type.

Room Location Fixed
RoomLocationFixed boolean

Fixed room location.

Room Location ID
RoomLocationID integer

Pointer to the address room location record.

Room Rate Amount
RoomRateAmount double

Room rate amount.

Room Rate ID
RoomRateID integer

Pointer to the room rate record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Start Booking Reason ID
Start_BookingReasonID integer

Pointer to the start booking reason record.

Term ID
TermID integer

Pointer to the term record.

Term Session Code
TermSessionCode string

Term session code.

Term Session ID
TermSessionID integer

Unique ID for this term session record.

Use Active Booking As Template
UseActiveBookingAsTemplate boolean

Indicates if the active booking should be used as a template.

Web Description
WebDescription string

Term Session displayed in PortalX.

Returns

Name Path Type Description
array of object
Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Cancel Booking Default End Reason
CancelBookingDefaultEnd_BookingReasonID integer

The default booking end reason when cancelling a booking.

Cancel Booking Update End Reason
CancelBookingUpdateEndBookingReason_BooleanAskEnum string

Update booking end reason on booking cancel.

Check In Date
CheckInDate string

Date of check-in.

Check In Date Actual Decrease
CheckInDateActualDecrease_BooleanAskEnum string

Update CheckInDateActual if check-in date moves backward (in the past).

Check In Date Actual Increase
CheckInDateActualIncrease_BooleanAskEnum string

Update CheckInDateActual if check-in date moves forward (in the future).

Check In Default Start Reason
CheckInDefaultStart_BookingReasonID integer

The default booking start reason when checking in.

Check In Update Start Reason
CheckInUpdateStartBookingReason_BooleanAskEnum string

Update booking start reason on check-in.

Check Out Date
CheckOutDate string

Date of check-out.

Check Out Date Actual Decrease
CheckOutDateActualDecrease_BooleanAskEnum string

Update CheckOutDateActual if check-in date moves backward (in the past).

Check Out Date Actual Increase
CheckOutDateActualIncrease_BooleanAskEnum string

Update CheckOutDateActual if check-in date moves forward (in the future).

Check Out Default End Reason
CheckOutDefaultEnd_BookingReasonID integer

The default booking end reason when checking out.

Check Out Update End Reason
CheckOutUpdateEndBookingReason_BooleanAskEnum string

Update booking end reason on check-out.

Contract Date Check In Decrease
ContractDateCheckInDecrease_BooleanAskEnum string

Update Charge Dates if check-in date moves backward (in the past).

Contract Date Check In Increase
ContractDateCheckInIncrease_BooleanAskEnum string

Update Charge Dates if check-in date moves forward (in the future).

Contract Date Check Out Decrease
ContractDateCheckOutDecrease_BooleanAskEnum string

Update Charge Dates if check-out date moves backward (in the past).

Contract Date Check Out Increase
ContractDateCheckOutIncrease_BooleanAskEnum string

Update Charge Dates if check-out date moves forward (in the future).

Contract Date End
ContractDateEnd string

Date of contract end.

Contract Date Start
ContractDateStart string

Date of contract start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date Modified
DateModified string

Date record was last modified.

Description
Description string

Term description.

End Booking Reason ID
End_BookingReasonID integer

Pointer to the end booking reason record.

Entry Status Enum
EntryStatusEnum string

Entry status.

ETA
ETA string

Date and time of estimated arrival.

ETD
ETD string

Date and time of estimated departure.

Housekeeping ID
HousekeepingID integer

Pointer to the house-keeping record.

Record Type Enum
RecordTypeEnum string

Record type.

Room Location Fixed
RoomLocationFixed boolean

Fixed room location.

Room Location ID
RoomLocationID integer

Pointer to the address room location record.

Room Rate Amount
RoomRateAmount double

Room rate amount.

Room Rate ID
RoomRateID integer

Pointer to the room rate record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.'

Start Booking Reason ID
Start_BookingReasonID integer

Pointer to the start booking reason record.

Term ID
TermID integer

Pointer to the term record.

Term Session Code
TermSessionCode string

Term session code.

Term Session ID
TermSessionID integer

Unique ID for this term session record.

Use Active Booking As Template
UseActiveBookingAsTemplate boolean

Indicates if the active booking should be used as a template.

Web Description
WebDescription string

Term Session displayed in PortalX.

Get Transaction

Retrieves one or more records from the Transaction table.

Parameters

Name Key Required Type Description
Empty Array on No Result
_returnEmptyArrayOnNoResult boolean

Determines whether an empty array should be returned when there is no result.

Page Size
_pageSize True integer

Maximum number of records to return.

Page Index
_pageIndex True integer

Index of the first record to return.

Order By
_orderby string

Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2).

Amount
Amount double

The total amount for this transaction (including tax).

Call Type Enum
CallTypeEnum string

Call type.

Charge Group ID
ChargeGroupID integer

Pointer to the charge group record.

Charge Item ID
ChargeItemID integer

Pointer to the charge item record.

Comments
Comments string

Transaction comments.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the created by security user record.

Date Modified
Value date-time

Date record was last modified.

Date Modified.Operator
_operator string

The comparison operator to use.

Description
Description string

Transaction description.

Due Date
Value date-time

Due date.

Due Date.Operator
_operator string

The comparison operator to use.

Duration
Duration integer

Phone call duration in seconds.

End Of Session ID
EndOfSessionID integer

Pointer to the end of session record.

Entry ID
EntryID integer

Pointer to the entry record.

Excess
Excess double

Excess amount.

Extension
Extension integer

Extension qty.

External ID
ExternalID integer

Stores the (unique) ID from an external system - for imported transactions.

External Receipt ID
ExternalReceiptID string

Pointer to the external receipt record.

Invoice ID
InvoiceID integer

Pointer to the invoice record.

Paid From
Value date-time

Paid from date.

Paid From.Operator
_operator string

The comparison operator to use.

Paid To
Value date-time

Paid to date.

Paid To.Operator
_operator string

The comparison operator to use.

Payment ID
PaymentID integer

Pointer to the payment record.

Processed Date
Value date-time

Date transaction was processed.

Processed Date.Operator
_operator string

The comparison operator to use.

Reference Booking ID
Reference_BookingID integer

The booking (if any) that this transaction relates to.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Table ID
TableID integer

Link to a referencing record (e.g. a BookingID for pro-rating).

Table Name
TableName string

Reference link table.

Tag
Tag string

Transaction tag.

Tag Finance
TagFinance string

Finance tag.

Tax Amount
TaxAmount double

Tax amount

Tax Amount 2
TaxAmount2 double

Tax amount

Tax Amount 3
TaxAmount3 double

Tax amount

Term Session ID
TermSessionID integer

Pointer to the term session record.

Transaction Date
Value date-time

Date of the transaction.

Transaction Date.Operator
_operator string

The comparison operator to use.

Transaction ID
TransactionID integer

Unique ID for this transaction record.

Transaction Type Enum
TransactionTypeEnum string

Transaction type.

Returns

Name Path Type Description
array of object
Amount
Amount double

The total amount for this transaction (including tax).

Call Type Enum
CallTypeEnum string

Call type.

Charge Group ID
ChargeGroupID integer

Pointer to the charge group record.

Charge Item ID
ChargeItemID integer

Pointer to the charge item record.

Comments
Comments string

Transaction comments.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the created by security user record.

Date Modified
DateModified string

Date record was last modified.

Description
Description string

Transaction description.

Due Date
DueDate string

Due date.

Duration
Duration integer

Phone call duration in seconds.

End Of Session ID
EndOfSessionID integer

Pointer to the end of session record.

Entry ID
EntryID integer

Pointer to the entry record.

Excess
Excess double

Excess amount.

Extension
Extension integer

Extension qty.

External ID
ExternalID integer

Stores the (unique) ID from an external system - for imported transactions.

External Receipt ID
ExternalReceiptID string

Pointer to the external receipt record.

Invoice ID
InvoiceID integer

Pointer to the invoice record.

Paid From
PaidFrom string

Paid from date.

Paid To
PaidTo string

Paid to date.

Payment ID
PaymentID integer

Pointer to the payment record.

Processed Date
ProcessedDate string

Date transaction was processed.

Reference Booking ID
Reference_BookingID integer

The booking (if any) that this transaction relates to.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Table ID
TableID integer

Link to a referencing record (e.g. a BookingID for pro-rating).

Table Name
TableName string

Reference link table.

Tag
Tag string

Transaction tag.

Tag Finance
TagFinance string

Finance tag.

Tax Amount
TaxAmount double

Tax amount

Tax Amount 2
TaxAmount2 double

Tax amount

Tax Amount 3
TaxAmount3 double

Tax amount

Term Session ID
TermSessionID integer

Pointer to the term session record.

Transaction Date
TransactionDate string

Date of the transaction.

Transaction ID
TransactionID integer

Unique ID for this transaction record.

Transaction Type Enum
TransactionTypeEnum string

Transaction type.

Update Booking

Updates an existing record in the Booking table.

Parameters

Name Key Required Type Description
Booking ID
BookingID True integer

The ID of the Booking record to update.

Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
CheckInDate date-time

Main (contract) check-in date.

Check-In Date Actual
CheckInDateActual date-time

Actual date the entry arrives.

Check-Out Date
CheckOutDate date-time

Main (contract) check-out date.

Check-Out Date Actual
CheckOutDateActual date-time

Actual date the entry departs.

Comments
Comments string

Comments

Contract Date End
ContractDateEnd date-time

Contact chargeable date end.

Contract Date Start
ContractDateStart date-time

Contact chargeable date start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom Date 3
CustomDate3 date-time

Custom date field value.

Custom Date 4
CustomDate4 date-time

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
DateBilled date-time

Date when this booking was processed for billing.

Date Charged To
DateChargedTo date-time

Date this booking has been charged up to (using reservation charges).

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA date-time

Date and time of estimated arrival.

ETD
ETD date-time

Date and time of estimated departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
PaidTo date-time

Date the booking is paid to.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Returns

Name Path Type Description
Additional Occupant Count
AdditionalOccupantCount integer

The number of additional human occupants in this booking.

Auto Allocation Detail
AutoAllocationDetail string

Details of the auto allocation.

Booking ID
BookingID integer

Unique ID for this booking record.

Booking Link Type Enum
BookingLinkTypeEnum string

Booking link type.

Booking Type ID
BookingTypeID integer

Pointer to the booking type record.

Check-In Date
CheckInDate string

Main (contract) check-in date.

Check-In Date Actual
CheckInDateActual string

Actual date the entry arrives.

Check-Out Date
CheckOutDate string

Main (contract) check-out date.

Check-Out Date Actual
CheckOutDateActual string

Actual date the entry departs.

Comments
Comments string

Comments

Contract Date End
ContractDateEnd string

Contact chargeable date end.

Contract Date Start
ContractDateStart string

Contact chargeable date start.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Custom String 7
CustomString7 string

Custom string field value.

Custom String 8
CustomString8 string

Custom string field value.

Custom String 9
CustomString9 string

Custom string field value.

Custom String 10
CustomString10 string

Custom string field value.

Date Billed
DateBilled string

Date when this booking was processed for billing.

Date Charged To
DateChargedTo string

Date this booking has been charged up to (using reservation charges).

Date Modified Billing
DateModifiedBilling string

Indicates when critical booking fields are modified.

Emotional Support Animal Count
EmotionalSupportAnimalCount integer

The number of additional Emotional Support Animal occupants in this booking.

End Booking Reason ID
End_BookingReasonID integer

The reason this booking finished.

Entry ID
EntryID integer

Pointer to the entry record.

Entry Invitation ID
EntryInvitationID integer

Identifies the entry invitation that the booking is created for.

Entry Status Enum
EntryStatusEnum string

The status of the booking.

ETA
ETA string

Date and time of estimated arrival.

ETD
ETD string

Date and time of estimated departure.

Excess
Excess double

Amount of excess.

Group ID
GroupID integer

Pointer to the group record.

Housekeeping ID
HousekeepingID integer

The housekeeping rules that should be applied to this booking.

Number Of Children
NumberOfChildren integer

The number of children in the booking.

Number Of Children Free
NumberOfChildrenFree integer

The number of children that are free to stay.

Number Of Guests
NumberOfGuests integer

The number of guests in the booking.

Number Of Guests Free
NumberOfGuestsFree integer

The number of guests that are free to stay.

Paid To
PaidTo string

Date the booking is paid to.

Pet Count
PetCount integer

The number of additional pet occupants in this booking.

Resv Charge To Entry
ResvChargeToEntry boolean

Whether reservation charges are charged to the entry or group master account.

Room Location Fixed
RoomLocationFixed boolean

Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.

Room Location ID
RoomLocationID integer

Pointer to the room location record.

Room Rate Amount
RoomRateAmount double

Actual dollar amount of room rate.

Room Rate ID
RoomRateID integer

Selected room rate.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Type ID
RoomTypeID integer

Pointer to the room type record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Service Animal Count
ServiceAnimalCount integer

The number of additional Service Animal occupants in this booking.

Special Requirement
SpecialRequirement string

Special requirements for this booking.

Start Booking Reason ID
Start_BookingReasonID integer

Reason for this booking (normal, room change etc.).

Term Session ID
TermSessionID integer

Pointer to the term session record.

Update Entry

Updates an existing record in the Entry table.

Parameters

Name Key Required Type Description
Entry ID
EntryID True integer

The ID of the Entry record to update.

Address Type ID
AddressTypeID integer

Address type of the entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
DOB date-time

Date of birth.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
LastCheckInOutDate date-time

The last date a check-in or check-out was performed.

Name First
NameFirst string

The first or given name of the entry.

Name Initials
NameInitials string

Name initials.

Name Last
NameLast string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Password
Password password

Password

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

The email that is used by the student to login to the portal.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing User.

Returns

Name Path Type Description
Address Type ID
AddressTypeID integer

Pointer to this entry's active address record.

Birth Gender Enum
Birth_GenderEnum string

The gender of the entry at birth.

Booking ID
BookingID integer

Pointer to the active booking record.

Category ID
CategoryID integer

The category that the entry belongs to.

Conference Email
ConferenceEmail string

The email that is used to identify a student through Conference registration.

Contact ID
ContactID integer

Pointer to the contact record.

Directory Flag Privacy
DirectoryFlagPrivacy boolean

Determines if the entry has elected to remain private.

DOB
DOB string

Date of birth.

Entry Application ID
EntryApplicationID integer

Pointer to the active application record.

Entry ID
EntryID integer

Unique ID for this Entry field.

Entry Status Enum
EntryStatusEnum string

The status of the entry.

Event ID
EventID integer

Pointer to the event record.

Gender Enum
GenderEnum string

Entry gender.

ID1
ID1 string

Generic ID field.

ID2
ID2 string

Generic ID field.

ID3
ID3 string

Generic ID field.

ID4
ID4 integer

Generic ID field.

ID5
ID5 integer

Generic ID field.

Last Check In Out Date
LastCheckInOutDate string

The last date a check-in or check-out was performed.

Name First
NameFirst string

The first or given name of the entry.

Name Initials
NameInitials string

Name initials.

Name Last
NameLast string

The surname, family name or last name of the entry.

Name Other
NameOther string

Alternative name.

Name Preferred
NamePreferred string

Preferred name.

Name Sharer
NameSharer string

Additional occupant name.

Name Title
NameTitle string

The title or salutation of the entry.

Name Web
NameWeb string

A name to display for this entry on the Web.

Password
Password string

Password

Pin Number
PinNumber integer

Personal Identification Number.

Portal Auth Provider User ID
PortalAuthProviderUserID string

User identification used to identify the entry in PortalX. This could be an email, username or other identifier.

Portal Email
PortalEmail string

The email that is used by the student to login to the portal.

Position
Position string

Entry position in the institution.

Previous Entry Status Enum
Previous_EntryStatusEnum string

The previous entry status.

Tax Exemption Enum
TaxExemptionEnum string

Tax exemption.

Testing
Testing boolean

Testing User.

Update Entry Address

Updates an existing record in the Entry Address table.

Parameters

Name Key Required Type Description
Entry Address ID
EntryAddressID True integer

The ID of the Entry Address record to update.

Active Date End
ActiveDateEnd date-time

End active date.

Active Date Start
ActiveDateStart date-time

Date when this address becomes active.

Address Type ID
AddressTypeID integer

Pointer to the address type record.

City
City string

City

Comments
Comments string

Address comments.

Contact Name
ContactName string

Contact name.

Contact Name 2
ContactName2 string

Contact name 2.

Country ID
CountryID integer

Pointer to the country record.

Email
Email string

Email

Entry ID
EntryID integer

Pointer to the entry record.

Phone
Phone string

Phone

Phone Mobile Cell
PhoneMobileCell string

Mobile/Cell

Phone Other
PhoneOther string

Alternative phone.

Phone Other 2
PhoneOther2 string

Alternative phone 2.

Reference
Reference string

Reference

Relationship
Relationship string

Relationship this address has to the entry.

Salutation
Salutation string

Salutation

State Province
StateProvince string

State/Province

Street
Street string

Street

Street 2
Street2 string

Street

Zip Postcode
ZipPostcode string

Zip/Postcode

Returns

Name Path Type Description
Active Date End
ActiveDateEnd string

End active date.

Active Date Start
ActiveDateStart string

Date when this address becomes active.

Address Type ID
AddressTypeID integer

Pointer to the address type record.

City
City string

City

Comments
Comments string

Address comments.

Contact Name
ContactName string

Contact name.

Contact Name 2
ContactName2 string

Contact name 2.

Country ID
CountryID integer

Pointer to the country record.

Email
Email string

Email

Entry Address ID
EntryAddressID integer

Unique ID for this entry address record.

Entry ID
EntryID integer

Pointer to the entry record.

Phone
Phone string

Phone

Phone Mobile Cell
PhoneMobileCell string

Mobile/Cell

Phone Other
PhoneOther string

Alternative phone.

Phone Other 2
PhoneOther2 string

Alternative phone 2.

Reference
Reference string

Reference

Relationship
Relationship string

Relationship this address has to the entry.

Salutation
Salutation string

Salutation

State Province
StateProvince string

State/Province

Street
Street string

Street

Street 2
Street2 string

Street

Zip Postcode
ZipPostcode string

Zip/Postcode

Update Entry Application

Updates an existing record in the Entry Application table.

Parameters

Name Key Required Type Description
Entry Application ID
EntryApplicationID True integer

The ID of the Entry Application record to update.

Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
ApplicationDate date-time

Date of application.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
CancelDate date-time

Cancellation date.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
CompleteDate date-time

Completion date.

Contract Signed Date
ContractSignedDate date-time

Date contract was signed.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom Date 3
CustomDate3 date-time

Custom date field value.

Custom Date 4
CustomDate4 date-time

Custom date field value.

Entry ID
EntryID integer

Pointer to the entry record.

Enquiry Date
EnquiryDate date-time

Date of enquiry.

Expected Arrival Date
ExpectedArrivalDate date-time

Date entry is expected to arrive.

Expected Arrival Date Latest
ExpectedArrivalDateLatest date-time

Latest expected arrival date.

Expected Departure Date
ExpectedDepartureDate date-time

Date entry is expected to depart.

Offered Date
OfferedDate date-time

Date application was offered.

Offer Reply Date
OfferReplyDate date-time

Date offer was replied to.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
OfferSentDate date-time

Date offer sent.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
ReceivedDate date-time

Date received.

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received deposit.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent deposit payment that was attempted.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
ReceivedDepositDate date-time

Date deposit was received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
ReceivedFeeDate date-time

Date fee was received.

Received Photo Date
ReceivedPhotoDate date-time

Date photo was received.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

RoomMate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

RoomMate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

RoomMate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Returns

Name Path Type Description
Allocate Option Enum
AllocateOptionEnum string

Allocate option.

Application Date
ApplicationDate string

Date of application.

Application Status ID
ApplicationStatusID integer

Pointer to the application status record.

Cancel Date
CancelDate string

Cancellation date.

Classification ID
ClassificationID integer

Pointer to the classification record.

Comments
Comments string

Application comments.

Comments Internal
CommentsInternal string

Internal comments.

Complete Date
CompleteDate string

Completion date.

Contract Signed Date
ContractSignedDate string

Date contract was signed.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Bit 3
CustomBit3 boolean

Custom boolean field value.

Custom Bit 4
CustomBit4 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom Date 3
CustomDate3 string

Custom date field value.

Custom Date 4
CustomDate4 string

Custom date field value.

Entry Application ID
EntryApplicationID integer

Unique ID for this entry application record.

Entry ID
EntryID integer

Pointer to the entry record.

Enquiry Date
EnquiryDate string

Date of enquiry.

Expected Arrival Date
ExpectedArrivalDate string

Date entry is expected to arrive.

Expected Arrival Date Latest
ExpectedArrivalDateLatest string

Latest expected arrival date.

Expected Departure Date
ExpectedDepartureDate string

Date entry is expected to depart.

Offered Date
OfferedDate string

Date application was offered.

Offer Reply Date
OfferReplyDate string

Date offer was replied to.

Offer Reply Enum
OfferReplyEnum string

Offer reply.

Offer Reply Reason
OfferReplyReason string

Offer reply reason.

Offer Sent Date
OfferSentDate string

Date offer sent.

Portal Tracking Only
PortalTrackingOnly boolean

Whether this application is just for the portal to track progress.

Preference Comments
PreferenceComments string

Preference comments.

Rating
Rating string

Application rating.

Received Date
ReceivedDate string

Date received.

Received Deposit
ReceivedDeposit boolean

Indicates if the deposit has been received.

Received Deposit Payment ID
ReceivedDeposit_PaymentID integer

Pointer to the payment record for the received deposit.

Received Deposit Web Payment ID
ReceivedDeposit_WebPaymentID integer

Most recent deposit payment that was attempted.

Received Deposit Amount
ReceivedDepositAmount double

Received deposit amount.

Received Deposit Date
ReceivedDepositDate string

Date deposit was received.

Received Deposit Waived
ReceivedDepositWaived boolean

Date deposit was waived.

Received Fee
ReceivedFee boolean

Indicates if the fee has been received.

Received Fee Payment ID
ReceivedFee_PaymentID integer

Pointer to the payment record for the received fee.

Received Fee Web Payment ID
ReceivedFee_WebPaymentID integer

Most recent fee payment that was attempted.

Received Fee Amount
ReceivedFeeAmount double

Received fee amount.

Received Fee Date
ReceivedFeeDate string

Date fee was received.

Received Photo Date
ReceivedPhotoDate string

Date photo was received.

Returning
Returning boolean

Indicates if the entry has been here before and is returning.

RoomMate Description
RoomMateDescription string

Description the applicant can write which is displayed in the roommate module.

Roommate Group ID
RoommateGroupID integer

Pointer to the Roommate group record.

RoomMate Group Sort Order
RoomMateGroupSortOrder integer

Order that group members should be processed in.

RoomMate Show In Search
RoomMateShowInSearch boolean

Whether to include this applicant in roommate searches.

Room Preference Comments
RoomPreferenceComments string

Room preference comments.

Room Selection Number
RoomSelectionNumber integer

Room selection number.

Room Selection Timeslot
RoomSelectionTimeslot string

Room selection timeslot.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Term ID
TermID integer

Defines the period this application is for.

Web
Web boolean

Indicates if this application was created on the web.

Update Entry Custom Field

Updates an existing record in the Entry Custom Field table.

Parameters

Name Key Required Type Description
Entry Custom Field ID
EntryCustomFieldID True integer

The ID of the Entry Custom Field record to update.

Custom Field Definition ID
CustomFieldDefinitionID integer

Pointer to the custom field definition record.

Entry ID
EntryID integer

Pointer to the entry record.

Field DataType Enum
FieldDataTypeEnum string

Field data type.

Value Boolean
ValueBoolean boolean

Boolean value.

Value Date
ValueDate date-time

Date value.

Value Integer
ValueInteger integer

Integer value.

Value Money
ValueMoney double

Money value.

Value String
ValueString string

String value.

Returns

Name Path Type Description
Custom Field Definition ID
CustomFieldDefinitionID integer

Pointer to the custom field definition record.

Entry Custom Field ID
EntryCustomFieldID integer

Unique ID for this entry custom field record.

Entry ID
EntryID integer

Pointer to the entry record.

Field DataType Enum
FieldDataTypeEnum string

Field data type.

Value Boolean
ValueBoolean boolean

Boolean value.

Value Date
ValueDate string

Date value.

Value Integer
ValueInteger integer

Integer value.

Value Money
ValueMoney double

Money value.

Value String
ValueString string

String value.

Update Entry Detail

Updates an existing record in the Entry Detail table.

Parameters

Name Key Required Type Description
Entry Detail ID
EntryDetailID True integer

The ID of the Entry Detail record to update.

Academic Hold
AcademicHold boolean

Indicates if the academic hold flag has been set.

Account Payment Type ID
Account_PaymentTypeID integer

Pointer to the preferred payment type record.

Account Bank Name
AccountBankName string

Account bank name.

Account Bank Number
AccountBankNumber string

Account bank number.

Account Code
AccountCode string

Account code.

Account Comments
AccountComments string

Account comments.

Account Detail 1
AccountDetail1 string

Account detail.

Account Detail 2
AccountDetail2 string

Account detail.

Account Detail 3
AccountDetail3 string

Account detail.

Account Detail 4
AccountDetail4 string

Account detail.

Account Date Paid To
AccountDueDate date-time

Paid to date.

Account Hold
AccountHold boolean

Indicates if the account hold flag has been set.

Athlete
Athlete boolean

Indicates if the athlete flag has been set.

Athlete Team
AthleteTeam string

Athlete team.

Attendee Status Enum
AttendeeStatusEnum string

Attendee status.

Career
Career string

Intended career.

Career Comments
CareerComments string

Reasons for choosing intended career.

Citizenship Country ID
Citizenship_CountryID integer

Pointer to the citizenship record.

Classification ID
ClassificationID integer

Pointer to the classification record.

Classification Override
ClassificationOverride boolean

Classification override.

Comments
Comments string

Comments.

Country Of Birth Country ID
CountryOfBirth_CountryID integer

Pointer to the country of birth record.

Country Of Residence Country ID
CountryOfResidence_CountryID integer

Pointer to the country of residence record.

Cumulative GPA
CumulativeGPA double

Cumulative GPA.

Cumulative Hours
CumulativeHours double

Cumulative hours.

Current GPA
CurrentGPA double

Current GPA.

Current Hours
CurrentHours double

Current hours.

Current Major
CurrentMajor string

The major chosen by the Entry.

Current Minor
CurrentMinor string

The minor chosen by the Entry.

Date Entry
DateEntry date-time

Entry date.

Date Exit
DateExit date-time

Exit date.

Deceased
Deceased boolean

Indicates if the Entry is deceased.

Deceased Date
DeceasedDate date-time

Deceased date.

Dietary
Dietary string

Dietary requirements.

Disability
Disability string

Disability.

Employment Details
EmploymentDetails string

Employment details.

Enrollment Class
EnrollmentClass string

First year, freshman, sophomore, etc.

Enrollment Level
EnrollmentLevel string

Undergraduate, post graduate, etc.

Enrollment Status
EnrollmentStatus string

Newly admitted, current, active, etc.

Enrollment Term
EnrollmentTerm string

Spring, fall, post graduate, etc.

Enrollment Year
EnrollmentYear integer

Year/Level of enrollment.

Entry ID
EntryID integer

Pointer to the entry record.

Ethnicity
Ethnicity string

Ethnicity.

Event Registration Fee ID
EventRegistrationFeeID integer

Pointer to the Event registration fee record.

Expected Graduation Date
ExpectedGraduationDate date-time

Expected graduation date.

Financial Comments
FinancialComments string

Financial support comments.

Financial Support ID
FinancialSupportID integer

Pointer to the financial support record.

Hear About Us
HearAboutUs string

How did the Entry hear about us.

Honors Indicator
HonorsIndicator boolean

Honors indicator.

Immunizations Hold
ImmunizationsHold boolean

Immunizations hold.

Incident Hold
IncidentHold boolean

Incident hold.

Incident Hold Comments
IncidentHoldComments string

Incident hold comments.

International
International boolean

Indicates if the Entry is considered an international student.

International Details
InternationalDetails string

International details.

Living With Dependents
LivingWithDependents boolean

Living with dependents.

Married
Married boolean

Indicates if the Entry is married.

Medical
Medical string

Medical details.

Nationality ID
NationalityID integer

Pointer to the nationality record.

Occupation
Occupation string

Occupation.

Photo Path
PhotoPath string

Photo path.

Previous Member Name
PreviousMemberName string

Previous member name.

Previous Member Relationship
PreviousMemberRelationship string

Previous member relationship.

Previous Membership
PreviousMembership string

Previous membership.

Previous Membership Years
PreviousMembershipYears string

Previous membership years.

Previous Member Years
PreviousMemberYears string

Previous member years.

Profile Interests
ProfileInterests string

Profile interests.

Region Of Birth ID
RegionOfBirthID integer

Pointer to the region of birth record.

Religion
Religion string

Religion.

Residency
Residency string

Residency.

Resident Status
ResidentStatus string

Resident status.

Resident Year
ResidentYear integer

Resident year.

Situation Response Comments
SituationResponseComments string

Situation response comments.

Situation Response Detail
SituationResponseDetail string

Situation response detail.

Situation Response Enum
SituationResponseEnum string

Situation response.

Situation Response Expiry Date
SituationResponseExpiryDate date-time

The date when the response ends (e.g because the emergency is over)

Situation Response Modified Date
SituationResponseModifiedDate date-time

The date the response was last modified.

Situation Response Situation
SituationResponseSituation string

Situation response situation.

Special Needs
SpecialNeeds string

Special needs.

Staff ID
StaffID integer

Pointer to the staff record.

Uses Screen Reader
UsesScreenReader boolean

Uses screen reader.

Vehicle Details
VehicleDetails string

Vehicle details.

Vehicle Permit
VehiclePermit string

Vehicle permit.

Vehicle Registration
VehicleRegistration string

Vehicle registration.

Veteran Status
VeteranStatus string

Veteran status.

Visa
Visa boolean

Indicates if the Entry holds a visa.

Visa Details
VisaDetails string

Visa details.

Visitor Hold
VisitorHold boolean

Visitor hold.

Returns

Name Path Type Description
Academic Hold
AcademicHold boolean

Indicates if the academic hold flag has been set.

Account Payment Type ID
Account_PaymentTypeID integer

Pointer to the preferred payment type record.

Account Bank Name
AccountBankName string

Account bank name.

Account Bank Number
AccountBankNumber string

Account bank number.

Account Code
AccountCode string

Account code.

Account Comments
AccountComments string

Account comments.

Account Detail 1
AccountDetail1 string

Account detail.

Account Detail 2
AccountDetail2 string

Account detail.

Account Detail 3
AccountDetail3 string

Account detail.

Account Detail 4
AccountDetail4 string

Account detail.

Account Date Paid To
AccountDueDate string

Paid to date.

Account Hold
AccountHold boolean

Indicates if the account hold flag has been set.

Athlete
Athlete boolean

Indicates if the athlete flag has been set.

Athlete Team
AthleteTeam string

Athlete team.

Attendee Status Enum
AttendeeStatusEnum string

Attendee status.

Career
Career string

Intended career.

Career Comments
CareerComments string

Reasons for choosing intended career.

Citizenship Country ID
Citizenship_CountryID integer

Pointer to the citizenship record.

Classification ID
ClassificationID integer

Pointer to the classification record.

Classification Override
ClassificationOverride boolean

Classification override.

Comments
Comments string

Comments.

Country Of Birth Country ID
CountryOfBirth_CountryID integer

Pointer to the country of birth record.

Country Of Residence Country ID
CountryOfResidence_CountryID integer

Pointer to the country of residence record.

Cumulative GPA
CumulativeGPA double

Cumulative GPA.

Cumulative Hours
CumulativeHours double

Cumulative hours.

Current GPA
CurrentGPA double

Current GPA.

Current Hours
CurrentHours double

Current hours.

Current Major
CurrentMajor string

The major chosen by the Entry.

Current Minor
CurrentMinor string

The minor chosen by the Entry.

Date Entry
DateEntry string

Entry date.

Date Exit
DateExit string

Exit date.

Deceased
Deceased boolean

Indicates if the Entry is deceased.

Deceased Date
DeceasedDate string

Deceased date.

Dietary
Dietary string

Dietary requirements.

Disability
Disability string

Disability.

Employment Details
EmploymentDetails string

Employment details.

Enrollment Class
EnrollmentClass string

First year, freshman, sophomore, etc.

Enrollment Level
EnrollmentLevel string

Undergraduate, post graduate, etc.

Enrollment Status
EnrollmentStatus string

Newly admitted, current, active, etc.

Enrollment Term
EnrollmentTerm string

Spring, fall, post graduate, etc.

Enrollment Year
EnrollmentYear integer

Year/Level of enrollment.

Entry Detail ID
EntryDetailID integer

Unique ID for this entry detail record.

Entry ID
EntryID integer

Pointer to the entry record.

Ethnicity
Ethnicity string

Ethnicity.

Event Registration Fee ID
EventRegistrationFeeID integer

Pointer to the event registration fee record.

Expected Graduation Date
ExpectedGraduationDate string

Expected graduation date.

Financial Comments
FinancialComments string

Financial support comments.

Financial Support ID
FinancialSupportID integer

Pointer to the financial support fee record.

Hear About Us
HearAboutUs string

How did the Entry hear about us.

Honors Indicator
HonorsIndicator boolean

Honors indicator.

Immunizations Hold
ImmunizationsHold boolean

Immunizations hold.

Incident Hold
IncidentHold boolean

Incident hold.

Incident Hold Comments
IncidentHoldComments string

Incident hold comments.

International
International boolean

Indicates if the Entry is considered an international student.

International Details
InternationalDetails string

International details.

Living With Dependents
LivingWithDependents boolean

Living with dependents.

Married
Married boolean

Indicates if the Entry is married.

Medical
Medical string

Medical details.

Nationality ID
NationalityID integer

Pointer to the nationality record.

Occupation
Occupation string

Occupation.

Photo Path
PhotoPath string

Photo path.

Previous Member Name
PreviousMemberName string

Previous member name.

Previous Member Relationship
PreviousMemberRelationship string

Previous member relationship.

Previous Membership
PreviousMembership string

Previous membership.

Previous Membership Years
PreviousMembershipYears string

Previous membership years.

Previous Member Years
PreviousMemberYears string

Previous member years.

Profile Interests
ProfileInterests string

Profile interests.

Region Of Birth ID
RegionOfBirthID integer

Pointer to the region of birth record.

Religion
Religion string

Religion.

Residency
Residency string

Residency.

Resident Status
ResidentStatus string

Resident status.

Resident Year
ResidentYear integer

Resident year.

Situation Response Comments
SituationResponseComments string

Situation response comments.

Situation Response Detail
SituationResponseDetail string

Situation response detail.

Situation Response Enum
SituationResponseEnum string

Situation response.

Situation Response Expiry Date
SituationResponseExpiryDate string

The date when the response ends (e.g. because the emergency is over)

Situation Response Modified Date
SituationResponseModifiedDate string

The date the response was last modified.

Situation Response Situation
SituationResponseSituation string

Situation response situation.

Special Needs
SpecialNeeds string

Special needs.

Staff ID
StaffID integer

Pointer to the staff record.

Uses Screen Reader
UsesScreenReader boolean

Uses screen reader.

Vehicle Details
VehicleDetails string

Vehicle details.

Vehicle Permit
VehiclePermit string

Vehicle permit.

Vehicle Registration
VehicleRegistration string

Vehicle registration.

Veteran Status
VeteranStatus string

Veteran status.

Visa
Visa boolean

Indicates if the Entry holds a visa.

Visa Details
VisaDetails string

Visa details.

Visitor Hold
VisitorHold boolean

Visitor hold.

Update Entry Enrollment

Updates an existing record in the Entry Enrollment table.

Parameters

Name Key Required Type Description
Entry Enrollment ID
EntryEnrollmentID True integer

The ID of the Entry Enrollment record to update.

Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

CourseID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 date-time

Custom date field value.

Custom Date 2
CustomDate2 date-time

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
DateEnd date-time

Date enrollment ends.

Date Start
DateStart date-time

Date enrollment starts.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry ID
EntryID integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
GraduationDate date-time

Date of graduation.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Returns

Name Path Type Description
Campus
Campus string

Campus where entry is enrolled.

Comments
Comments string

Enrollment comments.

Course ID
CourseID integer

Pointer to the course record.

Custom Bit 1
CustomBit1 boolean

Custom boolean field value.

Custom Bit 2
CustomBit2 boolean

Custom boolean field value.

Custom Date 1
CustomDate1 string

Custom date field value.

Custom Date 2
CustomDate2 string

Custom date field value.

Custom String 1
CustomString1 string

Custom string field value.

Custom String 2
CustomString2 string

Custom string field value.

Custom String 3
CustomString3 string

Custom string field value.

Custom String 4
CustomString4 string

Custom string field value.

Custom String 5
CustomString5 string

Custom string field value.

Custom String 6
CustomString6 string

Custom string field value.

Date End
DateEnd string

Date enrollment ends.

Date Start
DateStart string

Date enrollment starts.

Department
Department string

Department entry is enrolled in.

Enrollment Field
EnrollmentField string

Field of enrollment.

Enrollment Order
EnrollmentOrder integer

Enrollment order.

Enrollment Type Enum
EnrollmentTypeEnum string

Enrollment type.

Entry Enrollment ID
EntryEnrollmentID integer

Unique ID for this entry enrollment record.

Entry ID
EntryID integer

Pointer to the entry record.

Faculty
Faculty string

Course faculty.

Full Time
FullTime boolean

Indicates if the entry is enrolled full time.

Graduation Date
GraduationDate string

Date of graduation.

Institution
Institution string

Course institution.

Is Enrolled
IsEnrolled boolean

Indicates if the entry is enrolled.

Major
Major string

Course Major.

Major Category
MajorCategory string

Major category.

Minor
Minor string

Course Minor.

Post Grad
PostGrad boolean

Indicates if this is a post graduate course.

Sequence
Sequence integer

Sequence

Subjects
Subjects string

The subjects the entry is enrolled in.

Term ID
TermID integer

Pointer to the term record.

Years
Years string

Years enrolled.

Update Room Space Maintenance

Updates an existing record in the Room Space Maintenance table.

Parameters

Name Key Required Type Description
Room Space Maintenance ID
RoomSpaceMaintenanceID True integer

The ID of the Room Space Maintenance record to update.

Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
CompleteDate date-time

Complete date.

Contact ID
ContactID integer

Pointer to the contact record.

Contract Date
ContractDate date-time

Contract date.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
ContractorDate date-time

Contractor date.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
CustomDate1 date-time

Custom date 1.

Custom Date 2
CustomDate2 date-time

Custom date 2.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Due
DateDue date-time

Date due.

Date Reported
DateReported date-time

Date reported.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
StartDate date-time

Start date.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Returns

Name Path Type Description
Account Code
AccountCode string

Account code.

Cause
Cause string

Cause.

Charge
Charge boolean

Indicates if a charge should be applied.

Charge Entry ID
Charge_EntryID integer

Pointer to the charge entry record.

Charge Amount
ChargeAmount double

Charge amount.

Charge Invoiced
ChargeInvoiced boolean

Indicates if the charge has been invoiced.

Charge Invoice Number
ChargeInvoiceNumber string

Charge invoice number.

Charge Type
ChargeType string

Charge type.

Complete Date
CompleteDate string

Complete date.

ContactID
ContactID integer

Pointer to the contact record.

Contract Date
ContractDate string

Contract date.

Contractor Cost
ContractorCost double

Contractor cost.

Contractor Cost Estimate
ContractorCostEstimate double

Contractor cost estimate.

Contractor Date
ContractorDate string

Contractor date.

Contractor ETA
ContractorETA string

Contractor ETA.

Contractor Order Number
ContractorOrderNumber string

Contractor order number.

Created By Security User ID
CreatedBy_SecurityUserID integer

Pointer to the security user record.

Custom Bit 1
CustomBit1 boolean

Custom bit 1.

Custom Bit 2
CustomBit2 boolean

Custom bit 2.

Custom Date 1
CustomDate1 string

Custom date 1.

Custom Date 2
CustomDate2 string

Custom date 2.

Custom String 1
CustomString1 string

Custom string 1.

Custom String 2
CustomString2 string

Custom string 2.

Custom String 3
CustomString3 string

Custom string 3.

Custom String 4
CustomString4 string

Custom string 4.

Custom String 5
CustomString5 string

Custom string 5.

Custom String 6
CustomString6 string

Custom string 6.

Date Created
DateCreated string

Date created.

Date Due
DateDue string

Date due.

Date Modified
DateModified string

Date modified.

Date Reported
DateReported string

Date reported.

Description
Description string

Description.

Job Sent
JobSent boolean

Indicates if a job has been sent.

Job Status
JobStatus string

Job status.

Location
Location string

Location.

Occupant Entry ID
Occupant_EntryID integer

Pointer to the occupant entry record.

Occupant Entry Name
OccupantEntryName string

Occupant entry name.

Occupant Present
OccupantPresent boolean

Indicates if an occupant is present.

Occupant Present Reason
OccupantPresentReason string

Occupant present reason.

Other Service Number
OtherServiceNumber string

Other service number.

Priority ID
PriorityID integer

Pointer to the priority record.

Repair Description
RepairDescription string

Repair description.

Reported By Name
ReportedByName string

Reported by name.

Reported By Phone
ReportedByPhone string

Reported by phone.

Room Space Closed ID
RoomSpaceClosedID integer

Pointer to the room space closed record.

Room Space ID
RoomSpaceID integer

Pointer to the room space record.

Room Space Maintenance Category ID
RoomSpaceMaintenanceCategoryID integer

Pointer to the room space maintenance category record.

Room Space Maintenance ID
RoomSpaceMaintenanceID integer

Unique ID for this room space maintenance record.

Room Space Maintenance Item ID
RoomSpaceMaintenanceItemID integer

Pointer to the room space maintenance item record.

Security User ID
SecurityUserID integer

Pointer to the security user record.

Start Date
StartDate string

Start date.

Status
Status string

Status.

Technician
Technician string

Technician.

View On Web
ViewOnWeb boolean

Indicates if the room space maintenance is viewable on the web.

Definitions

object

This is the type 'object'.