Starrezrestv1Client

Classes

SelectEntryInput dataclass

SelectEntryInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, address_type_id: Optional[int] = None, birth_gender_enum: Optional[str] = None, booking_id: Optional[int] = None, category_id: Optional[int] = None, conference_email: Optional[str] = None, contact_id: Optional[int] = None, created_by_security_user_id: Optional[int] = None, date_created: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, directory_flag_privacy: Optional[bool] = None, d_o_b: Optional[Dict[str, Any]] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, entry_status_enum: Optional[str] = None, event_id: Optional[int] = None, gender_enum: Optional[str] = None, i_d1: Optional[str] = None, i_d2: Optional[str] = None, i_d3: Optional[str] = None, i_d4: Optional[int] = None, i_d5: Optional[int] = None, last_check_in_out_date: Optional[Dict[str, Any]] = None, name_first: Optional[str] = None, name_initials: Optional[str] = None, name_last: Optional[str] = None, name_other: Optional[str] = None, name_preferred: Optional[str] = None, name_sharer: Optional[str] = None, name_title: Optional[str] = None, name_web: Optional[str] = None, pin_number: Optional[int] = None, portal_auth_provider_user_id: Optional[str] = None, portal_email: Optional[str] = None, position: Optional[str] = None, previous_entry_status_enum: Optional[str] = None, tax_exemption_enum: Optional[str] = None, testing: Optional[bool] = None)

Get Entry

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Address type of the entry's active address record.

birth_gender_enum class-attribute instance-attribute

birth_gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Birth_GenderEnum'})

The gender of the entry at birth.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Pointer to the active booking record.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

The category that the entry belongs to.

conference_email class-attribute instance-attribute

conference_email: Optional[str] = field(default=None, metadata={'wire_name': 'ConferenceEmail'})

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

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

created_by_security_user_id class-attribute instance-attribute

created_by_security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'CreatedBy_SecurityUserID'})

Pointer to the security user record.

directory_flag_privacy class-attribute instance-attribute

directory_flag_privacy: Optional[bool] = field(default=None, metadata={'wire_name': 'DirectoryFlagPrivacy'})

Determines if the entry has elected to remain private.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Pointer to the active application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Unique ID for this Entry field.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the entry.

event_id class-attribute instance-attribute

event_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventID'})

Pointer to the event record.

gender_enum class-attribute instance-attribute

gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderEnum'})

Entry gender.

i_d1 class-attribute instance-attribute

i_d1: Optional[str] = field(default=None, metadata={'wire_name': 'ID1'})

Generic ID field.

i_d2 class-attribute instance-attribute

i_d2: Optional[str] = field(default=None, metadata={'wire_name': 'ID2'})

Generic ID field.

i_d3 class-attribute instance-attribute

i_d3: Optional[str] = field(default=None, metadata={'wire_name': 'ID3'})

Generic ID field.

i_d4 class-attribute instance-attribute

i_d4: Optional[int] = field(default=None, metadata={'wire_name': 'ID4'})

Generic ID field.

i_d5 class-attribute instance-attribute

i_d5: Optional[int] = field(default=None, metadata={'wire_name': 'ID5'})

Generic ID field.

name_first class-attribute instance-attribute

name_first: Optional[str] = field(default=None, metadata={'wire_name': 'NameFirst'})

The first or given name of the entry.

name_initials class-attribute instance-attribute

name_initials: Optional[str] = field(default=None, metadata={'wire_name': 'NameInitials'})

Name initials.

name_last class-attribute instance-attribute

name_last: Optional[str] = field(default=None, metadata={'wire_name': 'NameLast'})

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

name_other class-attribute instance-attribute

name_other: Optional[str] = field(default=None, metadata={'wire_name': 'NameOther'})

Alternative name.

name_preferred class-attribute instance-attribute

name_preferred: Optional[str] = field(default=None, metadata={'wire_name': 'NamePreferred'})

Preferred name.

name_sharer class-attribute instance-attribute

name_sharer: Optional[str] = field(default=None, metadata={'wire_name': 'NameSharer'})

Additional occupant name.

name_title class-attribute instance-attribute

name_title: Optional[str] = field(default=None, metadata={'wire_name': 'NameTitle'})

The title or salutation of the entry.

name_web class-attribute instance-attribute

name_web: Optional[str] = field(default=None, metadata={'wire_name': 'NameWeb'})

A name to display for this entry on the Web.

pin_number class-attribute instance-attribute

pin_number: Optional[int] = field(default=None, metadata={'wire_name': 'PinNumber'})

Personal Identification Number.

portal_auth_provider_user_id class-attribute instance-attribute

portal_auth_provider_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'PortalAuthProviderUserID'})

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

portal_email class-attribute instance-attribute

portal_email: Optional[str] = field(default=None, metadata={'wire_name': 'PortalEmail'})

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

position class-attribute instance-attribute

position: Optional[str] = field(default=None, metadata={'wire_name': 'Position'})

Entry position in the institution.

previous_entry_status_enum class-attribute instance-attribute

previous_entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Previous_EntryStatusEnum'})

The previous entry status.

tax_exemption_enum class-attribute instance-attribute

tax_exemption_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TaxExemptionEnum'})

Tax exemption.

testing class-attribute instance-attribute

testing: Optional[bool] = field(default=None, metadata={'wire_name': 'Testing'})

Testing User.

CreateEntryInput dataclass

CreateEntryInput(address_type_id: Optional[int] = None, birth_gender_enum: Optional[str] = None, booking_id: Optional[int] = None, category_id: Optional[int] = None, conference_email: Optional[str] = None, contact_id: Optional[int] = None, directory_flag_privacy: Optional[bool] = None, d_o_b: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, entry_status_enum: Optional[str] = None, event_id: Optional[int] = None, gender_enum: Optional[str] = None, i_d1: Optional[str] = None, i_d2: Optional[str] = None, i_d3: Optional[str] = None, i_d4: Optional[int] = None, i_d5: Optional[int] = None, last_check_in_out_date: Optional[str] = None, name_first: Optional[str] = None, name_initials: Optional[str] = None, name_last: Optional[str] = None, name_other: Optional[str] = None, name_preferred: Optional[str] = None, name_sharer: Optional[str] = None, name_title: Optional[str] = None, name_web: Optional[str] = None, password: Optional[str] = None, pin_number: Optional[int] = None, portal_auth_provider_user_id: Optional[str] = None, portal_email: Optional[str] = None, position: Optional[str] = None, previous_entry_status_enum: Optional[str] = None, tax_exemption_enum: Optional[str] = None, testing: Optional[bool] = None)

Create Entry

Attributes

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Address type of the entry's active address record.

birth_gender_enum class-attribute instance-attribute

birth_gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Birth_GenderEnum'})

The gender of the entry at birth.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Pointer to the active booking record.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

The category that the entry belongs to.

conference_email class-attribute instance-attribute

conference_email: Optional[str] = field(default=None, metadata={'wire_name': 'ConferenceEmail'})

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

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

directory_flag_privacy class-attribute instance-attribute

directory_flag_privacy: Optional[bool] = field(default=None, metadata={'wire_name': 'DirectoryFlagPrivacy'})

Determines if the entry has elected to remain private.

d_o_b class-attribute instance-attribute

d_o_b: Optional[str] = field(default=None, metadata={'wire_name': 'DOB'})

Date of birth.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Pointer to the active application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Unique ID for this Entry field.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the entry.

event_id class-attribute instance-attribute

event_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventID'})

Pointer to the event record.

gender_enum class-attribute instance-attribute

gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderEnum'})

Entry gender.

i_d1 class-attribute instance-attribute

i_d1: Optional[str] = field(default=None, metadata={'wire_name': 'ID1'})

Generic ID field.

i_d2 class-attribute instance-attribute

i_d2: Optional[str] = field(default=None, metadata={'wire_name': 'ID2'})

Generic ID field.

i_d3 class-attribute instance-attribute

i_d3: Optional[str] = field(default=None, metadata={'wire_name': 'ID3'})

Generic ID field.

i_d4 class-attribute instance-attribute

i_d4: Optional[int] = field(default=None, metadata={'wire_name': 'ID4'})

Generic ID field.

i_d5 class-attribute instance-attribute

i_d5: Optional[int] = field(default=None, metadata={'wire_name': 'ID5'})

Generic ID field.

last_check_in_out_date class-attribute instance-attribute

last_check_in_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'LastCheckInOutDate'})

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

name_first class-attribute instance-attribute

name_first: Optional[str] = field(default=None, metadata={'wire_name': 'NameFirst'})

The first or given name of the entry.

name_initials class-attribute instance-attribute

name_initials: Optional[str] = field(default=None, metadata={'wire_name': 'NameInitials'})

Name initials.

name_last class-attribute instance-attribute

name_last: Optional[str] = field(default=None, metadata={'wire_name': 'NameLast'})

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

name_other class-attribute instance-attribute

name_other: Optional[str] = field(default=None, metadata={'wire_name': 'NameOther'})

Alternative name.

name_preferred class-attribute instance-attribute

name_preferred: Optional[str] = field(default=None, metadata={'wire_name': 'NamePreferred'})

Preferred name.

name_sharer class-attribute instance-attribute

name_sharer: Optional[str] = field(default=None, metadata={'wire_name': 'NameSharer'})

Additional occupant name.

name_title class-attribute instance-attribute

name_title: Optional[str] = field(default=None, metadata={'wire_name': 'NameTitle'})

The title or salutation of the entry.

name_web class-attribute instance-attribute

name_web: Optional[str] = field(default=None, metadata={'wire_name': 'NameWeb'})

A name to display for this entry on the Web.

password class-attribute instance-attribute

password: Optional[str] = field(default=None, metadata={'wire_name': 'Password'})

Password

pin_number class-attribute instance-attribute

pin_number: Optional[int] = field(default=None, metadata={'wire_name': 'PinNumber'})

Personal Identification Number.

portal_auth_provider_user_id class-attribute instance-attribute

portal_auth_provider_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'PortalAuthProviderUserID'})

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

portal_email class-attribute instance-attribute

portal_email: Optional[str] = field(default=None, metadata={'wire_name': 'PortalEmail'})

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

position class-attribute instance-attribute

position: Optional[str] = field(default=None, metadata={'wire_name': 'Position'})

Entry position in the institution.

previous_entry_status_enum class-attribute instance-attribute

previous_entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Previous_EntryStatusEnum'})

The previous entry status.

tax_exemption_enum class-attribute instance-attribute

tax_exemption_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TaxExemptionEnum'})

Tax exemption.

testing class-attribute instance-attribute

testing: Optional[bool] = field(default=None, metadata={'wire_name': 'Testing'})

Testing User.

CreateEntryResponse dataclass

CreateEntryResponse(address_type_id: Optional[int] = None, birth_gender_enum: Optional[str] = None, booking_id: Optional[int] = None, category_id: Optional[int] = None, conference_email: Optional[str] = None, contact_id: Optional[int] = None, directory_flag_privacy: Optional[bool] = None, d_o_b: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, entry_status_enum: Optional[str] = None, event_id: Optional[int] = None, gender_enum: Optional[str] = None, i_d1: Optional[str] = None, i_d2: Optional[str] = None, i_d3: Optional[str] = None, i_d4: Optional[int] = None, i_d5: Optional[int] = None, last_check_in_out_date: Optional[str] = None, name_first: Optional[str] = None, name_initials: Optional[str] = None, name_last: Optional[str] = None, name_other: Optional[str] = None, name_preferred: Optional[str] = None, name_sharer: Optional[str] = None, name_title: Optional[str] = None, name_web: Optional[str] = None, password: Optional[str] = None, pin_number: Optional[int] = None, portal_auth_provider_user_id: Optional[str] = None, portal_email: Optional[str] = None, position: Optional[str] = None, previous_entry_status_enum: Optional[str] = None, tax_exemption_enum: Optional[str] = None, testing: Optional[bool] = None)

Response for Create Entry

Attributes

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Address type of the entry's active address record.

birth_gender_enum class-attribute instance-attribute

birth_gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Birth_GenderEnum'})

The gender of the entry at birth.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Pointer to the active booking record.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

The category that the entry belongs to.

conference_email class-attribute instance-attribute

conference_email: Optional[str] = field(default=None, metadata={'wire_name': 'ConferenceEmail'})

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

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

directory_flag_privacy class-attribute instance-attribute

directory_flag_privacy: Optional[bool] = field(default=None, metadata={'wire_name': 'DirectoryFlagPrivacy'})

Determines if the entry has elected to remain private.

d_o_b class-attribute instance-attribute

d_o_b: Optional[str] = field(default=None, metadata={'wire_name': 'DOB'})

Date of birth.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Pointer to the active application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Unique ID for this Entry field.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the entry.

event_id class-attribute instance-attribute

event_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventID'})

Pointer to the event record.

gender_enum class-attribute instance-attribute

gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderEnum'})

Entry gender.

i_d1 class-attribute instance-attribute

i_d1: Optional[str] = field(default=None, metadata={'wire_name': 'ID1'})

Generic ID field.

i_d2 class-attribute instance-attribute

i_d2: Optional[str] = field(default=None, metadata={'wire_name': 'ID2'})

Generic ID field.

i_d3 class-attribute instance-attribute

i_d3: Optional[str] = field(default=None, metadata={'wire_name': 'ID3'})

Generic ID field.

i_d4 class-attribute instance-attribute

i_d4: Optional[int] = field(default=None, metadata={'wire_name': 'ID4'})

Generic ID field.

i_d5 class-attribute instance-attribute

i_d5: Optional[int] = field(default=None, metadata={'wire_name': 'ID5'})

Generic ID field.

last_check_in_out_date class-attribute instance-attribute

last_check_in_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'LastCheckInOutDate'})

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

name_first class-attribute instance-attribute

name_first: Optional[str] = field(default=None, metadata={'wire_name': 'NameFirst'})

The first or given name of the entry.

name_initials class-attribute instance-attribute

name_initials: Optional[str] = field(default=None, metadata={'wire_name': 'NameInitials'})

Initials in name.

name_last class-attribute instance-attribute

name_last: Optional[str] = field(default=None, metadata={'wire_name': 'NameLast'})

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

name_other class-attribute instance-attribute

name_other: Optional[str] = field(default=None, metadata={'wire_name': 'NameOther'})

Alternative name.

name_preferred class-attribute instance-attribute

name_preferred: Optional[str] = field(default=None, metadata={'wire_name': 'NamePreferred'})

Preferred name.

name_sharer class-attribute instance-attribute

name_sharer: Optional[str] = field(default=None, metadata={'wire_name': 'NameSharer'})

Additional occupant name.

name_title class-attribute instance-attribute

name_title: Optional[str] = field(default=None, metadata={'wire_name': 'NameTitle'})

The title or salutation of the entry.

name_web class-attribute instance-attribute

name_web: Optional[str] = field(default=None, metadata={'wire_name': 'NameWeb'})

A name to display for this entry on the Web.

password class-attribute instance-attribute

password: Optional[str] = field(default=None, metadata={'wire_name': 'Password'})

Password

pin_number class-attribute instance-attribute

pin_number: Optional[int] = field(default=None, metadata={'wire_name': 'PinNumber'})

Personal Identification Number.

portal_auth_provider_user_id class-attribute instance-attribute

portal_auth_provider_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'PortalAuthProviderUserID'})

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

portal_email class-attribute instance-attribute

portal_email: Optional[str] = field(default=None, metadata={'wire_name': 'PortalEmail'})

Portal email.

position class-attribute instance-attribute

position: Optional[str] = field(default=None, metadata={'wire_name': 'Position'})

Entry position in the institution.

previous_entry_status_enum class-attribute instance-attribute

previous_entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Previous_EntryStatusEnum'})

The previous entry status.

tax_exemption_enum class-attribute instance-attribute

tax_exemption_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TaxExemptionEnum'})

Tax exemption.

testing class-attribute instance-attribute

testing: Optional[bool] = field(default=None, metadata={'wire_name': 'Testing'})

Testing user.

UpdateEntryInput dataclass

UpdateEntryInput(address_type_id: Optional[int] = None, birth_gender_enum: Optional[str] = None, booking_id: Optional[int] = None, category_id: Optional[int] = None, conference_email: Optional[str] = None, contact_id: Optional[int] = None, directory_flag_privacy: Optional[bool] = None, d_o_b: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, entry_status_enum: Optional[str] = None, event_id: Optional[int] = None, gender_enum: Optional[str] = None, i_d1: Optional[str] = None, i_d2: Optional[str] = None, i_d3: Optional[str] = None, i_d4: Optional[int] = None, i_d5: Optional[int] = None, last_check_in_out_date: Optional[str] = None, name_first: Optional[str] = None, name_initials: Optional[str] = None, name_last: Optional[str] = None, name_other: Optional[str] = None, name_preferred: Optional[str] = None, name_sharer: Optional[str] = None, name_title: Optional[str] = None, name_web: Optional[str] = None, password: Optional[str] = None, pin_number: Optional[int] = None, portal_auth_provider_user_id: Optional[str] = None, portal_email: Optional[str] = None, position: Optional[str] = None, previous_entry_status_enum: Optional[str] = None, tax_exemption_enum: Optional[str] = None, testing: Optional[bool] = None)

Update Entry

Attributes

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Address type of the entry's active address record.

birth_gender_enum class-attribute instance-attribute

birth_gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Birth_GenderEnum'})

The gender of the entry at birth.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Pointer to the active booking record.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

The category that the entry belongs to.

conference_email class-attribute instance-attribute

conference_email: Optional[str] = field(default=None, metadata={'wire_name': 'ConferenceEmail'})

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

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

directory_flag_privacy class-attribute instance-attribute

directory_flag_privacy: Optional[bool] = field(default=None, metadata={'wire_name': 'DirectoryFlagPrivacy'})

Determines if the entry has elected to remain private.

d_o_b class-attribute instance-attribute

d_o_b: Optional[str] = field(default=None, metadata={'wire_name': 'DOB'})

Date of birth.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Pointer to the active application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Unique ID for this Entry field.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the entry.

event_id class-attribute instance-attribute

event_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventID'})

Pointer to the event record.

gender_enum class-attribute instance-attribute

gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderEnum'})

Entry gender.

i_d1 class-attribute instance-attribute

i_d1: Optional[str] = field(default=None, metadata={'wire_name': 'ID1'})

Generic ID field.

i_d2 class-attribute instance-attribute

i_d2: Optional[str] = field(default=None, metadata={'wire_name': 'ID2'})

Generic ID field.

i_d3 class-attribute instance-attribute

i_d3: Optional[str] = field(default=None, metadata={'wire_name': 'ID3'})

Generic ID field.

i_d4 class-attribute instance-attribute

i_d4: Optional[int] = field(default=None, metadata={'wire_name': 'ID4'})

Generic ID field.

i_d5 class-attribute instance-attribute

i_d5: Optional[int] = field(default=None, metadata={'wire_name': 'ID5'})

Generic ID field.

last_check_in_out_date class-attribute instance-attribute

last_check_in_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'LastCheckInOutDate'})

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

name_first class-attribute instance-attribute

name_first: Optional[str] = field(default=None, metadata={'wire_name': 'NameFirst'})

The first or given name of the entry.

name_initials class-attribute instance-attribute

name_initials: Optional[str] = field(default=None, metadata={'wire_name': 'NameInitials'})

Name initials.

name_last class-attribute instance-attribute

name_last: Optional[str] = field(default=None, metadata={'wire_name': 'NameLast'})

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

name_other class-attribute instance-attribute

name_other: Optional[str] = field(default=None, metadata={'wire_name': 'NameOther'})

Alternative name.

name_preferred class-attribute instance-attribute

name_preferred: Optional[str] = field(default=None, metadata={'wire_name': 'NamePreferred'})

Preferred name.

name_sharer class-attribute instance-attribute

name_sharer: Optional[str] = field(default=None, metadata={'wire_name': 'NameSharer'})

Additional occupant name.

name_title class-attribute instance-attribute

name_title: Optional[str] = field(default=None, metadata={'wire_name': 'NameTitle'})

The title or salutation of the entry.

name_web class-attribute instance-attribute

name_web: Optional[str] = field(default=None, metadata={'wire_name': 'NameWeb'})

A name to display for this entry on the Web.

password class-attribute instance-attribute

password: Optional[str] = field(default=None, metadata={'wire_name': 'Password'})

Password

pin_number class-attribute instance-attribute

pin_number: Optional[int] = field(default=None, metadata={'wire_name': 'PinNumber'})

Personal Identification Number.

portal_auth_provider_user_id class-attribute instance-attribute

portal_auth_provider_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'PortalAuthProviderUserID'})

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

portal_email class-attribute instance-attribute

portal_email: Optional[str] = field(default=None, metadata={'wire_name': 'PortalEmail'})

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

position class-attribute instance-attribute

position: Optional[str] = field(default=None, metadata={'wire_name': 'Position'})

Entry position in the institution.

previous_entry_status_enum class-attribute instance-attribute

previous_entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Previous_EntryStatusEnum'})

The previous entry status.

tax_exemption_enum class-attribute instance-attribute

tax_exemption_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TaxExemptionEnum'})

Tax exemption.

testing class-attribute instance-attribute

testing: Optional[bool] = field(default=None, metadata={'wire_name': 'Testing'})

Testing User.

UpdateEntryResponse dataclass

UpdateEntryResponse(address_type_id: Optional[int] = None, birth_gender_enum: Optional[str] = None, booking_id: Optional[int] = None, category_id: Optional[int] = None, conference_email: Optional[str] = None, contact_id: Optional[int] = None, directory_flag_privacy: Optional[bool] = None, d_o_b: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, entry_status_enum: Optional[str] = None, event_id: Optional[int] = None, gender_enum: Optional[str] = None, i_d1: Optional[str] = None, i_d2: Optional[str] = None, i_d3: Optional[str] = None, i_d4: Optional[int] = None, i_d5: Optional[int] = None, last_check_in_out_date: Optional[str] = None, name_first: Optional[str] = None, name_initials: Optional[str] = None, name_last: Optional[str] = None, name_other: Optional[str] = None, name_preferred: Optional[str] = None, name_sharer: Optional[str] = None, name_title: Optional[str] = None, name_web: Optional[str] = None, password: Optional[str] = None, pin_number: Optional[int] = None, portal_auth_provider_user_id: Optional[str] = None, portal_email: Optional[str] = None, position: Optional[str] = None, previous_entry_status_enum: Optional[str] = None, tax_exemption_enum: Optional[str] = None, testing: Optional[bool] = None)

Response for Update Entry

Attributes

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Pointer to this entry's active address record.

birth_gender_enum class-attribute instance-attribute

birth_gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Birth_GenderEnum'})

The gender of the entry at birth.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Pointer to the active booking record.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

The category that the entry belongs to.

conference_email class-attribute instance-attribute

conference_email: Optional[str] = field(default=None, metadata={'wire_name': 'ConferenceEmail'})

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

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

directory_flag_privacy class-attribute instance-attribute

directory_flag_privacy: Optional[bool] = field(default=None, metadata={'wire_name': 'DirectoryFlagPrivacy'})

Determines if the entry has elected to remain private.

d_o_b class-attribute instance-attribute

d_o_b: Optional[str] = field(default=None, metadata={'wire_name': 'DOB'})

Date of birth.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Pointer to the active application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Unique ID for this Entry field.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the entry.

event_id class-attribute instance-attribute

event_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventID'})

Pointer to the event record.

gender_enum class-attribute instance-attribute

gender_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderEnum'})

Entry gender.

i_d1 class-attribute instance-attribute

i_d1: Optional[str] = field(default=None, metadata={'wire_name': 'ID1'})

Generic ID field.

i_d2 class-attribute instance-attribute

i_d2: Optional[str] = field(default=None, metadata={'wire_name': 'ID2'})

Generic ID field.

i_d3 class-attribute instance-attribute

i_d3: Optional[str] = field(default=None, metadata={'wire_name': 'ID3'})

Generic ID field.

i_d4 class-attribute instance-attribute

i_d4: Optional[int] = field(default=None, metadata={'wire_name': 'ID4'})

Generic ID field.

i_d5 class-attribute instance-attribute

i_d5: Optional[int] = field(default=None, metadata={'wire_name': 'ID5'})

Generic ID field.

last_check_in_out_date class-attribute instance-attribute

last_check_in_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'LastCheckInOutDate'})

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

name_first class-attribute instance-attribute

name_first: Optional[str] = field(default=None, metadata={'wire_name': 'NameFirst'})

The first or given name of the entry.

name_initials class-attribute instance-attribute

name_initials: Optional[str] = field(default=None, metadata={'wire_name': 'NameInitials'})

Name initials.

name_last class-attribute instance-attribute

name_last: Optional[str] = field(default=None, metadata={'wire_name': 'NameLast'})

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

name_other class-attribute instance-attribute

name_other: Optional[str] = field(default=None, metadata={'wire_name': 'NameOther'})

Alternative name.

name_preferred class-attribute instance-attribute

name_preferred: Optional[str] = field(default=None, metadata={'wire_name': 'NamePreferred'})

Preferred name.

name_sharer class-attribute instance-attribute

name_sharer: Optional[str] = field(default=None, metadata={'wire_name': 'NameSharer'})

Additional occupant name.

name_title class-attribute instance-attribute

name_title: Optional[str] = field(default=None, metadata={'wire_name': 'NameTitle'})

The title or salutation of the entry.

name_web class-attribute instance-attribute

name_web: Optional[str] = field(default=None, metadata={'wire_name': 'NameWeb'})

A name to display for this entry on the Web.

password class-attribute instance-attribute

password: Optional[str] = field(default=None, metadata={'wire_name': 'Password'})

Password

pin_number class-attribute instance-attribute

pin_number: Optional[int] = field(default=None, metadata={'wire_name': 'PinNumber'})

Personal Identification Number.

portal_auth_provider_user_id class-attribute instance-attribute

portal_auth_provider_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'PortalAuthProviderUserID'})

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

portal_email class-attribute instance-attribute

portal_email: Optional[str] = field(default=None, metadata={'wire_name': 'PortalEmail'})

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

position class-attribute instance-attribute

position: Optional[str] = field(default=None, metadata={'wire_name': 'Position'})

Entry position in the institution.

previous_entry_status_enum class-attribute instance-attribute

previous_entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'Previous_EntryStatusEnum'})

The previous entry status.

tax_exemption_enum class-attribute instance-attribute

tax_exemption_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TaxExemptionEnum'})

Tax exemption.

testing class-attribute instance-attribute

testing: Optional[bool] = field(default=None, metadata={'wire_name': 'Testing'})

Testing User.

DeleteResponse dataclass

DeleteResponse(additional_properties: Dict[str, Any] = dict())

Response for Delete

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SelectEntryCustomFieldInput dataclass

SelectEntryCustomFieldInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, custom_field_definition_id: Optional[int] = None, date_modified: Optional[Dict[str, Any]] = None, entry_custom_field_id: Optional[int] = None, entry_id: Optional[int] = None, field_data_type_enum: Optional[str] = None, value_boolean: Optional[bool] = None, value_date: Optional[Dict[str, Any]] = None, value_integer: Optional[int] = None, value_money: Optional[float] = None, value_string: Optional[str] = None)

Get Entry Custom Field

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

custom_field_definition_id: Optional[int] = field(default=None, metadata={'wire_name': 'CustomFieldDefinitionID'})

Pointer to the custom field definition record.

entry_custom_field_id class-attribute instance-attribute

entry_custom_field_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryCustomFieldID'})

Unique ID for this entry custom field record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

field_data_type_enum class-attribute instance-attribute

field_data_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'FieldDataTypeEnum'})

Field data type.

value_boolean class-attribute instance-attribute

value_boolean: Optional[bool] = field(default=None, metadata={'wire_name': 'ValueBoolean'})

Boolean value.

value_integer class-attribute instance-attribute

value_integer: Optional[int] = field(default=None, metadata={'wire_name': 'ValueInteger'})

Integer value.

value_money class-attribute instance-attribute

value_money: Optional[float] = field(default=None, metadata={'wire_name': 'ValueMoney'})

Money value.

value_string class-attribute instance-attribute

value_string: Optional[str] = field(default=None, metadata={'wire_name': 'ValueString'})

String value.

UpdateEntryCustomFieldInput dataclass

UpdateEntryCustomFieldInput(custom_field_definition_id: Optional[int] = None, entry_custom_field_id: Optional[int] = None, entry_id: Optional[int] = None, field_data_type_enum: Optional[str] = None, value_boolean: Optional[bool] = None, value_date: Optional[str] = None, value_integer: Optional[int] = None, value_money: Optional[float] = None, value_string: Optional[str] = None)

Update Entry Custom Field

Attributes

custom_field_definition_id class-attribute instance-attribute

custom_field_definition_id: Optional[int] = field(default=None, metadata={'wire_name': 'CustomFieldDefinitionID'})

Pointer to the custom field definition record.

entry_custom_field_id class-attribute instance-attribute

entry_custom_field_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryCustomFieldID'})

Unique ID for this entry custom field record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

field_data_type_enum class-attribute instance-attribute

field_data_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'FieldDataTypeEnum'})

Field data type.

value_boolean class-attribute instance-attribute

value_boolean: Optional[bool] = field(default=None, metadata={'wire_name': 'ValueBoolean'})

Boolean value.

value_date class-attribute instance-attribute

value_date: Optional[str] = field(default=None, metadata={'wire_name': 'ValueDate'})

Date value.

value_integer class-attribute instance-attribute

value_integer: Optional[int] = field(default=None, metadata={'wire_name': 'ValueInteger'})

Integer value.

value_money class-attribute instance-attribute

value_money: Optional[float] = field(default=None, metadata={'wire_name': 'ValueMoney'})

Money value.

value_string class-attribute instance-attribute

value_string: Optional[str] = field(default=None, metadata={'wire_name': 'ValueString'})

String value.

UpdateEntryCustomFieldResponse dataclass

UpdateEntryCustomFieldResponse(custom_field_definition_id: Optional[int] = None, entry_custom_field_id: Optional[int] = None, entry_id: Optional[int] = None, field_data_type_enum: Optional[str] = None, value_boolean: Optional[bool] = None, value_date: Optional[str] = None, value_integer: Optional[int] = None, value_money: Optional[float] = None, value_string: Optional[str] = None)

Response for Update Entry Custom Field

Attributes

custom_field_definition_id class-attribute instance-attribute

custom_field_definition_id: Optional[int] = field(default=None, metadata={'wire_name': 'CustomFieldDefinitionID'})

Pointer to the custom field definition record.

entry_custom_field_id class-attribute instance-attribute

entry_custom_field_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryCustomFieldID'})

Unique ID for this entry custom field record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

field_data_type_enum class-attribute instance-attribute

field_data_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'FieldDataTypeEnum'})

Field data type.

value_boolean class-attribute instance-attribute

value_boolean: Optional[bool] = field(default=None, metadata={'wire_name': 'ValueBoolean'})

Boolean value.

value_date class-attribute instance-attribute

value_date: Optional[str] = field(default=None, metadata={'wire_name': 'ValueDate'})

Date value.

value_integer class-attribute instance-attribute

value_integer: Optional[int] = field(default=None, metadata={'wire_name': 'ValueInteger'})

Integer value.

value_money class-attribute instance-attribute

value_money: Optional[float] = field(default=None, metadata={'wire_name': 'ValueMoney'})

Money value.

value_string class-attribute instance-attribute

value_string: Optional[str] = field(default=None, metadata={'wire_name': 'ValueString'})

String value.

SelectTermInput dataclass

SelectTermInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, active: Optional[bool] = None, active_date_close: Optional[Dict[str, Any]] = None, active_date_open: Optional[Dict[str, Any]] = None, category_id: Optional[int] = None, comments: Optional[str] = None, date_modified: Optional[Dict[str, Any]] = None, description: Optional[str] = None, record_type_enum: Optional[str] = None, term_code: Optional[str] = None, term_id: Optional[int] = None, term_type_id: Optional[int] = None, web_description: Optional[str] = None)

Get Term

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

active class-attribute instance-attribute

active: Optional[bool] = field(default=None, metadata={'wire_name': 'Active'})

Current active state.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

Pointer to the category record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Term comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Term description.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

term_code class-attribute instance-attribute

term_code: Optional[str] = field(default=None, metadata={'wire_name': 'TermCode'})

Term code.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Unique ID for this term record.

term_type_id class-attribute instance-attribute

term_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermTypeID'})

Pointer to the term type record.

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

Term displayed in the Portal.

SelectEntryAddressInput dataclass

SelectEntryAddressInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, active_date_end: Optional[Dict[str, Any]] = None, active_date_start: Optional[Dict[str, Any]] = None, address_type_id: Optional[int] = None, city: Optional[str] = None, comments: Optional[str] = None, contact_name: Optional[str] = None, contact_name2: Optional[str] = None, country_id: Optional[int] = None, date_modified: Optional[Dict[str, Any]] = None, email: Optional[str] = None, entry_address_id: Optional[int] = None, entry_id: Optional[int] = None, phone: Optional[str] = None, phone_mobile_cell: Optional[str] = None, phone_other: Optional[str] = None, phone_other2: Optional[str] = None, reference: Optional[str] = None, relationship: Optional[str] = None, salutation: Optional[str] = None, state_province: Optional[str] = None, street: Optional[str] = None, street2: Optional[str] = None, zip_postcode: Optional[str] = None)

Get Entry Address

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Pointer to the address type record.

city class-attribute instance-attribute

city: Optional[str] = field(default=None, metadata={'wire_name': 'City'})

City

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Address comments.

contact_name class-attribute instance-attribute

contact_name: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName'})

Contact name.

contact_name2 class-attribute instance-attribute

contact_name2: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName2'})

Contact name 2.

country_id class-attribute instance-attribute

country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryID'})

Pointer to the country record.

email class-attribute instance-attribute

email: Optional[str] = field(default=None, metadata={'wire_name': 'Email'})

Email

entry_address_id class-attribute instance-attribute

entry_address_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryAddressID'})

Unique ID for this entry address record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

phone class-attribute instance-attribute

phone: Optional[str] = field(default=None, metadata={'wire_name': 'Phone'})

Phone

phone_mobile_cell class-attribute instance-attribute

phone_mobile_cell: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneMobileCell'})

Mobile/Cell

phone_other class-attribute instance-attribute

phone_other: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther'})

Alternative phone.

phone_other2 class-attribute instance-attribute

phone_other2: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther2'})

Alternative phone 2.

reference class-attribute instance-attribute

reference: Optional[str] = field(default=None, metadata={'wire_name': 'Reference'})

Reference

relationship class-attribute instance-attribute

relationship: Optional[str] = field(default=None, metadata={'wire_name': 'Relationship'})

Relationship this address has to the entry.

salutation class-attribute instance-attribute

salutation: Optional[str] = field(default=None, metadata={'wire_name': 'Salutation'})

Salutation

state_province class-attribute instance-attribute

state_province: Optional[str] = field(default=None, metadata={'wire_name': 'StateProvince'})

State/Province

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

UpdateEntryAddressInput dataclass

UpdateEntryAddressInput(active_date_end: Optional[str] = None, active_date_start: Optional[str] = None, address_type_id: Optional[int] = None, city: Optional[str] = None, comments: Optional[str] = None, contact_name: Optional[str] = None, contact_name2: Optional[str] = None, country_id: Optional[int] = None, email: Optional[str] = None, entry_address_id: Optional[int] = None, entry_id: Optional[int] = None, phone: Optional[str] = None, phone_mobile_cell: Optional[str] = None, phone_other: Optional[str] = None, phone_other2: Optional[str] = None, reference: Optional[str] = None, relationship: Optional[str] = None, salutation: Optional[str] = None, state_province: Optional[str] = None, street: Optional[str] = None, street2: Optional[str] = None, zip_postcode: Optional[str] = None)

Update Entry Address

Attributes

active_date_end class-attribute instance-attribute

active_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ActiveDateEnd'})

End active date.

active_date_start class-attribute instance-attribute

active_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ActiveDateStart'})

Date when this address becomes active.

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Pointer to the address type record.

city class-attribute instance-attribute

city: Optional[str] = field(default=None, metadata={'wire_name': 'City'})

City

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Address comments.

contact_name class-attribute instance-attribute

contact_name: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName'})

Contact name.

contact_name2 class-attribute instance-attribute

contact_name2: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName2'})

Contact name 2.

country_id class-attribute instance-attribute

country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryID'})

Pointer to the country record.

email class-attribute instance-attribute

email: Optional[str] = field(default=None, metadata={'wire_name': 'Email'})

Email

entry_address_id class-attribute instance-attribute

entry_address_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryAddressID'})

Unique ID for this entry address record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

phone class-attribute instance-attribute

phone: Optional[str] = field(default=None, metadata={'wire_name': 'Phone'})

Phone

phone_mobile_cell class-attribute instance-attribute

phone_mobile_cell: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneMobileCell'})

Mobile/Cell

phone_other class-attribute instance-attribute

phone_other: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther'})

Alternative phone.

phone_other2 class-attribute instance-attribute

phone_other2: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther2'})

Alternative phone 2.

reference class-attribute instance-attribute

reference: Optional[str] = field(default=None, metadata={'wire_name': 'Reference'})

Reference

relationship class-attribute instance-attribute

relationship: Optional[str] = field(default=None, metadata={'wire_name': 'Relationship'})

Relationship this address has to the entry.

salutation class-attribute instance-attribute

salutation: Optional[str] = field(default=None, metadata={'wire_name': 'Salutation'})

Salutation

state_province class-attribute instance-attribute

state_province: Optional[str] = field(default=None, metadata={'wire_name': 'StateProvince'})

State/Province

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

UpdateEntryAddressResponse dataclass

UpdateEntryAddressResponse(active_date_end: Optional[str] = None, active_date_start: Optional[str] = None, address_type_id: Optional[int] = None, city: Optional[str] = None, comments: Optional[str] = None, contact_name: Optional[str] = None, contact_name2: Optional[str] = None, country_id: Optional[int] = None, email: Optional[str] = None, entry_address_id: Optional[int] = None, entry_id: Optional[int] = None, phone: Optional[str] = None, phone_mobile_cell: Optional[str] = None, phone_other: Optional[str] = None, phone_other2: Optional[str] = None, reference: Optional[str] = None, relationship: Optional[str] = None, salutation: Optional[str] = None, state_province: Optional[str] = None, street: Optional[str] = None, street2: Optional[str] = None, zip_postcode: Optional[str] = None)

Response for Update Entry Address

Attributes

active_date_end class-attribute instance-attribute

active_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ActiveDateEnd'})

End active date.

active_date_start class-attribute instance-attribute

active_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ActiveDateStart'})

Date when this address becomes active.

address_type_id class-attribute instance-attribute

address_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'AddressTypeID'})

Pointer to the address type record.

city class-attribute instance-attribute

city: Optional[str] = field(default=None, metadata={'wire_name': 'City'})

City

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Address comments.

contact_name class-attribute instance-attribute

contact_name: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName'})

Contact name.

contact_name2 class-attribute instance-attribute

contact_name2: Optional[str] = field(default=None, metadata={'wire_name': 'ContactName2'})

Contact name 2.

country_id class-attribute instance-attribute

country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryID'})

Pointer to the country record.

email class-attribute instance-attribute

email: Optional[str] = field(default=None, metadata={'wire_name': 'Email'})

Email

entry_address_id class-attribute instance-attribute

entry_address_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryAddressID'})

Unique ID for this entry address record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

phone class-attribute instance-attribute

phone: Optional[str] = field(default=None, metadata={'wire_name': 'Phone'})

Phone

phone_mobile_cell class-attribute instance-attribute

phone_mobile_cell: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneMobileCell'})

Mobile/Cell

phone_other class-attribute instance-attribute

phone_other: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther'})

Alternative phone.

phone_other2 class-attribute instance-attribute

phone_other2: Optional[str] = field(default=None, metadata={'wire_name': 'PhoneOther2'})

Alternative phone 2.

reference class-attribute instance-attribute

reference: Optional[str] = field(default=None, metadata={'wire_name': 'Reference'})

Reference

relationship class-attribute instance-attribute

relationship: Optional[str] = field(default=None, metadata={'wire_name': 'Relationship'})

Relationship this address has to the entry.

salutation class-attribute instance-attribute

salutation: Optional[str] = field(default=None, metadata={'wire_name': 'Salutation'})

Salutation

state_province class-attribute instance-attribute

state_province: Optional[str] = field(default=None, metadata={'wire_name': 'StateProvince'})

State/Province

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

SelectEntryApplicationInput dataclass

SelectEntryApplicationInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, allocate_option_enum: Optional[str] = None, application_date: Optional[Dict[str, Any]] = None, application_status_id: Optional[int] = None, cancel_date: Optional[Dict[str, Any]] = None, classification_id: Optional[int] = None, comments: Optional[str] = None, comments_internal: Optional[str] = None, complete_date: Optional[Dict[str, Any]] = None, contract_signed_date: Optional[Dict[str, Any]] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_date3: Optional[Dict[str, Any]] = None, custom_date4: Optional[Dict[str, Any]] = None, date_created: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, enquiry_date: Optional[Dict[str, Any]] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, expected_arrival_date: Optional[Dict[str, Any]] = None, expected_arrival_date_latest: Optional[Dict[str, Any]] = None, expected_departure_date: Optional[Dict[str, Any]] = None, offered_date: Optional[Dict[str, Any]] = None, offer_reply_date: Optional[Dict[str, Any]] = None, offer_reply_enum: Optional[str] = None, offer_reply_reason: Optional[str] = None, offer_sent_date: Optional[Dict[str, Any]] = None, portal_tracking_only: Optional[bool] = None, preference_comments: Optional[str] = None, rating: Optional[str] = None, received_date: Optional[Dict[str, Any]] = None, received_deposit: Optional[bool] = None, received_deposit_waived: Optional[bool] = None, received_deposit_payment_id: Optional[int] = None, received_deposit_web_payment_id: Optional[int] = None, received_deposit_amount: Optional[float] = None, received_deposit_date: Optional[Dict[str, Any]] = None, received_fee: Optional[bool] = None, received_fee_payment_id: Optional[int] = None, received_fee_web_payment_id: Optional[int] = None, received_fee_amount: Optional[float] = None, received_fee_date: Optional[Dict[str, Any]] = None, received_photo_date: Optional[Dict[str, Any]] = None, returning: Optional[bool] = None, room_mate_description: Optional[str] = None, roommate_group_id: Optional[int] = None, room_mate_group_sort_order: Optional[int] = None, room_mate_show_in_search: Optional[bool] = None, room_preference_comments: Optional[str] = None, room_selection_number: Optional[int] = None, room_selection_timeslot: Optional[str] = None, security_user_id: Optional[int] = None, term_id: Optional[int] = None, web: Optional[bool] = None)

Get Entry Application

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

allocate_option_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AllocateOptionEnum'})

Allocate option.

application_status_id class-attribute instance-attribute

application_status_id: Optional[int] = field(default=None, metadata={'wire_name': 'ApplicationStatusID'})

Pointer to the application status record.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Application comments.

comments_internal class-attribute instance-attribute

comments_internal: Optional[str] = field(default=None, metadata={'wire_name': 'CommentsInternal'})

Internal comments.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Unique ID for this entry application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

offer_reply_enum class-attribute instance-attribute

offer_reply_enum: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyEnum'})

Offer reply.

offer_reply_reason class-attribute instance-attribute

offer_reply_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyReason'})

Offer reply reason.

portal_tracking_only class-attribute instance-attribute

portal_tracking_only: Optional[bool] = field(default=None, metadata={'wire_name': 'PortalTrackingOnly'})

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

preference_comments class-attribute instance-attribute

preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'PreferenceComments'})

Preference comments.

rating class-attribute instance-attribute

rating: Optional[str] = field(default=None, metadata={'wire_name': 'Rating'})

Application rating.

received_deposit class-attribute instance-attribute

received_deposit: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDeposit'})

Indicates if the deposit has been received.

received_deposit_waived class-attribute instance-attribute

received_deposit_waived: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDepositWaived'})

Date deposit was waived.

received_deposit_payment_id class-attribute instance-attribute

received_deposit_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})

Pointer to the payment record for the received fee.

received_deposit_web_payment_id class-attribute instance-attribute

received_deposit_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})

Most recent fee payment that was attempted.

received_deposit_amount class-attribute instance-attribute

received_deposit_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedDepositAmount'})

Received deposit amount.

received_fee class-attribute instance-attribute

received_fee: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedFee'})

Indicates if the fee has been received.

received_fee_payment_id class-attribute instance-attribute

received_fee_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_PaymentID'})

Pointer to the payment record for the received fee.

received_fee_web_payment_id class-attribute instance-attribute

received_fee_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})

Most recent fee payment that was attempted.

received_fee_amount class-attribute instance-attribute

received_fee_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedFeeAmount'})

Received fee amount.

returning class-attribute instance-attribute

returning: Optional[bool] = field(default=None, metadata={'wire_name': 'Returning'})

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

room_mate_description class-attribute instance-attribute

room_mate_description: Optional[str] = field(default=None, metadata={'wire_name': 'RoomMateDescription'})

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

roommate_group_id class-attribute instance-attribute

roommate_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoommateGroupID'})

Pointer to the Roommate group record.

room_mate_group_sort_order class-attribute instance-attribute

room_mate_group_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'RoomMateGroupSortOrder'})

Order that group members should be processed in.

room_mate_show_in_search class-attribute instance-attribute

room_mate_show_in_search: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomMateShowInSearch'})

Whether to include this applicant in roommate searches.

room_preference_comments class-attribute instance-attribute

room_preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'RoomPreferenceComments'})

Room preference comments.

room_selection_number class-attribute instance-attribute

room_selection_number: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSelectionNumber'})

Room selection number.

room_selection_timeslot class-attribute instance-attribute

room_selection_timeslot: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSelectionTimeslot'})

Room selection timeslot.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Defines the period this application is for.

web class-attribute instance-attribute

web: Optional[bool] = field(default=None, metadata={'wire_name': 'Web'})

Indicates if this application was created on the web.

CreateEntryApplicationInput dataclass

CreateEntryApplicationInput(allocate_option_enum: Optional[str] = None, application_date: Optional[str] = None, application_status_id: Optional[int] = None, cancel_date: Optional[str] = None, classification_id: Optional[int] = None, comments: Optional[str] = None, comments_internal: Optional[str] = None, complete_date: Optional[str] = None, contract_signed_date: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, enquiry_date: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, expected_arrival_date: Optional[str] = None, expected_arrival_date_latest: Optional[str] = None, expected_departure_date: Optional[str] = None, offered_date: Optional[str] = None, offer_reply_date: Optional[str] = None, offer_reply_enum: Optional[str] = None, offer_reply_reason: Optional[str] = None, offer_sent_date: Optional[str] = None, portal_tracking_only: Optional[bool] = None, preference_comments: Optional[str] = None, rating: Optional[str] = None, received_date: Optional[str] = None, received_deposit: Optional[bool] = None, received_deposit_payment_id: Optional[int] = None, received_deposit_web_payment_id: Optional[int] = None, received_deposit_amount: Optional[float] = None, received_deposit_date: Optional[str] = None, received_deposit_waived: Optional[bool] = None, received_fee: Optional[bool] = None, received_fee_payment_id: Optional[int] = None, received_fee_web_payment_id: Optional[int] = None, received_fee_amount: Optional[float] = None, received_fee_date: Optional[str] = None, received_photo_date: Optional[str] = None, returning: Optional[bool] = None, room_mate_description: Optional[str] = None, roommate_group_id: Optional[int] = None, room_mate_group_sort_order: Optional[int] = None, room_mate_show_in_search: Optional[bool] = None, room_preference_comments: Optional[str] = None, room_selection_number: Optional[int] = None, room_selection_timeslot: Optional[str] = None, security_user_id: Optional[int] = None, term_id: Optional[int] = None, web: Optional[bool] = None)

Create Entry Application

Attributes

allocate_option_enum class-attribute instance-attribute

allocate_option_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AllocateOptionEnum'})

Allocate option.

application_date class-attribute instance-attribute

application_date: Optional[str] = field(default=None, metadata={'wire_name': 'ApplicationDate'})

Date of application.

application_status_id class-attribute instance-attribute

application_status_id: Optional[int] = field(default=None, metadata={'wire_name': 'ApplicationStatusID'})

Pointer to the application status record.

cancel_date class-attribute instance-attribute

cancel_date: Optional[str] = field(default=None, metadata={'wire_name': 'CancelDate'})

Cancellation date.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Application comments.

comments_internal class-attribute instance-attribute

comments_internal: Optional[str] = field(default=None, metadata={'wire_name': 'CommentsInternal'})

Internal comments.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Completion date.

contract_signed_date class-attribute instance-attribute

contract_signed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractSignedDate'})

Date contract was signed.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

enquiry_date class-attribute instance-attribute

enquiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'EnquiryDate'})

Date of enquiry.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Unique ID for this entry application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

expected_arrival_date class-attribute instance-attribute

expected_arrival_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDate'})

Date entry is expected to arrive.

expected_arrival_date_latest class-attribute instance-attribute

expected_arrival_date_latest: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDateLatest'})

Latest expected arrival date.

expected_departure_date class-attribute instance-attribute

expected_departure_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedDepartureDate'})

Date entry is expected to depart.

offered_date class-attribute instance-attribute

offered_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferedDate'})

Date application was offered.

offer_reply_date class-attribute instance-attribute

offer_reply_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyDate'})

Date offer was replied to.

offer_reply_enum class-attribute instance-attribute

offer_reply_enum: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyEnum'})

Offer reply.

offer_reply_reason class-attribute instance-attribute

offer_reply_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyReason'})

Offer reply reason.

offer_sent_date class-attribute instance-attribute

offer_sent_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferSentDate'})

Date offer sent.

portal_tracking_only class-attribute instance-attribute

portal_tracking_only: Optional[bool] = field(default=None, metadata={'wire_name': 'PortalTrackingOnly'})

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

preference_comments class-attribute instance-attribute

preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'PreferenceComments'})

Preference comments.

rating class-attribute instance-attribute

rating: Optional[str] = field(default=None, metadata={'wire_name': 'Rating'})

Application rating.

received_date class-attribute instance-attribute

received_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDate'})

Date received.

received_deposit class-attribute instance-attribute

received_deposit: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDeposit'})

Indicates if the deposit has been received.

received_deposit_payment_id class-attribute instance-attribute

received_deposit_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})

Pointer to the payment record for the received deposit.

received_deposit_web_payment_id class-attribute instance-attribute

received_deposit_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})

Most recent deposit payment that was attempted.

received_deposit_amount class-attribute instance-attribute

received_deposit_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedDepositAmount'})

Received deposit amount.

received_deposit_date class-attribute instance-attribute

received_deposit_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDepositDate'})

Date deposit was received.

received_deposit_waived class-attribute instance-attribute

received_deposit_waived: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDepositWaived'})

Date deposit was waived.

received_fee class-attribute instance-attribute

received_fee: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedFee'})

Indicates if the fee has been received.

received_fee_payment_id class-attribute instance-attribute

received_fee_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_PaymentID'})

Pointer to the payment record for the received fee.

received_fee_web_payment_id class-attribute instance-attribute

received_fee_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})

Most recent fee payment that was attempted.

received_fee_amount class-attribute instance-attribute

received_fee_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedFeeAmount'})

Received fee amount.

received_fee_date class-attribute instance-attribute

received_fee_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedFeeDate'})

Date fee was received.

received_photo_date class-attribute instance-attribute

received_photo_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedPhotoDate'})

Date photo was received.

returning class-attribute instance-attribute

returning: Optional[bool] = field(default=None, metadata={'wire_name': 'Returning'})

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

room_mate_description class-attribute instance-attribute

room_mate_description: Optional[str] = field(default=None, metadata={'wire_name': 'RoomMateDescription'})

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

roommate_group_id class-attribute instance-attribute

roommate_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoommateGroupID'})

Pointer to the Roommate group record.

room_mate_group_sort_order class-attribute instance-attribute

room_mate_group_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'RoomMateGroupSortOrder'})

Order that group members should be processed in.

room_mate_show_in_search class-attribute instance-attribute

room_mate_show_in_search: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomMateShowInSearch'})

Whether to include this applicant in roommate searches.

room_preference_comments class-attribute instance-attribute

room_preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'RoomPreferenceComments'})

Room preference comments.

room_selection_number class-attribute instance-attribute

room_selection_number: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSelectionNumber'})

Room selection number.

room_selection_timeslot class-attribute instance-attribute

room_selection_timeslot: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSelectionTimeslot'})

Room selection timeslot.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Defines the period this application is for.

web class-attribute instance-attribute

web: Optional[bool] = field(default=None, metadata={'wire_name': 'Web'})

Indicates if this application was created on the web.

CreateEntryApplicationResponse dataclass

CreateEntryApplicationResponse(allocate_option_enum: Optional[str] = None, application_date: Optional[str] = None, application_status_id: Optional[int] = None, cancel_date: Optional[str] = None, classification_id: Optional[int] = None, comments: Optional[str] = None, comments_internal: Optional[str] = None, complete_date: Optional[str] = None, contract_signed_date: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, entry_application_id: Optional[int] = None, enquiry_date: Optional[str] = None, entry_id: Optional[int] = None, expected_arrival_date: Optional[str] = None, expected_arrival_date_latest: Optional[str] = None, expected_departure_date: Optional[str] = None, offered_date: Optional[str] = None, offer_reply_date: Optional[str] = None, offer_reply_enum: Optional[str] = None, offer_reply_reason: Optional[str] = None, offer_sent_date: Optional[str] = None, portal_tracking_only: Optional[bool] = None, preference_comments: Optional[str] = None, rating: Optional[str] = None, received_date: Optional[str] = None, received_deposit: Optional[bool] = None, received_deposit_payment_id: Optional[int] = None, received_deposit_web_payment_id: Optional[int] = None, received_deposit_amount: Optional[float] = None, received_deposit_date: Optional[str] = None, received_deposit_waived: Optional[bool] = None, received_fee: Optional[bool] = None, received_fee_payment_id: Optional[int] = None, received_fee_web_payment_id: Optional[int] = None, received_fee_amount: Optional[float] = None, received_fee_date: Optional[str] = None, received_photo_date: Optional[str] = None, returning: Optional[bool] = None, room_mate_description: Optional[str] = None, roommate_group_id: Optional[int] = None, room_mate_group_sort_order: Optional[int] = None, room_mate_show_in_search: Optional[bool] = None, room_preference_comments: Optional[str] = None, room_selection_number: Optional[int] = None, room_selection_timeslot: Optional[str] = None, security_user_id: Optional[int] = None, term_id: Optional[int] = None, web: Optional[bool] = None)

Response for Create Entry Application

Attributes

allocate_option_enum class-attribute instance-attribute

allocate_option_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AllocateOptionEnum'})

Allocate option.

application_date class-attribute instance-attribute

application_date: Optional[str] = field(default=None, metadata={'wire_name': 'ApplicationDate'})

Date of application.

application_status_id class-attribute instance-attribute

application_status_id: Optional[int] = field(default=None, metadata={'wire_name': 'ApplicationStatusID'})

Pointer to the application status record.

cancel_date class-attribute instance-attribute

cancel_date: Optional[str] = field(default=None, metadata={'wire_name': 'CancelDate'})

Cancellation date.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Application comments.

comments_internal class-attribute instance-attribute

comments_internal: Optional[str] = field(default=None, metadata={'wire_name': 'CommentsInternal'})

Internal comments.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Completion date.

contract_signed_date class-attribute instance-attribute

contract_signed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractSignedDate'})

Date contract was signed.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Unique ID for this entry application record.

enquiry_date class-attribute instance-attribute

enquiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'EnquiryDate'})

Date of enquiry.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

expected_arrival_date class-attribute instance-attribute

expected_arrival_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDate'})

Date entry is expected to arrive.

expected_arrival_date_latest class-attribute instance-attribute

expected_arrival_date_latest: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDateLatest'})

Latest expected arrival date.

expected_departure_date class-attribute instance-attribute

expected_departure_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedDepartureDate'})

Date entry is expected to depart.

offered_date class-attribute instance-attribute

offered_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferedDate'})

Date application was offered.

offer_reply_date class-attribute instance-attribute

offer_reply_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyDate'})

Date offer was replied to.

offer_reply_enum class-attribute instance-attribute

offer_reply_enum: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyEnum'})

Offer reply.

offer_reply_reason class-attribute instance-attribute

offer_reply_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyReason'})

Offer reply reason.

offer_sent_date class-attribute instance-attribute

offer_sent_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferSentDate'})

Date offer sent.

portal_tracking_only class-attribute instance-attribute

portal_tracking_only: Optional[bool] = field(default=None, metadata={'wire_name': 'PortalTrackingOnly'})

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

preference_comments class-attribute instance-attribute

preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'PreferenceComments'})

Preference comments.

rating class-attribute instance-attribute

rating: Optional[str] = field(default=None, metadata={'wire_name': 'Rating'})

Application rating.

received_date class-attribute instance-attribute

received_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDate'})

Date received.

received_deposit class-attribute instance-attribute

received_deposit: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDeposit'})

Indicates if the deposit has been received.

received_deposit_payment_id class-attribute instance-attribute

received_deposit_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})

Pointer to the payment record for the received deposit.

received_deposit_web_payment_id class-attribute instance-attribute

received_deposit_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})

Most recent deposit payment that was attempted.

received_deposit_amount class-attribute instance-attribute

received_deposit_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedDepositAmount'})

Received deposit amount.

received_deposit_date class-attribute instance-attribute

received_deposit_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDepositDate'})

Date deposit was received.

received_deposit_waived class-attribute instance-attribute

received_deposit_waived: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDepositWaived'})

Date deposit was waived.

received_fee class-attribute instance-attribute

received_fee: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedFee'})

Indicates if the fee has been received.

received_fee_payment_id class-attribute instance-attribute

received_fee_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_PaymentID'})

Pointer to the payment record for the received fee.

received_fee_web_payment_id class-attribute instance-attribute

received_fee_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})

Most recent fee payment that was attempted.

received_fee_amount class-attribute instance-attribute

received_fee_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedFeeAmount'})

Received fee amount.

received_fee_date class-attribute instance-attribute

received_fee_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedFeeDate'})

Date fee was received.

received_photo_date class-attribute instance-attribute

received_photo_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedPhotoDate'})

Date photo was received.

returning class-attribute instance-attribute

returning: Optional[bool] = field(default=None, metadata={'wire_name': 'Returning'})

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

room_mate_description class-attribute instance-attribute

room_mate_description: Optional[str] = field(default=None, metadata={'wire_name': 'RoomMateDescription'})

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

roommate_group_id class-attribute instance-attribute

roommate_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoommateGroupID'})

Pointer to the Roommate group record.

room_mate_group_sort_order class-attribute instance-attribute

room_mate_group_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'RoomMateGroupSortOrder'})

Order that group members should be processed in.

room_mate_show_in_search class-attribute instance-attribute

room_mate_show_in_search: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomMateShowInSearch'})

Whether to include this applicant in roommate searches.

room_preference_comments class-attribute instance-attribute

room_preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'RoomPreferenceComments'})

Room preference comments.

room_selection_number class-attribute instance-attribute

room_selection_number: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSelectionNumber'})

Room selection number.

room_selection_timeslot class-attribute instance-attribute

room_selection_timeslot: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSelectionTimeslot'})

Room selection timeslot.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Defines the period this application is for.

web class-attribute instance-attribute

web: Optional[bool] = field(default=None, metadata={'wire_name': 'Web'})

Indicates if this application was created on the web.

UpdateEntryApplicationInput dataclass

UpdateEntryApplicationInput(allocate_option_enum: Optional[str] = None, application_date: Optional[str] = None, application_status_id: Optional[int] = None, cancel_date: Optional[str] = None, classification_id: Optional[int] = None, comments: Optional[str] = None, comments_internal: Optional[str] = None, complete_date: Optional[str] = None, contract_signed_date: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, enquiry_date: Optional[str] = None, expected_arrival_date: Optional[str] = None, expected_arrival_date_latest: Optional[str] = None, expected_departure_date: Optional[str] = None, offered_date: Optional[str] = None, offer_reply_date: Optional[str] = None, offer_reply_enum: Optional[str] = None, offer_reply_reason: Optional[str] = None, offer_sent_date: Optional[str] = None, portal_tracking_only: Optional[bool] = None, preference_comments: Optional[str] = None, rating: Optional[str] = None, received_date: Optional[str] = None, received_deposit: Optional[bool] = None, received_deposit_payment_id: Optional[int] = None, received_deposit_web_payment_id: Optional[int] = None, received_deposit_amount: Optional[float] = None, received_deposit_date: Optional[str] = None, received_deposit_waived: Optional[bool] = None, received_fee: Optional[bool] = None, received_fee_payment_id: Optional[int] = None, received_fee_web_payment_id: Optional[int] = None, received_fee_amount: Optional[float] = None, received_fee_date: Optional[str] = None, received_photo_date: Optional[str] = None, returning: Optional[bool] = None, room_mate_description: Optional[str] = None, roommate_group_id: Optional[int] = None, room_mate_group_sort_order: Optional[int] = None, room_mate_show_in_search: Optional[bool] = None, room_preference_comments: Optional[str] = None, room_selection_number: Optional[int] = None, room_selection_timeslot: Optional[str] = None, security_user_id: Optional[int] = None, term_id: Optional[int] = None, web: Optional[bool] = None)

Update Entry Application

Attributes

allocate_option_enum class-attribute instance-attribute

allocate_option_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AllocateOptionEnum'})

Allocate option.

application_date class-attribute instance-attribute

application_date: Optional[str] = field(default=None, metadata={'wire_name': 'ApplicationDate'})

Date of application.

application_status_id class-attribute instance-attribute

application_status_id: Optional[int] = field(default=None, metadata={'wire_name': 'ApplicationStatusID'})

Pointer to the application status record.

cancel_date class-attribute instance-attribute

cancel_date: Optional[str] = field(default=None, metadata={'wire_name': 'CancelDate'})

Cancellation date.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Application comments.

comments_internal class-attribute instance-attribute

comments_internal: Optional[str] = field(default=None, metadata={'wire_name': 'CommentsInternal'})

Internal comments.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Completion date.

contract_signed_date class-attribute instance-attribute

contract_signed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractSignedDate'})

Date contract was signed.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Unique ID for this entry application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

enquiry_date class-attribute instance-attribute

enquiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'EnquiryDate'})

Date of enquiry.

expected_arrival_date class-attribute instance-attribute

expected_arrival_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDate'})

Date entry is expected to arrive.

expected_arrival_date_latest class-attribute instance-attribute

expected_arrival_date_latest: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDateLatest'})

Latest expected arrival date.

expected_departure_date class-attribute instance-attribute

expected_departure_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedDepartureDate'})

Date entry is expected to depart.

offered_date class-attribute instance-attribute

offered_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferedDate'})

Date application was offered.

offer_reply_date class-attribute instance-attribute

offer_reply_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyDate'})

Date offer was replied to.

offer_reply_enum class-attribute instance-attribute

offer_reply_enum: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyEnum'})

Offer reply.

offer_reply_reason class-attribute instance-attribute

offer_reply_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyReason'})

Offer reply reason.

offer_sent_date class-attribute instance-attribute

offer_sent_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferSentDate'})

Date offer sent.

portal_tracking_only class-attribute instance-attribute

portal_tracking_only: Optional[bool] = field(default=None, metadata={'wire_name': 'PortalTrackingOnly'})

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

preference_comments class-attribute instance-attribute

preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'PreferenceComments'})

Preference comments.

rating class-attribute instance-attribute

rating: Optional[str] = field(default=None, metadata={'wire_name': 'Rating'})

Application rating.

received_date class-attribute instance-attribute

received_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDate'})

Date received.

received_deposit class-attribute instance-attribute

received_deposit: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDeposit'})

Indicates if the deposit has been received.

received_deposit_payment_id class-attribute instance-attribute

received_deposit_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})

Pointer to the payment record for the received deposit.

received_deposit_web_payment_id class-attribute instance-attribute

received_deposit_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})

Most recent deposit payment that was attempted.

received_deposit_amount class-attribute instance-attribute

received_deposit_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedDepositAmount'})

Received deposit amount.

received_deposit_date class-attribute instance-attribute

received_deposit_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDepositDate'})

Date deposit was received.

received_deposit_waived class-attribute instance-attribute

received_deposit_waived: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDepositWaived'})

Date deposit was waived.

received_fee class-attribute instance-attribute

received_fee: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedFee'})

Indicates if the fee has been received.

received_fee_payment_id class-attribute instance-attribute

received_fee_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_PaymentID'})

Pointer to the payment record for the received fee.

received_fee_web_payment_id class-attribute instance-attribute

received_fee_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})

Most recent fee payment that was attempted.

received_fee_amount class-attribute instance-attribute

received_fee_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedFeeAmount'})

Received fee amount.

received_fee_date class-attribute instance-attribute

received_fee_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedFeeDate'})

Date fee was received.

received_photo_date class-attribute instance-attribute

received_photo_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedPhotoDate'})

Date photo was received.

returning class-attribute instance-attribute

returning: Optional[bool] = field(default=None, metadata={'wire_name': 'Returning'})

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

room_mate_description class-attribute instance-attribute

room_mate_description: Optional[str] = field(default=None, metadata={'wire_name': 'RoomMateDescription'})

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

roommate_group_id class-attribute instance-attribute

roommate_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoommateGroupID'})

Pointer to the Roommate group record.

room_mate_group_sort_order class-attribute instance-attribute

room_mate_group_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'RoomMateGroupSortOrder'})

Order that group members should be processed in.

room_mate_show_in_search class-attribute instance-attribute

room_mate_show_in_search: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomMateShowInSearch'})

Whether to include this applicant in roommate searches.

room_preference_comments class-attribute instance-attribute

room_preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'RoomPreferenceComments'})

Room preference comments.

room_selection_number class-attribute instance-attribute

room_selection_number: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSelectionNumber'})

Room selection number.

room_selection_timeslot class-attribute instance-attribute

room_selection_timeslot: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSelectionTimeslot'})

Room selection timeslot.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Defines the period this application is for.

web class-attribute instance-attribute

web: Optional[bool] = field(default=None, metadata={'wire_name': 'Web'})

Indicates if this application was created on the web.

UpdateEntryApplicationResponse dataclass

UpdateEntryApplicationResponse(allocate_option_enum: Optional[str] = None, application_date: Optional[str] = None, application_status_id: Optional[int] = None, cancel_date: Optional[str] = None, classification_id: Optional[int] = None, comments: Optional[str] = None, comments_internal: Optional[str] = None, complete_date: Optional[str] = None, contract_signed_date: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, entry_application_id: Optional[int] = None, entry_id: Optional[int] = None, enquiry_date: Optional[str] = None, expected_arrival_date: Optional[str] = None, expected_arrival_date_latest: Optional[str] = None, expected_departure_date: Optional[str] = None, offered_date: Optional[str] = None, offer_reply_date: Optional[str] = None, offer_reply_enum: Optional[str] = None, offer_reply_reason: Optional[str] = None, offer_sent_date: Optional[str] = None, portal_tracking_only: Optional[bool] = None, preference_comments: Optional[str] = None, rating: Optional[str] = None, received_date: Optional[str] = None, received_deposit: Optional[bool] = None, received_deposit_payment_id: Optional[int] = None, received_deposit_web_payment_id: Optional[int] = None, received_deposit_amount: Optional[float] = None, received_deposit_date: Optional[str] = None, received_deposit_waived: Optional[bool] = None, received_fee: Optional[bool] = None, received_fee_payment_id: Optional[int] = None, received_fee_web_payment_id: Optional[int] = None, received_fee_amount: Optional[float] = None, received_fee_date: Optional[str] = None, received_photo_date: Optional[str] = None, returning: Optional[bool] = None, room_mate_description: Optional[str] = None, roommate_group_id: Optional[int] = None, room_mate_group_sort_order: Optional[int] = None, room_mate_show_in_search: Optional[bool] = None, room_preference_comments: Optional[str] = None, room_selection_number: Optional[int] = None, room_selection_timeslot: Optional[str] = None, security_user_id: Optional[int] = None, term_id: Optional[int] = None, web: Optional[bool] = None)

Response for Update Entry Application

Attributes

allocate_option_enum class-attribute instance-attribute

allocate_option_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AllocateOptionEnum'})

Allocate option.

application_date class-attribute instance-attribute

application_date: Optional[str] = field(default=None, metadata={'wire_name': 'ApplicationDate'})

Date of application.

application_status_id class-attribute instance-attribute

application_status_id: Optional[int] = field(default=None, metadata={'wire_name': 'ApplicationStatusID'})

Pointer to the application status record.

cancel_date class-attribute instance-attribute

cancel_date: Optional[str] = field(default=None, metadata={'wire_name': 'CancelDate'})

Cancellation date.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Application comments.

comments_internal class-attribute instance-attribute

comments_internal: Optional[str] = field(default=None, metadata={'wire_name': 'CommentsInternal'})

Internal comments.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Completion date.

contract_signed_date class-attribute instance-attribute

contract_signed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractSignedDate'})

Date contract was signed.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

entry_application_id class-attribute instance-attribute

entry_application_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryApplicationID'})

Unique ID for this entry application record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

enquiry_date class-attribute instance-attribute

enquiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'EnquiryDate'})

Date of enquiry.

expected_arrival_date class-attribute instance-attribute

expected_arrival_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDate'})

Date entry is expected to arrive.

expected_arrival_date_latest class-attribute instance-attribute

expected_arrival_date_latest: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedArrivalDateLatest'})

Latest expected arrival date.

expected_departure_date class-attribute instance-attribute

expected_departure_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedDepartureDate'})

Date entry is expected to depart.

offered_date class-attribute instance-attribute

offered_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferedDate'})

Date application was offered.

offer_reply_date class-attribute instance-attribute

offer_reply_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyDate'})

Date offer was replied to.

offer_reply_enum class-attribute instance-attribute

offer_reply_enum: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyEnum'})

Offer reply.

offer_reply_reason class-attribute instance-attribute

offer_reply_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OfferReplyReason'})

Offer reply reason.

offer_sent_date class-attribute instance-attribute

offer_sent_date: Optional[str] = field(default=None, metadata={'wire_name': 'OfferSentDate'})

Date offer sent.

portal_tracking_only class-attribute instance-attribute

portal_tracking_only: Optional[bool] = field(default=None, metadata={'wire_name': 'PortalTrackingOnly'})

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

preference_comments class-attribute instance-attribute

preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'PreferenceComments'})

Preference comments.

rating class-attribute instance-attribute

rating: Optional[str] = field(default=None, metadata={'wire_name': 'Rating'})

Application rating.

received_date class-attribute instance-attribute

received_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDate'})

Date received.

received_deposit class-attribute instance-attribute

received_deposit: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDeposit'})

Indicates if the deposit has been received.

received_deposit_payment_id class-attribute instance-attribute

received_deposit_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})

Pointer to the payment record for the received deposit.

received_deposit_web_payment_id class-attribute instance-attribute

received_deposit_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})

Most recent deposit payment that was attempted.

received_deposit_amount class-attribute instance-attribute

received_deposit_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedDepositAmount'})

Received deposit amount.

received_deposit_date class-attribute instance-attribute

received_deposit_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDepositDate'})

Date deposit was received.

received_deposit_waived class-attribute instance-attribute

received_deposit_waived: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedDepositWaived'})

Date deposit was waived.

received_fee class-attribute instance-attribute

received_fee: Optional[bool] = field(default=None, metadata={'wire_name': 'ReceivedFee'})

Indicates if the fee has been received.

received_fee_payment_id class-attribute instance-attribute

received_fee_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_PaymentID'})

Pointer to the payment record for the received fee.

received_fee_web_payment_id class-attribute instance-attribute

received_fee_web_payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})

Most recent fee payment that was attempted.

received_fee_amount class-attribute instance-attribute

received_fee_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ReceivedFeeAmount'})

Received fee amount.

received_fee_date class-attribute instance-attribute

received_fee_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedFeeDate'})

Date fee was received.

received_photo_date class-attribute instance-attribute

received_photo_date: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedPhotoDate'})

Date photo was received.

returning class-attribute instance-attribute

returning: Optional[bool] = field(default=None, metadata={'wire_name': 'Returning'})

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

room_mate_description class-attribute instance-attribute

room_mate_description: Optional[str] = field(default=None, metadata={'wire_name': 'RoomMateDescription'})

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

roommate_group_id class-attribute instance-attribute

roommate_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoommateGroupID'})

Pointer to the Roommate group record.

room_mate_group_sort_order class-attribute instance-attribute

room_mate_group_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'RoomMateGroupSortOrder'})

Order that group members should be processed in.

room_mate_show_in_search class-attribute instance-attribute

room_mate_show_in_search: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomMateShowInSearch'})

Whether to include this applicant in roommate searches.

room_preference_comments class-attribute instance-attribute

room_preference_comments: Optional[str] = field(default=None, metadata={'wire_name': 'RoomPreferenceComments'})

Room preference comments.

room_selection_number class-attribute instance-attribute

room_selection_number: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSelectionNumber'})

Room selection number.

room_selection_timeslot class-attribute instance-attribute

room_selection_timeslot: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSelectionTimeslot'})

Room selection timeslot.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Defines the period this application is for.

web class-attribute instance-attribute

web: Optional[bool] = field(default=None, metadata={'wire_name': 'Web'})

Indicates if this application was created on the web.

SelectTermSessionInput dataclass

SelectTermSessionInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, booking_type_id: Optional[int] = None, cancel_booking_default_end_booking_reason_id: Optional[int] = None, cancel_booking_update_end_booking_reason_boolean_ask_enum: Optional[str] = None, check_in_date: Optional[Dict[str, Any]] = None, check_in_date_actual_decrease_boolean_ask_enum: Optional[str] = None, check_in_date_actual_increase_boolean_ask_enum: Optional[str] = None, check_in_default_start_booking_reason_id: Optional[int] = None, check_in_update_start_booking_reason_boolean_ask_enum: Optional[str] = None, check_out_date: Optional[Dict[str, Any]] = None, check_out_date_actual_decrease_boolean_ask_enum: Optional[str] = None, check_out_date_actual_increase_boolean_ask_enum: Optional[str] = None, check_out_default_end_booking_reason_id: Optional[int] = None, check_out_update_end_booking_reason_boolean_ask_enum: Optional[str] = None, contract_date_check_in_decrease_boolean_ask_enum: Optional[str] = None, contract_date_check_in_increase_boolean_ask_enum: Optional[str] = None, contract_date_check_out_decrease_boolean_ask_enum: Optional[str] = None, contract_date_check_out_increase_boolean_ask_enum: Optional[str] = None, contract_date_end: Optional[Dict[str, Any]] = None, contract_date_start: Optional[Dict[str, Any]] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_modified: Optional[Dict[str, Any]] = None, description: Optional[str] = None, end_booking_reason_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, housekeeping_id: Optional[int] = None, record_type_enum: Optional[str] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_type_id: Optional[int] = None, start_booking_reason_id: Optional[int] = None, term_id: Optional[int] = None, term_session_code: Optional[str] = None, term_session_id: Optional[int] = None, use_active_booking_as_template: Optional[bool] = None, web_description: Optional[str] = None)

Get Term Session

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

cancel_booking_default_end_booking_reason_id class-attribute instance-attribute

cancel_booking_default_end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'CancelBookingDefaultEnd_BookingReasonID'})

The default booking end reason when cancelling a booking.

cancel_booking_update_end_booking_reason_boolean_ask_enum class-attribute instance-attribute

cancel_booking_update_end_booking_reason_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CancelBookingUpdateEndBookingReason_BooleanAskEnum'})

Update booking end reason on booking cancel.

check_in_date_actual_decrease_boolean_ask_enum class-attribute instance-attribute

check_in_date_actual_decrease_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActualDecrease_BooleanAskEnum'})

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

check_in_date_actual_increase_boolean_ask_enum class-attribute instance-attribute

check_in_date_actual_increase_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActualIncrease_BooleanAskEnum'})

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

check_in_default_start_booking_reason_id class-attribute instance-attribute

check_in_default_start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'CheckInDefaultStart_BookingReasonID'})

The default booking start reason when checking in.

check_in_update_start_booking_reason_boolean_ask_enum class-attribute instance-attribute

check_in_update_start_booking_reason_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInUpdateStartBookingReason_BooleanAskEnum'})

Update booking start reason on check-in.

check_out_date_actual_decrease_boolean_ask_enum class-attribute instance-attribute

check_out_date_actual_decrease_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActualDecrease_BooleanAskEnum'})

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

check_out_date_actual_increase_boolean_ask_enum class-attribute instance-attribute

check_out_date_actual_increase_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActualIncrease_BooleanAskEnum'})

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

check_out_default_end_booking_reason_id class-attribute instance-attribute

check_out_default_end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'CheckOutDefaultEnd_BookingReasonID'})

The default booking end reason when checking out.

check_out_update_end_booking_reason_boolean_ask_enum class-attribute instance-attribute

check_out_update_end_booking_reason_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutUpdateEndBookingReason_BooleanAskEnum'})

Update booking end reason on check-out.

contract_date_check_in_decrease_boolean_ask_enum class-attribute instance-attribute

contract_date_check_in_decrease_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateCheckInDecrease_BooleanAskEnum'})

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

contract_date_check_in_increase_boolean_ask_enum class-attribute instance-attribute

contract_date_check_in_increase_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateCheckInIncrease_BooleanAskEnum'})

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

contract_date_check_out_decrease_boolean_ask_enum class-attribute instance-attribute

contract_date_check_out_decrease_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateCheckOutDecrease_BooleanAskEnum'})

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

contract_date_check_out_increase_boolean_ask_enum class-attribute instance-attribute

contract_date_check_out_increase_boolean_ask_enum: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateCheckOutIncrease_BooleanAskEnum'})

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

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Term description.

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

Pointer to the end booking reason record.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

Entry status.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Minutes since midnight for estimated time of arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Minutes since midnight for estimated time of departure.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

Pointer to the house-keeping record.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

Fixed room location.

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the address room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Room rate amount.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Pointer to the room rate record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

Pointer to the start booking reason record.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

term_session_code class-attribute instance-attribute

term_session_code: Optional[str] = field(default=None, metadata={'wire_name': 'TermSessionCode'})

Term session code.

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Unique ID for this term session record.

use_active_booking_as_template class-attribute instance-attribute

use_active_booking_as_template: Optional[bool] = field(default=None, metadata={'wire_name': 'UseActiveBookingAsTemplate'})

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

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

Term Session displayed in PortalX.

SelectEntryDetailInput dataclass

SelectEntryDetailInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, academic_hold: Optional[bool] = None, account_payment_type_id: Optional[int] = None, account_hold: Optional[bool] = None, account_bank_name: Optional[str] = None, account_bank_number: Optional[str] = None, account_code: Optional[str] = None, account_comments: Optional[str] = None, account_detail1: Optional[str] = None, account_detail2: Optional[str] = None, account_detail3: Optional[str] = None, account_detail4: Optional[str] = None, account_due_date: Optional[Dict[str, Any]] = None, athlete: Optional[bool] = None, athlete_team: Optional[str] = None, attendee_status_enum: Optional[str] = None, career: Optional[str] = None, career_comments: Optional[str] = None, citizenship_country_id: Optional[int] = None, classification_id: Optional[int] = None, classification_override: Optional[bool] = None, comments: Optional[str] = None, country_of_birth_country_id: Optional[int] = None, country_of_residence_country_id: Optional[int] = None, cumulative_g_p_a: Optional[float] = None, cumulative_hours: Optional[float] = None, current_g_p_a: Optional[float] = None, current_hours: Optional[float] = None, current_major: Optional[str] = None, current_minor: Optional[str] = None, date_entry: Optional[Dict[str, Any]] = None, date_exit: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, deceased: Optional[bool] = None, deceased_date: Optional[Dict[str, Any]] = None, dietary: Optional[str] = None, disability: Optional[str] = None, employment_details: Optional[str] = None, enrollment_class: Optional[str] = None, enrollment_level: Optional[str] = None, enrollment_status: Optional[str] = None, enrollment_term: Optional[str] = None, enrollment_year: Optional[int] = None, entry_detail_id: Optional[int] = None, entry_id: Optional[int] = None, ethnicity: Optional[str] = None, event_registration_fee_id: Optional[int] = None, expected_graduation_date: Optional[Dict[str, Any]] = None, financial_comments: Optional[str] = None, financial_support_id: Optional[int] = None, hear_about_us: Optional[str] = None, honors_indicator: Optional[bool] = None, immunizations_hold: Optional[bool] = None, incident_hold: Optional[bool] = None, incident_hold_comments: Optional[str] = None, international: Optional[bool] = None, international_details: Optional[str] = None, living_with_dependents: Optional[bool] = None, married: Optional[bool] = None, medical: Optional[str] = None, nationality_id: Optional[int] = None, occupation: Optional[str] = None, photo_path: Optional[str] = None, previous_member_name: Optional[str] = None, previous_member_relationship: Optional[str] = None, previous_membership: Optional[str] = None, previous_membership_years: Optional[str] = None, previous_member_years: Optional[str] = None, profile_interests: Optional[str] = None, region_of_birth_id: Optional[int] = None, religion: Optional[str] = None, residency: Optional[str] = None, resident_status: Optional[str] = None, resident_year: Optional[int] = None, situation_response_comments: Optional[str] = None, situation_response_detail: Optional[str] = None, situation_response_enum: Optional[str] = None, situation_response_expiry_date: Optional[Dict[str, Any]] = None, situation_response_modified_date: Optional[Dict[str, Any]] = None, situation_response_situation: Optional[str] = None, special_needs: Optional[str] = None, staff_id: Optional[int] = None, uses_screen_reader: Optional[bool] = None, vehicle_details: Optional[str] = None, vehicle_permit: Optional[str] = None, vehicle_registration: Optional[str] = None, veteran_status: Optional[str] = None, visa: Optional[bool] = None, visa_details: Optional[str] = None, visitor_hold: Optional[bool] = None)

Get Entry Detail

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

academic_hold class-attribute instance-attribute

academic_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AcademicHold'})

Indicates if the academic hold flag has been set.

account_payment_type_id class-attribute instance-attribute

account_payment_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'Account_PaymentTypeID'})

Pointer to the payment type record.

account_hold class-attribute instance-attribute

account_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AccountHold'})

Indicates if the account hold flag has been set.

account_bank_name class-attribute instance-attribute

account_bank_name: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankName'})

Account bank name.

account_bank_number class-attribute instance-attribute

account_bank_number: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankNumber'})

Account bank number.

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

account_comments class-attribute instance-attribute

account_comments: Optional[str] = field(default=None, metadata={'wire_name': 'AccountComments'})

Account comments.

account_detail1 class-attribute instance-attribute

account_detail1: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail1'})

Account detail.

account_detail2 class-attribute instance-attribute

account_detail2: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail2'})

Account detail.

account_detail3 class-attribute instance-attribute

account_detail3: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail3'})

Account detail.

account_detail4 class-attribute instance-attribute

account_detail4: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail4'})

Account detail.

athlete class-attribute instance-attribute

athlete: Optional[bool] = field(default=None, metadata={'wire_name': 'Athlete'})

Indicates if the athlete flag has been set.

athlete_team class-attribute instance-attribute

athlete_team: Optional[str] = field(default=None, metadata={'wire_name': 'AthleteTeam'})

Athlete team.

attendee_status_enum class-attribute instance-attribute

attendee_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AttendeeStatusEnum'})

Attendee status.

career class-attribute instance-attribute

career: Optional[str] = field(default=None, metadata={'wire_name': 'Career'})

Intended career.

career_comments class-attribute instance-attribute

career_comments: Optional[str] = field(default=None, metadata={'wire_name': 'CareerComments'})

Reasons for choosing intended career.

citizenship_country_id class-attribute instance-attribute

citizenship_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'Citizenship_CountryID'})

Pointer to the citizenship record.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

classification_override class-attribute instance-attribute

classification_override: Optional[bool] = field(default=None, metadata={'wire_name': 'ClassificationOverride'})

Classification override.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments.

country_of_birth_country_id class-attribute instance-attribute

country_of_birth_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfBirth_CountryID'})

Pointer to the country of birth record.

country_of_residence_country_id class-attribute instance-attribute

country_of_residence_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfResidence_CountryID'})

Pointer to the country of residence record.

cumulative_g_p_a class-attribute instance-attribute

cumulative_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeGPA'})

Cumulative GPA.

cumulative_hours class-attribute instance-attribute

cumulative_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeHours'})

Cumulative hours.

current_g_p_a class-attribute instance-attribute

current_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentGPA'})

Current GPA.

current_hours class-attribute instance-attribute

current_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentHours'})

Current hours.

current_major class-attribute instance-attribute

current_major: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMajor'})

The major chosen by the Entry.

current_minor class-attribute instance-attribute

current_minor: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMinor'})

The minor chosen by the Entry.

deceased class-attribute instance-attribute

deceased: Optional[bool] = field(default=None, metadata={'wire_name': 'Deceased'})

Indicates if the Entry is deceased.

dietary class-attribute instance-attribute

dietary: Optional[str] = field(default=None, metadata={'wire_name': 'Dietary'})

Dietary requirements.

disability class-attribute instance-attribute

disability: Optional[str] = field(default=None, metadata={'wire_name': 'Disability'})

Disability.

employment_details class-attribute instance-attribute

employment_details: Optional[str] = field(default=None, metadata={'wire_name': 'EmploymentDetails'})

Employment details.

enrollment_class class-attribute instance-attribute

enrollment_class: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentClass'})

First year, freshman, sophomore, etc.

enrollment_level class-attribute instance-attribute

enrollment_level: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentLevel'})

Undergraduate, post graduate, etc.

enrollment_status class-attribute instance-attribute

enrollment_status: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentStatus'})

Newly admitted, current, active, etc.

enrollment_term class-attribute instance-attribute

enrollment_term: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTerm'})

Spring, fall, post graduate, etc.

enrollment_year class-attribute instance-attribute

enrollment_year: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentYear'})

Year/Level of enrollment.

entry_detail_id class-attribute instance-attribute

entry_detail_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryDetailID'})

Unique ID for this entry detail record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

ethnicity class-attribute instance-attribute

ethnicity: Optional[str] = field(default=None, metadata={'wire_name': 'Ethnicity'})

Ethnicity.

event_registration_fee_id class-attribute instance-attribute

event_registration_fee_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventRegistrationFeeID'})

Pointer to the event registration fee record.

financial_comments class-attribute instance-attribute

financial_comments: Optional[str] = field(default=None, metadata={'wire_name': 'FinancialComments'})

Financial support comments.

financial_support_id class-attribute instance-attribute

financial_support_id: Optional[int] = field(default=None, metadata={'wire_name': 'FinancialSupportID'})

Pointer to the financial support record.

hear_about_us class-attribute instance-attribute

hear_about_us: Optional[str] = field(default=None, metadata={'wire_name': 'HearAboutUs'})

How did the Entry hear about us.

honors_indicator class-attribute instance-attribute

honors_indicator: Optional[bool] = field(default=None, metadata={'wire_name': 'HonorsIndicator'})

Honors indicator.

immunizations_hold class-attribute instance-attribute

immunizations_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'ImmunizationsHold'})

Immunizations hold.

incident_hold class-attribute instance-attribute

incident_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'IncidentHold'})

Incident hold.

incident_hold_comments class-attribute instance-attribute

incident_hold_comments: Optional[str] = field(default=None, metadata={'wire_name': 'IncidentHoldComments'})

Incident hold comments.

international class-attribute instance-attribute

international: Optional[bool] = field(default=None, metadata={'wire_name': 'International'})

Indicates if the Entry is considered an international student.

international_details class-attribute instance-attribute

international_details: Optional[str] = field(default=None, metadata={'wire_name': 'InternationalDetails'})

International details.

living_with_dependents class-attribute instance-attribute

living_with_dependents: Optional[bool] = field(default=None, metadata={'wire_name': 'LivingWithDependents'})

Living with dependents.

married class-attribute instance-attribute

married: Optional[bool] = field(default=None, metadata={'wire_name': 'Married'})

Indicates if the Entry is married.

medical class-attribute instance-attribute

medical: Optional[str] = field(default=None, metadata={'wire_name': 'Medical'})

Medical details.

nationality_id class-attribute instance-attribute

nationality_id: Optional[int] = field(default=None, metadata={'wire_name': 'NationalityID'})

Pointer to the nationality record.

occupation class-attribute instance-attribute

occupation: Optional[str] = field(default=None, metadata={'wire_name': 'Occupation'})

Occupation.

photo_path class-attribute instance-attribute

photo_path: Optional[str] = field(default=None, metadata={'wire_name': 'PhotoPath'})

Photo path.

previous_member_name class-attribute instance-attribute

previous_member_name: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberName'})

Previous member name.

previous_member_relationship class-attribute instance-attribute

previous_member_relationship: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberRelationship'})

Previous member relationship.

previous_membership class-attribute instance-attribute

previous_membership: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembership'})

Previous membership.

previous_membership_years class-attribute instance-attribute

previous_membership_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembershipYears'})

Previous membership years.

previous_member_years class-attribute instance-attribute

previous_member_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberYears'})

Previous member years.

profile_interests class-attribute instance-attribute

profile_interests: Optional[str] = field(default=None, metadata={'wire_name': 'ProfileInterests'})

Profile interests.

region_of_birth_id class-attribute instance-attribute

region_of_birth_id: Optional[int] = field(default=None, metadata={'wire_name': 'RegionOfBirthID'})

Pointer to the Region of birth record.

religion class-attribute instance-attribute

religion: Optional[str] = field(default=None, metadata={'wire_name': 'Religion'})

Religion.

residency class-attribute instance-attribute

residency: Optional[str] = field(default=None, metadata={'wire_name': 'Residency'})

Residency.

resident_status class-attribute instance-attribute

resident_status: Optional[str] = field(default=None, metadata={'wire_name': 'ResidentStatus'})

Resident status.

resident_year class-attribute instance-attribute

resident_year: Optional[int] = field(default=None, metadata={'wire_name': 'ResidentYear'})

Resident year.

situation_response_comments class-attribute instance-attribute

situation_response_comments: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseComments'})

Situation response comments.

situation_response_detail class-attribute instance-attribute

situation_response_detail: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseDetail'})

Situation response detail.

situation_response_enum class-attribute instance-attribute

situation_response_enum: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseEnum'})

Situation response.

situation_response_situation class-attribute instance-attribute

situation_response_situation: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseSituation'})

Situation response situation.

special_needs class-attribute instance-attribute

special_needs: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialNeeds'})

Special needs.

staff_id class-attribute instance-attribute

staff_id: Optional[int] = field(default=None, metadata={'wire_name': 'StaffID'})

Pointer to the staff record.

uses_screen_reader class-attribute instance-attribute

uses_screen_reader: Optional[bool] = field(default=None, metadata={'wire_name': 'UsesScreenReader'})

Uses screen reader.

vehicle_details class-attribute instance-attribute

vehicle_details: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleDetails'})

Vehicle details.

vehicle_permit class-attribute instance-attribute

vehicle_permit: Optional[str] = field(default=None, metadata={'wire_name': 'VehiclePermit'})

Vehicle permit.

vehicle_registration class-attribute instance-attribute

vehicle_registration: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleRegistration'})

Vehicle registration.

veteran_status class-attribute instance-attribute

veteran_status: Optional[str] = field(default=None, metadata={'wire_name': 'VeteranStatus'})

Veteran status.

visa class-attribute instance-attribute

visa: Optional[bool] = field(default=None, metadata={'wire_name': 'Visa'})

Indicates if the Entry holds a visa.

visa_details class-attribute instance-attribute

visa_details: Optional[str] = field(default=None, metadata={'wire_name': 'VisaDetails'})

Visa details.

visitor_hold class-attribute instance-attribute

visitor_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'VisitorHold'})

Visitor hold.

UpdateEntryDetailInput dataclass

UpdateEntryDetailInput(academic_hold: Optional[bool] = None, account_payment_type_id: Optional[int] = None, account_bank_name: Optional[str] = None, account_bank_number: Optional[str] = None, account_code: Optional[str] = None, account_comments: Optional[str] = None, account_detail1: Optional[str] = None, account_detail2: Optional[str] = None, account_detail3: Optional[str] = None, account_detail4: Optional[str] = None, account_due_date: Optional[str] = None, account_hold: Optional[bool] = None, athlete: Optional[bool] = None, athlete_team: Optional[str] = None, attendee_status_enum: Optional[str] = None, career: Optional[str] = None, career_comments: Optional[str] = None, citizenship_country_id: Optional[int] = None, classification_id: Optional[int] = None, classification_override: Optional[bool] = None, comments: Optional[str] = None, country_of_birth_country_id: Optional[int] = None, country_of_residence_country_id: Optional[int] = None, cumulative_g_p_a: Optional[float] = None, cumulative_hours: Optional[float] = None, current_g_p_a: Optional[float] = None, current_hours: Optional[float] = None, current_major: Optional[str] = None, current_minor: Optional[str] = None, date_entry: Optional[str] = None, date_exit: Optional[str] = None, deceased: Optional[bool] = None, deceased_date: Optional[str] = None, dietary: Optional[str] = None, disability: Optional[str] = None, employment_details: Optional[str] = None, enrollment_class: Optional[str] = None, enrollment_level: Optional[str] = None, enrollment_status: Optional[str] = None, enrollment_term: Optional[str] = None, enrollment_year: Optional[int] = None, entry_detail_id: Optional[int] = None, entry_id: Optional[int] = None, ethnicity: Optional[str] = None, event_registration_fee_id: Optional[int] = None, expected_graduation_date: Optional[str] = None, financial_comments: Optional[str] = None, financial_support_id: Optional[int] = None, hear_about_us: Optional[str] = None, honors_indicator: Optional[bool] = None, immunizations_hold: Optional[bool] = None, incident_hold: Optional[bool] = None, incident_hold_comments: Optional[str] = None, international: Optional[bool] = None, international_details: Optional[str] = None, living_with_dependents: Optional[bool] = None, married: Optional[bool] = None, medical: Optional[str] = None, nationality_id: Optional[int] = None, occupation: Optional[str] = None, photo_path: Optional[str] = None, previous_member_name: Optional[str] = None, previous_member_relationship: Optional[str] = None, previous_membership: Optional[str] = None, previous_membership_years: Optional[str] = None, previous_member_years: Optional[str] = None, profile_interests: Optional[str] = None, region_of_birth_id: Optional[int] = None, religion: Optional[str] = None, residency: Optional[str] = None, resident_status: Optional[str] = None, resident_year: Optional[int] = None, situation_response_comments: Optional[str] = None, situation_response_detail: Optional[str] = None, situation_response_enum: Optional[str] = None, situation_response_expiry_date: Optional[str] = None, situation_response_modified_date: Optional[str] = None, situation_response_situation: Optional[str] = None, special_needs: Optional[str] = None, staff_id: Optional[int] = None, uses_screen_reader: Optional[bool] = None, vehicle_details: Optional[str] = None, vehicle_permit: Optional[str] = None, vehicle_registration: Optional[str] = None, veteran_status: Optional[str] = None, visa: Optional[bool] = None, visa_details: Optional[str] = None, visitor_hold: Optional[bool] = None)

Update Entry Detail

Attributes

academic_hold class-attribute instance-attribute

academic_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AcademicHold'})

Indicates if the academic hold flag has been set.

account_payment_type_id class-attribute instance-attribute

account_payment_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'Account_PaymentTypeID'})

Pointer to the preferred payment type record.

account_bank_name class-attribute instance-attribute

account_bank_name: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankName'})

Account bank name.

account_bank_number class-attribute instance-attribute

account_bank_number: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankNumber'})

Account bank number.

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

account_comments class-attribute instance-attribute

account_comments: Optional[str] = field(default=None, metadata={'wire_name': 'AccountComments'})

Account comments.

account_detail1 class-attribute instance-attribute

account_detail1: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail1'})

Account detail.

account_detail2 class-attribute instance-attribute

account_detail2: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail2'})

Account detail.

account_detail3 class-attribute instance-attribute

account_detail3: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail3'})

Account detail.

account_detail4 class-attribute instance-attribute

account_detail4: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail4'})

Account detail.

account_due_date class-attribute instance-attribute

account_due_date: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDueDate'})

Paid to date.

account_hold class-attribute instance-attribute

account_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AccountHold'})

Indicates if the account hold flag has been set.

athlete class-attribute instance-attribute

athlete: Optional[bool] = field(default=None, metadata={'wire_name': 'Athlete'})

Indicates if the athlete flag has been set.

athlete_team class-attribute instance-attribute

athlete_team: Optional[str] = field(default=None, metadata={'wire_name': 'AthleteTeam'})

Athlete team.

attendee_status_enum class-attribute instance-attribute

attendee_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AttendeeStatusEnum'})

Attendee status.

career class-attribute instance-attribute

career: Optional[str] = field(default=None, metadata={'wire_name': 'Career'})

Intended career.

career_comments class-attribute instance-attribute

career_comments: Optional[str] = field(default=None, metadata={'wire_name': 'CareerComments'})

Reasons for choosing intended career.

citizenship_country_id class-attribute instance-attribute

citizenship_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'Citizenship_CountryID'})

Pointer to the citizenship record.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

classification_override class-attribute instance-attribute

classification_override: Optional[bool] = field(default=None, metadata={'wire_name': 'ClassificationOverride'})

Classification override.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments.

country_of_birth_country_id class-attribute instance-attribute

country_of_birth_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfBirth_CountryID'})

Pointer to the country of birth record.

country_of_residence_country_id class-attribute instance-attribute

country_of_residence_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfResidence_CountryID'})

Pointer to the country of residence record.

cumulative_g_p_a class-attribute instance-attribute

cumulative_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeGPA'})

Cumulative GPA.

cumulative_hours class-attribute instance-attribute

cumulative_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeHours'})

Cumulative hours.

current_g_p_a class-attribute instance-attribute

current_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentGPA'})

Current GPA.

current_hours class-attribute instance-attribute

current_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentHours'})

Current hours.

current_major class-attribute instance-attribute

current_major: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMajor'})

The major chosen by the Entry.

current_minor class-attribute instance-attribute

current_minor: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMinor'})

The minor chosen by the Entry.

date_entry class-attribute instance-attribute

date_entry: Optional[str] = field(default=None, metadata={'wire_name': 'DateEntry'})

Entry date.

date_exit class-attribute instance-attribute

date_exit: Optional[str] = field(default=None, metadata={'wire_name': 'DateExit'})

Exit date.

deceased class-attribute instance-attribute

deceased: Optional[bool] = field(default=None, metadata={'wire_name': 'Deceased'})

Indicates if the Entry is deceased.

deceased_date class-attribute instance-attribute

deceased_date: Optional[str] = field(default=None, metadata={'wire_name': 'DeceasedDate'})

Deceased date.

dietary class-attribute instance-attribute

dietary: Optional[str] = field(default=None, metadata={'wire_name': 'Dietary'})

Dietary requirements.

disability class-attribute instance-attribute

disability: Optional[str] = field(default=None, metadata={'wire_name': 'Disability'})

Disability.

employment_details class-attribute instance-attribute

employment_details: Optional[str] = field(default=None, metadata={'wire_name': 'EmploymentDetails'})

Employment details.

enrollment_class class-attribute instance-attribute

enrollment_class: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentClass'})

First year, freshman, sophomore, etc.

enrollment_level class-attribute instance-attribute

enrollment_level: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentLevel'})

Undergraduate, post graduate, etc.

enrollment_status class-attribute instance-attribute

enrollment_status: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentStatus'})

Newly admitted, current, active, etc.

enrollment_term class-attribute instance-attribute

enrollment_term: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTerm'})

Spring, fall, post graduate, etc.

enrollment_year class-attribute instance-attribute

enrollment_year: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentYear'})

Year/Level of enrollment.

entry_detail_id class-attribute instance-attribute

entry_detail_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryDetailID'})

Unique ID for this entry detail record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

ethnicity class-attribute instance-attribute

ethnicity: Optional[str] = field(default=None, metadata={'wire_name': 'Ethnicity'})

Ethnicity.

event_registration_fee_id class-attribute instance-attribute

event_registration_fee_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventRegistrationFeeID'})

Pointer to the Event registration fee record.

expected_graduation_date class-attribute instance-attribute

expected_graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedGraduationDate'})

Expected graduation date.

financial_comments class-attribute instance-attribute

financial_comments: Optional[str] = field(default=None, metadata={'wire_name': 'FinancialComments'})

Financial support comments.

financial_support_id class-attribute instance-attribute

financial_support_id: Optional[int] = field(default=None, metadata={'wire_name': 'FinancialSupportID'})

Pointer to the financial support record.

hear_about_us class-attribute instance-attribute

hear_about_us: Optional[str] = field(default=None, metadata={'wire_name': 'HearAboutUs'})

How did the Entry hear about us.

honors_indicator class-attribute instance-attribute

honors_indicator: Optional[bool] = field(default=None, metadata={'wire_name': 'HonorsIndicator'})

Honors indicator.

immunizations_hold class-attribute instance-attribute

immunizations_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'ImmunizationsHold'})

Immunizations hold.

incident_hold class-attribute instance-attribute

incident_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'IncidentHold'})

Incident hold.

incident_hold_comments class-attribute instance-attribute

incident_hold_comments: Optional[str] = field(default=None, metadata={'wire_name': 'IncidentHoldComments'})

Incident hold comments.

international class-attribute instance-attribute

international: Optional[bool] = field(default=None, metadata={'wire_name': 'International'})

Indicates if the Entry is considered an international student.

international_details class-attribute instance-attribute

international_details: Optional[str] = field(default=None, metadata={'wire_name': 'InternationalDetails'})

International details.

living_with_dependents class-attribute instance-attribute

living_with_dependents: Optional[bool] = field(default=None, metadata={'wire_name': 'LivingWithDependents'})

Living with dependents.

married class-attribute instance-attribute

married: Optional[bool] = field(default=None, metadata={'wire_name': 'Married'})

Indicates if the Entry is married.

medical class-attribute instance-attribute

medical: Optional[str] = field(default=None, metadata={'wire_name': 'Medical'})

Medical details.

nationality_id class-attribute instance-attribute

nationality_id: Optional[int] = field(default=None, metadata={'wire_name': 'NationalityID'})

Pointer to the nationality record.

occupation class-attribute instance-attribute

occupation: Optional[str] = field(default=None, metadata={'wire_name': 'Occupation'})

Occupation.

photo_path class-attribute instance-attribute

photo_path: Optional[str] = field(default=None, metadata={'wire_name': 'PhotoPath'})

Photo path.

previous_member_name class-attribute instance-attribute

previous_member_name: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberName'})

Previous member name.

previous_member_relationship class-attribute instance-attribute

previous_member_relationship: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberRelationship'})

Previous member relationship.

previous_membership class-attribute instance-attribute

previous_membership: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembership'})

Previous membership.

previous_membership_years class-attribute instance-attribute

previous_membership_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembershipYears'})

Previous membership years.

previous_member_years class-attribute instance-attribute

previous_member_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberYears'})

Previous member years.

profile_interests class-attribute instance-attribute

profile_interests: Optional[str] = field(default=None, metadata={'wire_name': 'ProfileInterests'})

Profile interests.

region_of_birth_id class-attribute instance-attribute

region_of_birth_id: Optional[int] = field(default=None, metadata={'wire_name': 'RegionOfBirthID'})

Pointer to the region of birth record.

religion class-attribute instance-attribute

religion: Optional[str] = field(default=None, metadata={'wire_name': 'Religion'})

Religion.

residency class-attribute instance-attribute

residency: Optional[str] = field(default=None, metadata={'wire_name': 'Residency'})

Residency.

resident_status class-attribute instance-attribute

resident_status: Optional[str] = field(default=None, metadata={'wire_name': 'ResidentStatus'})

Resident status.

resident_year class-attribute instance-attribute

resident_year: Optional[int] = field(default=None, metadata={'wire_name': 'ResidentYear'})

Resident year.

situation_response_comments class-attribute instance-attribute

situation_response_comments: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseComments'})

Situation response comments.

situation_response_detail class-attribute instance-attribute

situation_response_detail: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseDetail'})

Situation response detail.

situation_response_enum class-attribute instance-attribute

situation_response_enum: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseEnum'})

Situation response.

situation_response_expiry_date class-attribute instance-attribute

situation_response_expiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseExpiryDate'})

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

situation_response_modified_date class-attribute instance-attribute

situation_response_modified_date: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseModifiedDate'})

The date the response was last modified.

situation_response_situation class-attribute instance-attribute

situation_response_situation: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseSituation'})

Situation response situation.

special_needs class-attribute instance-attribute

special_needs: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialNeeds'})

Special needs.

staff_id class-attribute instance-attribute

staff_id: Optional[int] = field(default=None, metadata={'wire_name': 'StaffID'})

Pointer to the staff record.

uses_screen_reader class-attribute instance-attribute

uses_screen_reader: Optional[bool] = field(default=None, metadata={'wire_name': 'UsesScreenReader'})

Uses screen reader.

vehicle_details class-attribute instance-attribute

vehicle_details: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleDetails'})

Vehicle details.

vehicle_permit class-attribute instance-attribute

vehicle_permit: Optional[str] = field(default=None, metadata={'wire_name': 'VehiclePermit'})

Vehicle permit.

vehicle_registration class-attribute instance-attribute

vehicle_registration: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleRegistration'})

Vehicle registration.

veteran_status class-attribute instance-attribute

veteran_status: Optional[str] = field(default=None, metadata={'wire_name': 'VeteranStatus'})

Veteran status.

visa class-attribute instance-attribute

visa: Optional[bool] = field(default=None, metadata={'wire_name': 'Visa'})

Indicates if the Entry holds a visa.

visa_details class-attribute instance-attribute

visa_details: Optional[str] = field(default=None, metadata={'wire_name': 'VisaDetails'})

Visa details.

visitor_hold class-attribute instance-attribute

visitor_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'VisitorHold'})

Visitor hold.

UpdateEntryDetailResponse dataclass

UpdateEntryDetailResponse(academic_hold: Optional[bool] = None, account_payment_type_id: Optional[int] = None, account_bank_name: Optional[str] = None, account_bank_number: Optional[str] = None, account_code: Optional[str] = None, account_comments: Optional[str] = None, account_detail1: Optional[str] = None, account_detail2: Optional[str] = None, account_detail3: Optional[str] = None, account_detail4: Optional[str] = None, account_due_date: Optional[str] = None, account_hold: Optional[bool] = None, athlete: Optional[bool] = None, athlete_team: Optional[str] = None, attendee_status_enum: Optional[str] = None, career: Optional[str] = None, career_comments: Optional[str] = None, citizenship_country_id: Optional[int] = None, classification_id: Optional[int] = None, classification_override: Optional[bool] = None, comments: Optional[str] = None, country_of_birth_country_id: Optional[int] = None, country_of_residence_country_id: Optional[int] = None, cumulative_g_p_a: Optional[float] = None, cumulative_hours: Optional[float] = None, current_g_p_a: Optional[float] = None, current_hours: Optional[float] = None, current_major: Optional[str] = None, current_minor: Optional[str] = None, date_entry: Optional[str] = None, date_exit: Optional[str] = None, deceased: Optional[bool] = None, deceased_date: Optional[str] = None, dietary: Optional[str] = None, disability: Optional[str] = None, employment_details: Optional[str] = None, enrollment_class: Optional[str] = None, enrollment_level: Optional[str] = None, enrollment_status: Optional[str] = None, enrollment_term: Optional[str] = None, enrollment_year: Optional[int] = None, entry_detail_id: Optional[int] = None, entry_id: Optional[int] = None, ethnicity: Optional[str] = None, event_registration_fee_id: Optional[int] = None, expected_graduation_date: Optional[str] = None, financial_comments: Optional[str] = None, financial_support_id: Optional[int] = None, hear_about_us: Optional[str] = None, honors_indicator: Optional[bool] = None, immunizations_hold: Optional[bool] = None, incident_hold: Optional[bool] = None, incident_hold_comments: Optional[str] = None, international: Optional[bool] = None, international_details: Optional[str] = None, living_with_dependents: Optional[bool] = None, married: Optional[bool] = None, medical: Optional[str] = None, nationality_id: Optional[int] = None, occupation: Optional[str] = None, photo_path: Optional[str] = None, previous_member_name: Optional[str] = None, previous_member_relationship: Optional[str] = None, previous_membership: Optional[str] = None, previous_membership_years: Optional[str] = None, previous_member_years: Optional[str] = None, profile_interests: Optional[str] = None, region_of_birth_id: Optional[int] = None, religion: Optional[str] = None, residency: Optional[str] = None, resident_status: Optional[str] = None, resident_year: Optional[int] = None, situation_response_comments: Optional[str] = None, situation_response_detail: Optional[str] = None, situation_response_enum: Optional[str] = None, situation_response_expiry_date: Optional[str] = None, situation_response_modified_date: Optional[str] = None, situation_response_situation: Optional[str] = None, special_needs: Optional[str] = None, staff_id: Optional[int] = None, uses_screen_reader: Optional[bool] = None, vehicle_details: Optional[str] = None, vehicle_permit: Optional[str] = None, vehicle_registration: Optional[str] = None, veteran_status: Optional[str] = None, visa: Optional[bool] = None, visa_details: Optional[str] = None, visitor_hold: Optional[bool] = None)

Response for Update Entry Detail

Attributes

academic_hold class-attribute instance-attribute

academic_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AcademicHold'})

Indicates if the academic hold flag has been set.

account_payment_type_id class-attribute instance-attribute

account_payment_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'Account_PaymentTypeID'})

Pointer to the preferred payment type record.

account_bank_name class-attribute instance-attribute

account_bank_name: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankName'})

Account bank name.

account_bank_number class-attribute instance-attribute

account_bank_number: Optional[str] = field(default=None, metadata={'wire_name': 'AccountBankNumber'})

Account bank number.

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

account_comments class-attribute instance-attribute

account_comments: Optional[str] = field(default=None, metadata={'wire_name': 'AccountComments'})

Account comments.

account_detail1 class-attribute instance-attribute

account_detail1: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail1'})

Account detail.

account_detail2 class-attribute instance-attribute

account_detail2: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail2'})

Account detail.

account_detail3 class-attribute instance-attribute

account_detail3: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail3'})

Account detail.

account_detail4 class-attribute instance-attribute

account_detail4: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDetail4'})

Account detail.

account_due_date class-attribute instance-attribute

account_due_date: Optional[str] = field(default=None, metadata={'wire_name': 'AccountDueDate'})

Paid to date.

account_hold class-attribute instance-attribute

account_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'AccountHold'})

Indicates if the account hold flag has been set.

athlete class-attribute instance-attribute

athlete: Optional[bool] = field(default=None, metadata={'wire_name': 'Athlete'})

Indicates if the athlete flag has been set.

athlete_team class-attribute instance-attribute

athlete_team: Optional[str] = field(default=None, metadata={'wire_name': 'AthleteTeam'})

Athlete team.

attendee_status_enum class-attribute instance-attribute

attendee_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'AttendeeStatusEnum'})

Attendee status.

career class-attribute instance-attribute

career: Optional[str] = field(default=None, metadata={'wire_name': 'Career'})

Intended career.

career_comments class-attribute instance-attribute

career_comments: Optional[str] = field(default=None, metadata={'wire_name': 'CareerComments'})

Reasons for choosing intended career.

citizenship_country_id class-attribute instance-attribute

citizenship_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'Citizenship_CountryID'})

Pointer to the citizenship record.

classification_id class-attribute instance-attribute

classification_id: Optional[int] = field(default=None, metadata={'wire_name': 'ClassificationID'})

Pointer to the classification record.

classification_override class-attribute instance-attribute

classification_override: Optional[bool] = field(default=None, metadata={'wire_name': 'ClassificationOverride'})

Classification override.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments.

country_of_birth_country_id class-attribute instance-attribute

country_of_birth_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfBirth_CountryID'})

Pointer to the country of birth record.

country_of_residence_country_id class-attribute instance-attribute

country_of_residence_country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryOfResidence_CountryID'})

Pointer to the country of residence record.

cumulative_g_p_a class-attribute instance-attribute

cumulative_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeGPA'})

Cumulative GPA.

cumulative_hours class-attribute instance-attribute

cumulative_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CumulativeHours'})

Cumulative hours.

current_g_p_a class-attribute instance-attribute

current_g_p_a: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentGPA'})

Current GPA.

current_hours class-attribute instance-attribute

current_hours: Optional[float] = field(default=None, metadata={'wire_name': 'CurrentHours'})

Current hours.

current_major class-attribute instance-attribute

current_major: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMajor'})

The major chosen by the Entry.

current_minor class-attribute instance-attribute

current_minor: Optional[str] = field(default=None, metadata={'wire_name': 'CurrentMinor'})

The minor chosen by the Entry.

date_entry class-attribute instance-attribute

date_entry: Optional[str] = field(default=None, metadata={'wire_name': 'DateEntry'})

Entry date.

date_exit class-attribute instance-attribute

date_exit: Optional[str] = field(default=None, metadata={'wire_name': 'DateExit'})

Exit date.

deceased class-attribute instance-attribute

deceased: Optional[bool] = field(default=None, metadata={'wire_name': 'Deceased'})

Indicates if the Entry is deceased.

deceased_date class-attribute instance-attribute

deceased_date: Optional[str] = field(default=None, metadata={'wire_name': 'DeceasedDate'})

Deceased date.

dietary class-attribute instance-attribute

dietary: Optional[str] = field(default=None, metadata={'wire_name': 'Dietary'})

Dietary requirements.

disability class-attribute instance-attribute

disability: Optional[str] = field(default=None, metadata={'wire_name': 'Disability'})

Disability.

employment_details class-attribute instance-attribute

employment_details: Optional[str] = field(default=None, metadata={'wire_name': 'EmploymentDetails'})

Employment details.

enrollment_class class-attribute instance-attribute

enrollment_class: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentClass'})

First year, freshman, sophomore, etc.

enrollment_level class-attribute instance-attribute

enrollment_level: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentLevel'})

Undergraduate, post graduate, etc.

enrollment_status class-attribute instance-attribute

enrollment_status: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentStatus'})

Newly admitted, current, active, etc.

enrollment_term class-attribute instance-attribute

enrollment_term: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTerm'})

Spring, fall, post graduate, etc.

enrollment_year class-attribute instance-attribute

enrollment_year: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentYear'})

Year/Level of enrollment.

entry_detail_id class-attribute instance-attribute

entry_detail_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryDetailID'})

Unique ID for this entry detail record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

ethnicity class-attribute instance-attribute

ethnicity: Optional[str] = field(default=None, metadata={'wire_name': 'Ethnicity'})

Ethnicity.

event_registration_fee_id class-attribute instance-attribute

event_registration_fee_id: Optional[int] = field(default=None, metadata={'wire_name': 'EventRegistrationFeeID'})

Pointer to the event registration fee record.

expected_graduation_date class-attribute instance-attribute

expected_graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'ExpectedGraduationDate'})

Expected graduation date.

financial_comments class-attribute instance-attribute

financial_comments: Optional[str] = field(default=None, metadata={'wire_name': 'FinancialComments'})

Financial support comments.

financial_support_id class-attribute instance-attribute

financial_support_id: Optional[int] = field(default=None, metadata={'wire_name': 'FinancialSupportID'})

Pointer to the financial support fee record.

hear_about_us class-attribute instance-attribute

hear_about_us: Optional[str] = field(default=None, metadata={'wire_name': 'HearAboutUs'})

How did the Entry hear about us.

honors_indicator class-attribute instance-attribute

honors_indicator: Optional[bool] = field(default=None, metadata={'wire_name': 'HonorsIndicator'})

Honors indicator.

immunizations_hold class-attribute instance-attribute

immunizations_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'ImmunizationsHold'})

Immunizations hold.

incident_hold class-attribute instance-attribute

incident_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'IncidentHold'})

Incident hold.

incident_hold_comments class-attribute instance-attribute

incident_hold_comments: Optional[str] = field(default=None, metadata={'wire_name': 'IncidentHoldComments'})

Incident hold comments.

international class-attribute instance-attribute

international: Optional[bool] = field(default=None, metadata={'wire_name': 'International'})

Indicates if the Entry is considered an international student.

international_details class-attribute instance-attribute

international_details: Optional[str] = field(default=None, metadata={'wire_name': 'InternationalDetails'})

International details.

living_with_dependents class-attribute instance-attribute

living_with_dependents: Optional[bool] = field(default=None, metadata={'wire_name': 'LivingWithDependents'})

Living with dependents.

married class-attribute instance-attribute

married: Optional[bool] = field(default=None, metadata={'wire_name': 'Married'})

Indicates if the Entry is married.

medical class-attribute instance-attribute

medical: Optional[str] = field(default=None, metadata={'wire_name': 'Medical'})

Medical details.

nationality_id class-attribute instance-attribute

nationality_id: Optional[int] = field(default=None, metadata={'wire_name': 'NationalityID'})

Pointer to the nationality record.

occupation class-attribute instance-attribute

occupation: Optional[str] = field(default=None, metadata={'wire_name': 'Occupation'})

Occupation.

photo_path class-attribute instance-attribute

photo_path: Optional[str] = field(default=None, metadata={'wire_name': 'PhotoPath'})

Photo path.

previous_member_name class-attribute instance-attribute

previous_member_name: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberName'})

Previous member name.

previous_member_relationship class-attribute instance-attribute

previous_member_relationship: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberRelationship'})

Previous member relationship.

previous_membership class-attribute instance-attribute

previous_membership: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembership'})

Previous membership.

previous_membership_years class-attribute instance-attribute

previous_membership_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMembershipYears'})

Previous membership years.

previous_member_years class-attribute instance-attribute

previous_member_years: Optional[str] = field(default=None, metadata={'wire_name': 'PreviousMemberYears'})

Previous member years.

profile_interests class-attribute instance-attribute

profile_interests: Optional[str] = field(default=None, metadata={'wire_name': 'ProfileInterests'})

Profile interests.

region_of_birth_id class-attribute instance-attribute

region_of_birth_id: Optional[int] = field(default=None, metadata={'wire_name': 'RegionOfBirthID'})

Pointer to the region of birth record.

religion class-attribute instance-attribute

religion: Optional[str] = field(default=None, metadata={'wire_name': 'Religion'})

Religion.

residency class-attribute instance-attribute

residency: Optional[str] = field(default=None, metadata={'wire_name': 'Residency'})

Residency.

resident_status class-attribute instance-attribute

resident_status: Optional[str] = field(default=None, metadata={'wire_name': 'ResidentStatus'})

Resident status.

resident_year class-attribute instance-attribute

resident_year: Optional[int] = field(default=None, metadata={'wire_name': 'ResidentYear'})

Resident year.

situation_response_comments class-attribute instance-attribute

situation_response_comments: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseComments'})

Situation response comments.

situation_response_detail class-attribute instance-attribute

situation_response_detail: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseDetail'})

Situation response detail.

situation_response_enum class-attribute instance-attribute

situation_response_enum: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseEnum'})

Situation response.

situation_response_expiry_date class-attribute instance-attribute

situation_response_expiry_date: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseExpiryDate'})

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

situation_response_modified_date class-attribute instance-attribute

situation_response_modified_date: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseModifiedDate'})

The date the response was last modified.

situation_response_situation class-attribute instance-attribute

situation_response_situation: Optional[str] = field(default=None, metadata={'wire_name': 'SituationResponseSituation'})

Situation response situation.

special_needs class-attribute instance-attribute

special_needs: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialNeeds'})

Special needs.

staff_id class-attribute instance-attribute

staff_id: Optional[int] = field(default=None, metadata={'wire_name': 'StaffID'})

Pointer to the staff record.

uses_screen_reader class-attribute instance-attribute

uses_screen_reader: Optional[bool] = field(default=None, metadata={'wire_name': 'UsesScreenReader'})

Uses screen reader.

vehicle_details class-attribute instance-attribute

vehicle_details: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleDetails'})

Vehicle details.

vehicle_permit class-attribute instance-attribute

vehicle_permit: Optional[str] = field(default=None, metadata={'wire_name': 'VehiclePermit'})

Vehicle permit.

vehicle_registration class-attribute instance-attribute

vehicle_registration: Optional[str] = field(default=None, metadata={'wire_name': 'VehicleRegistration'})

Vehicle registration.

veteran_status class-attribute instance-attribute

veteran_status: Optional[str] = field(default=None, metadata={'wire_name': 'VeteranStatus'})

Veteran status.

visa class-attribute instance-attribute

visa: Optional[bool] = field(default=None, metadata={'wire_name': 'Visa'})

Indicates if the Entry holds a visa.

visa_details class-attribute instance-attribute

visa_details: Optional[str] = field(default=None, metadata={'wire_name': 'VisaDetails'})

Visa details.

visitor_hold class-attribute instance-attribute

visitor_hold: Optional[bool] = field(default=None, metadata={'wire_name': 'VisitorHold'})

Visitor hold.

SelectEntryEnrollmentInput dataclass

SelectEntryEnrollmentInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, campus: Optional[str] = None, comments: Optional[str] = None, course_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_end: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, date_start: Optional[Dict[str, Any]] = None, department: Optional[str] = None, enrollment_field: Optional[str] = None, enrollment_order: Optional[int] = None, enrollment_type_enum: Optional[str] = None, entry_enrollment_id: Optional[int] = None, entry_id: Optional[int] = None, faculty: Optional[str] = None, full_time: Optional[bool] = None, graduation_date: Optional[Dict[str, Any]] = None, institution: Optional[str] = None, is_enrolled: Optional[bool] = None, major: Optional[str] = None, major_category: Optional[str] = None, minor: Optional[str] = None, post_grad: Optional[bool] = None, sequence: Optional[int] = None, subjects: Optional[str] = None, term_id: Optional[int] = None, years: Optional[str] = None)

Get Entry Enrollment

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

campus class-attribute instance-attribute

campus: Optional[str] = field(default=None, metadata={'wire_name': 'Campus'})

Campus where entry is enrolled.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Enrollment comments.

course_id class-attribute instance-attribute

course_id: Optional[int] = field(default=None, metadata={'wire_name': 'CourseID'})

Pointer to the course record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

department class-attribute instance-attribute

department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

Department entry is enrolled in.

enrollment_field class-attribute instance-attribute

enrollment_field: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentField'})

Field of enrollment.

enrollment_order class-attribute instance-attribute

enrollment_order: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentOrder'})

Enrollment order.

enrollment_type_enum class-attribute instance-attribute

enrollment_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTypeEnum'})

Enrollment type.

entry_enrollment_id class-attribute instance-attribute

entry_enrollment_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryEnrollmentID'})

Unique ID for this entry enrollment record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

faculty class-attribute instance-attribute

faculty: Optional[str] = field(default=None, metadata={'wire_name': 'Faculty'})

Course faculty.

full_time class-attribute instance-attribute

full_time: Optional[bool] = field(default=None, metadata={'wire_name': 'FullTime'})

Indicates if the entry is enrolled full time.

institution class-attribute instance-attribute

institution: Optional[str] = field(default=None, metadata={'wire_name': 'Institution'})

Course institution.

is_enrolled class-attribute instance-attribute

is_enrolled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsEnrolled'})

Indicates if the entry is enrolled.

major class-attribute instance-attribute

major: Optional[str] = field(default=None, metadata={'wire_name': 'Major'})

Course Major.

major_category class-attribute instance-attribute

major_category: Optional[str] = field(default=None, metadata={'wire_name': 'MajorCategory'})

Major category.

minor class-attribute instance-attribute

minor: Optional[str] = field(default=None, metadata={'wire_name': 'Minor'})

Course Minor.

post_grad class-attribute instance-attribute

post_grad: Optional[bool] = field(default=None, metadata={'wire_name': 'PostGrad'})

Indicates if this is a post graduate course.

sequence class-attribute instance-attribute

sequence: Optional[int] = field(default=None, metadata={'wire_name': 'Sequence'})

Sequence

subjects class-attribute instance-attribute

subjects: Optional[str] = field(default=None, metadata={'wire_name': 'Subjects'})

The subjects the entry is enrolled in.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

years class-attribute instance-attribute

years: Optional[str] = field(default=None, metadata={'wire_name': 'Years'})

Years enrolled.

CreateEntryEnrollmentInput dataclass

CreateEntryEnrollmentInput(campus: Optional[str] = None, comments: Optional[str] = None, course_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_end: Optional[str] = None, date_start: Optional[str] = None, department: Optional[str] = None, enrollment_field: Optional[str] = None, enrollment_order: Optional[int] = None, enrollment_type_enum: Optional[str] = None, entry_enrollment_id: Optional[int] = None, entry_id: Optional[int] = None, faculty: Optional[str] = None, full_time: Optional[bool] = None, graduation_date: Optional[str] = None, institution: Optional[str] = None, is_enrolled: Optional[bool] = None, major: Optional[str] = None, major_category: Optional[str] = None, minor: Optional[str] = None, post_grad: Optional[bool] = None, sequence: Optional[int] = None, subjects: Optional[str] = None, term_id: Optional[int] = None, years: Optional[str] = None)

Create Entry Enrollment

Attributes

campus class-attribute instance-attribute

campus: Optional[str] = field(default=None, metadata={'wire_name': 'Campus'})

Campus where entry is enrolled.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Enrollment comments.

course_id class-attribute instance-attribute

course_id: Optional[int] = field(default=None, metadata={'wire_name': 'CourseID'})

Pointer to the course record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

date_end class-attribute instance-attribute

date_end: Optional[str] = field(default=None, metadata={'wire_name': 'DateEnd'})

Date enrollment ends.

date_start class-attribute instance-attribute

date_start: Optional[str] = field(default=None, metadata={'wire_name': 'DateStart'})

Date enrollment starts.

department class-attribute instance-attribute

department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

Department entry is enrolled in.

enrollment_field class-attribute instance-attribute

enrollment_field: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentField'})

Field of enrollment.

enrollment_order class-attribute instance-attribute

enrollment_order: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentOrder'})

Enrollment order.

enrollment_type_enum class-attribute instance-attribute

enrollment_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTypeEnum'})

Enrollment type.

entry_enrollment_id class-attribute instance-attribute

entry_enrollment_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryEnrollmentID'})

Unique ID for this entry enrollment record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

faculty class-attribute instance-attribute

faculty: Optional[str] = field(default=None, metadata={'wire_name': 'Faculty'})

Course faculty.

full_time class-attribute instance-attribute

full_time: Optional[bool] = field(default=None, metadata={'wire_name': 'FullTime'})

Indicates if the entry is enrolled full time.

graduation_date class-attribute instance-attribute

graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'GraduationDate'})

Date of graduation.

institution class-attribute instance-attribute

institution: Optional[str] = field(default=None, metadata={'wire_name': 'Institution'})

Course institution.

is_enrolled class-attribute instance-attribute

is_enrolled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsEnrolled'})

Indicates if the entry is enrolled.

major class-attribute instance-attribute

major: Optional[str] = field(default=None, metadata={'wire_name': 'Major'})

Course Major.

major_category class-attribute instance-attribute

major_category: Optional[str] = field(default=None, metadata={'wire_name': 'MajorCategory'})

Major category.

minor class-attribute instance-attribute

minor: Optional[str] = field(default=None, metadata={'wire_name': 'Minor'})

Course Minor.

post_grad class-attribute instance-attribute

post_grad: Optional[bool] = field(default=None, metadata={'wire_name': 'PostGrad'})

Indicates if this is a post graduate course.

sequence class-attribute instance-attribute

sequence: Optional[int] = field(default=None, metadata={'wire_name': 'Sequence'})

Sequence

subjects class-attribute instance-attribute

subjects: Optional[str] = field(default=None, metadata={'wire_name': 'Subjects'})

The subjects the entry is enrolled in.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

years class-attribute instance-attribute

years: Optional[str] = field(default=None, metadata={'wire_name': 'Years'})

Years enrolled.

CreateEntryEnrollmentResponse dataclass

CreateEntryEnrollmentResponse(campus: Optional[str] = None, comments: Optional[str] = None, course_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_end: Optional[str] = None, date_start: Optional[str] = None, department: Optional[str] = None, enrollment_field: Optional[str] = None, enrollment_order: Optional[int] = None, enrollment_type_enum: Optional[str] = None, entry_enrollment_id: Optional[int] = None, entry_id: Optional[int] = None, faculty: Optional[str] = None, full_time: Optional[bool] = None, graduation_date: Optional[str] = None, institution: Optional[str] = None, is_enrolled: Optional[bool] = None, major: Optional[str] = None, major_category: Optional[str] = None, minor: Optional[str] = None, post_grad: Optional[bool] = None, sequence: Optional[int] = None, subjects: Optional[str] = None, term_id: Optional[int] = None, years: Optional[str] = None)

Response for Create Entry Enrollment

Attributes

campus class-attribute instance-attribute

campus: Optional[str] = field(default=None, metadata={'wire_name': 'Campus'})

Campus where entry is enrolled.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Enrollment comments.

course_id class-attribute instance-attribute

course_id: Optional[int] = field(default=None, metadata={'wire_name': 'CourseID'})

Pointer to the course record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

date_end class-attribute instance-attribute

date_end: Optional[str] = field(default=None, metadata={'wire_name': 'DateEnd'})

Date enrollment ends.

date_start class-attribute instance-attribute

date_start: Optional[str] = field(default=None, metadata={'wire_name': 'DateStart'})

Date enrollment starts.

department class-attribute instance-attribute

department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

Department entry is enrolled in.

enrollment_field class-attribute instance-attribute

enrollment_field: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentField'})

Field of enrollment.

enrollment_order class-attribute instance-attribute

enrollment_order: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentOrder'})

Enrollment order.

enrollment_type_enum class-attribute instance-attribute

enrollment_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTypeEnum'})

Enrollment type.

entry_enrollment_id class-attribute instance-attribute

entry_enrollment_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryEnrollmentID'})

Unique ID for this entry enrollment record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

faculty class-attribute instance-attribute

faculty: Optional[str] = field(default=None, metadata={'wire_name': 'Faculty'})

Course faculty.

full_time class-attribute instance-attribute

full_time: Optional[bool] = field(default=None, metadata={'wire_name': 'FullTime'})

Indicates if the entry is enrolled full time.

graduation_date class-attribute instance-attribute

graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'GraduationDate'})

Date of graduation.

institution class-attribute instance-attribute

institution: Optional[str] = field(default=None, metadata={'wire_name': 'Institution'})

Course institution.

is_enrolled class-attribute instance-attribute

is_enrolled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsEnrolled'})

Indicates if the entry is enrolled.

major class-attribute instance-attribute

major: Optional[str] = field(default=None, metadata={'wire_name': 'Major'})

Course Major.

major_category class-attribute instance-attribute

major_category: Optional[str] = field(default=None, metadata={'wire_name': 'MajorCategory'})

Major category.

minor class-attribute instance-attribute

minor: Optional[str] = field(default=None, metadata={'wire_name': 'Minor'})

Course Minor.

post_grad class-attribute instance-attribute

post_grad: Optional[bool] = field(default=None, metadata={'wire_name': 'PostGrad'})

Indicates if this is a post graduate course.

sequence class-attribute instance-attribute

sequence: Optional[int] = field(default=None, metadata={'wire_name': 'Sequence'})

Sequence

subjects class-attribute instance-attribute

subjects: Optional[str] = field(default=None, metadata={'wire_name': 'Subjects'})

The subjects the entry is enrolled in.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

years class-attribute instance-attribute

years: Optional[str] = field(default=None, metadata={'wire_name': 'Years'})

Years enrolled.

UpdateEntryEnrollmentInput dataclass

UpdateEntryEnrollmentInput(campus: Optional[str] = None, comments: Optional[str] = None, course_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_end: Optional[str] = None, date_start: Optional[str] = None, department: Optional[str] = None, enrollment_field: Optional[str] = None, enrollment_order: Optional[int] = None, enrollment_type_enum: Optional[str] = None, entry_enrollment_id: Optional[int] = None, entry_id: Optional[int] = None, faculty: Optional[str] = None, full_time: Optional[bool] = None, graduation_date: Optional[str] = None, institution: Optional[str] = None, is_enrolled: Optional[bool] = None, major: Optional[str] = None, major_category: Optional[str] = None, minor: Optional[str] = None, post_grad: Optional[bool] = None, sequence: Optional[int] = None, subjects: Optional[str] = None, term_id: Optional[int] = None, years: Optional[str] = None)

Update Entry Enrollment

Attributes

campus class-attribute instance-attribute

campus: Optional[str] = field(default=None, metadata={'wire_name': 'Campus'})

Campus where entry is enrolled.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Enrollment comments.

course_id class-attribute instance-attribute

course_id: Optional[int] = field(default=None, metadata={'wire_name': 'CourseID'})

Pointer to the course record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

date_end class-attribute instance-attribute

date_end: Optional[str] = field(default=None, metadata={'wire_name': 'DateEnd'})

Date enrollment ends.

date_start class-attribute instance-attribute

date_start: Optional[str] = field(default=None, metadata={'wire_name': 'DateStart'})

Date enrollment starts.

department class-attribute instance-attribute

department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

Department entry is enrolled in.

enrollment_field class-attribute instance-attribute

enrollment_field: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentField'})

Field of enrollment.

enrollment_order class-attribute instance-attribute

enrollment_order: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentOrder'})

Enrollment order.

enrollment_type_enum class-attribute instance-attribute

enrollment_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTypeEnum'})

Enrollment type.

entry_enrollment_id class-attribute instance-attribute

entry_enrollment_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryEnrollmentID'})

Unique ID for this entry enrollment record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

faculty class-attribute instance-attribute

faculty: Optional[str] = field(default=None, metadata={'wire_name': 'Faculty'})

Course faculty.

full_time class-attribute instance-attribute

full_time: Optional[bool] = field(default=None, metadata={'wire_name': 'FullTime'})

Indicates if the entry is enrolled full time.

graduation_date class-attribute instance-attribute

graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'GraduationDate'})

Date of graduation.

institution class-attribute instance-attribute

institution: Optional[str] = field(default=None, metadata={'wire_name': 'Institution'})

Course institution.

is_enrolled class-attribute instance-attribute

is_enrolled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsEnrolled'})

Indicates if the entry is enrolled.

major class-attribute instance-attribute

major: Optional[str] = field(default=None, metadata={'wire_name': 'Major'})

Course Major.

major_category class-attribute instance-attribute

major_category: Optional[str] = field(default=None, metadata={'wire_name': 'MajorCategory'})

Major category.

minor class-attribute instance-attribute

minor: Optional[str] = field(default=None, metadata={'wire_name': 'Minor'})

Course Minor.

post_grad class-attribute instance-attribute

post_grad: Optional[bool] = field(default=None, metadata={'wire_name': 'PostGrad'})

Indicates if this is a post graduate course.

sequence class-attribute instance-attribute

sequence: Optional[int] = field(default=None, metadata={'wire_name': 'Sequence'})

Sequence

subjects class-attribute instance-attribute

subjects: Optional[str] = field(default=None, metadata={'wire_name': 'Subjects'})

The subjects the entry is enrolled in.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

years class-attribute instance-attribute

years: Optional[str] = field(default=None, metadata={'wire_name': 'Years'})

Years enrolled.

UpdateEntryEnrollmentResponse dataclass

UpdateEntryEnrollmentResponse(campus: Optional[str] = None, comments: Optional[str] = None, course_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_end: Optional[str] = None, date_start: Optional[str] = None, department: Optional[str] = None, enrollment_field: Optional[str] = None, enrollment_order: Optional[int] = None, enrollment_type_enum: Optional[str] = None, entry_enrollment_id: Optional[int] = None, entry_id: Optional[int] = None, faculty: Optional[str] = None, full_time: Optional[bool] = None, graduation_date: Optional[str] = None, institution: Optional[str] = None, is_enrolled: Optional[bool] = None, major: Optional[str] = None, major_category: Optional[str] = None, minor: Optional[str] = None, post_grad: Optional[bool] = None, sequence: Optional[int] = None, subjects: Optional[str] = None, term_id: Optional[int] = None, years: Optional[str] = None)

Response for Update Entry Enrollment

Attributes

campus class-attribute instance-attribute

campus: Optional[str] = field(default=None, metadata={'wire_name': 'Campus'})

Campus where entry is enrolled.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Enrollment comments.

course_id class-attribute instance-attribute

course_id: Optional[int] = field(default=None, metadata={'wire_name': 'CourseID'})

Pointer to the course record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

date_end class-attribute instance-attribute

date_end: Optional[str] = field(default=None, metadata={'wire_name': 'DateEnd'})

Date enrollment ends.

date_start class-attribute instance-attribute

date_start: Optional[str] = field(default=None, metadata={'wire_name': 'DateStart'})

Date enrollment starts.

department class-attribute instance-attribute

department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

Department entry is enrolled in.

enrollment_field class-attribute instance-attribute

enrollment_field: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentField'})

Field of enrollment.

enrollment_order class-attribute instance-attribute

enrollment_order: Optional[int] = field(default=None, metadata={'wire_name': 'EnrollmentOrder'})

Enrollment order.

enrollment_type_enum class-attribute instance-attribute

enrollment_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EnrollmentTypeEnum'})

Enrollment type.

entry_enrollment_id class-attribute instance-attribute

entry_enrollment_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryEnrollmentID'})

Unique ID for this entry enrollment record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

faculty class-attribute instance-attribute

faculty: Optional[str] = field(default=None, metadata={'wire_name': 'Faculty'})

Course faculty.

full_time class-attribute instance-attribute

full_time: Optional[bool] = field(default=None, metadata={'wire_name': 'FullTime'})

Indicates if the entry is enrolled full time.

graduation_date class-attribute instance-attribute

graduation_date: Optional[str] = field(default=None, metadata={'wire_name': 'GraduationDate'})

Date of graduation.

institution class-attribute instance-attribute

institution: Optional[str] = field(default=None, metadata={'wire_name': 'Institution'})

Course institution.

is_enrolled class-attribute instance-attribute

is_enrolled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsEnrolled'})

Indicates if the entry is enrolled.

major class-attribute instance-attribute

major: Optional[str] = field(default=None, metadata={'wire_name': 'Major'})

Course Major.

major_category class-attribute instance-attribute

major_category: Optional[str] = field(default=None, metadata={'wire_name': 'MajorCategory'})

Major category.

minor class-attribute instance-attribute

minor: Optional[str] = field(default=None, metadata={'wire_name': 'Minor'})

Course Minor.

post_grad class-attribute instance-attribute

post_grad: Optional[bool] = field(default=None, metadata={'wire_name': 'PostGrad'})

Indicates if this is a post graduate course.

sequence class-attribute instance-attribute

sequence: Optional[int] = field(default=None, metadata={'wire_name': 'Sequence'})

Sequence

subjects class-attribute instance-attribute

subjects: Optional[str] = field(default=None, metadata={'wire_name': 'Subjects'})

The subjects the entry is enrolled in.

term_id class-attribute instance-attribute

term_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermID'})

Pointer to the term record.

years class-attribute instance-attribute

years: Optional[str] = field(default=None, metadata={'wire_name': 'Years'})

Years enrolled.

SelectBookingInput dataclass

SelectBookingInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, additional_occupant_count: Optional[int] = None, auto_allocation_detail: Optional[str] = None, booking_id: Optional[int] = None, booking_link_type_enum: Optional[str] = None, booking_type_id: Optional[int] = None, check_in_date: Optional[Dict[str, Any]] = None, check_in_date_actual: Optional[Dict[str, Any]] = None, check_out_date: Optional[Dict[str, Any]] = None, check_out_date_actual: Optional[Dict[str, Any]] = None, comments: Optional[str] = None, contract_date_end: Optional[Dict[str, Any]] = None, contract_date_start: Optional[Dict[str, Any]] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_date3: Optional[Dict[str, Any]] = None, custom_date4: Optional[Dict[str, Any]] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, custom_string7: Optional[str] = None, custom_string8: Optional[str] = None, custom_string9: Optional[str] = None, custom_string10: Optional[str] = None, date_billed: Optional[Dict[str, Any]] = None, date_charged_to: Optional[Dict[str, Any]] = None, date_created: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, date_modified_billing: Optional[Dict[str, Any]] = None, emotional_support_animal_count: Optional[int] = None, end_booking_reason_id: Optional[int] = None, entry_id: Optional[int] = None, entry_invitation_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, excess: Optional[float] = None, group_id: Optional[int] = None, housekeeping_id: Optional[int] = None, number_of_children: Optional[int] = None, number_of_children_free: Optional[int] = None, number_of_guests: Optional[int] = None, number_of_guests_free: Optional[int] = None, paid_to: Optional[Dict[str, Any]] = None, pet_count: Optional[int] = None, resv_charge_to_entry: Optional[bool] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_type_id: Optional[int] = None, security_user_id: Optional[int] = None, service_animal_count: Optional[int] = None, special_requirement: Optional[str] = None, start_booking_reason_id: Optional[int] = None, term_session_id: Optional[int] = None)

Get Booking

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

additional_occupant_count: Optional[int] = field(default=None, metadata={'wire_name': 'AdditionalOccupantCount'})

The number of additional human occupants in this booking.

auto_allocation_detail class-attribute instance-attribute

auto_allocation_detail: Optional[str] = field(default=None, metadata={'wire_name': 'AutoAllocationDetail'})

Details of the auto allocation.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Unique ID for this booking record.

booking_link_type_enum class-attribute instance-attribute

booking_link_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'BookingLinkTypeEnum'})

Booking link type.

booking_type_id class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

custom_string7 class-attribute instance-attribute

custom_string7: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString7'})

Custom string field value.

custom_string8 class-attribute instance-attribute

custom_string8: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString8'})

Custom string field value.

custom_string9 class-attribute instance-attribute

custom_string9: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString9'})

Custom string field value.

custom_string10 class-attribute instance-attribute

custom_string10: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString10'})

Custom string field value.

emotional_support_animal_count class-attribute instance-attribute

emotional_support_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'EmotionalSupportAnimalCount'})

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

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

The reason this booking finished.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

entry_invitation_id class-attribute instance-attribute

entry_invitation_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryInvitationID'})

Identifies the entry invitation that the booking is created for.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the booking.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Minutes since midnight for estimated time of arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Minutes since midnight for estimated time of departure.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Amount of excess.

group_id class-attribute instance-attribute

group_id: Optional[int] = field(default=None, metadata={'wire_name': 'GroupID'})

Pointer to the group record.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

The housekeeping rules that should be applied to this booking.

number_of_children class-attribute instance-attribute

number_of_children: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildren'})

The number of children in the booking.

number_of_children_free class-attribute instance-attribute

number_of_children_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildrenFree'})

The number of children that are free to stay.

number_of_guests class-attribute instance-attribute

number_of_guests: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuests'})

The number of guests in the booking.

number_of_guests_free class-attribute instance-attribute

number_of_guests_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuestsFree'})

The number of guests that are free to stay.

pet_count class-attribute instance-attribute

pet_count: Optional[int] = field(default=None, metadata={'wire_name': 'PetCount'})

The number of additional pet occupants in this booking.

resv_charge_to_entry class-attribute instance-attribute

resv_charge_to_entry: Optional[bool] = field(default=None, metadata={'wire_name': 'ResvChargeToEntry'})

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

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

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

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Actual dollar amount of room rate.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Selected room rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

service_animal_count class-attribute instance-attribute

service_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'ServiceAnimalCount'})

The number of additional Service Animal occupants in this booking.

special_requirement class-attribute instance-attribute

special_requirement: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialRequirement'})

Special requirements for this booking.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

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

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

CreateBookingInput dataclass

CreateBookingInput(additional_occupant_count: Optional[int] = None, auto_allocation_detail: Optional[str] = None, booking_id: Optional[int] = None, booking_link_type_enum: Optional[str] = None, booking_type_id: Optional[int] = None, check_in_date: Optional[str] = None, check_in_date_actual: Optional[str] = None, check_out_date: Optional[str] = None, check_out_date_actual: Optional[str] = None, comments: Optional[str] = None, contract_date_end: Optional[str] = None, contract_date_start: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, custom_string7: Optional[str] = None, custom_string8: Optional[str] = None, custom_string9: Optional[str] = None, custom_string10: Optional[str] = None, date_billed: Optional[str] = None, date_charged_to: Optional[str] = None, emotional_support_animal_count: Optional[int] = None, end_booking_reason_id: Optional[int] = None, entry_id: Optional[int] = None, entry_invitation_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, excess: Optional[float] = None, group_id: Optional[int] = None, housekeeping_id: Optional[int] = None, number_of_children: Optional[int] = None, number_of_children_free: Optional[int] = None, number_of_guests: Optional[int] = None, number_of_guests_free: Optional[int] = None, paid_to: Optional[str] = None, pet_count: Optional[int] = None, resv_charge_to_entry: Optional[bool] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_type_id: Optional[int] = None, security_user_id: Optional[int] = None, service_animal_count: Optional[int] = None, special_requirement: Optional[str] = None, start_booking_reason_id: Optional[int] = None, term_session_id: Optional[int] = None)

Create Booking

Attributes

additional_occupant_count class-attribute instance-attribute

additional_occupant_count: Optional[int] = field(default=None, metadata={'wire_name': 'AdditionalOccupantCount'})

The number of additional human occupants in this booking.

auto_allocation_detail class-attribute instance-attribute

auto_allocation_detail: Optional[str] = field(default=None, metadata={'wire_name': 'AutoAllocationDetail'})

Details of the auto allocation.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Unique ID for this booking record.

booking_link_type_enum class-attribute instance-attribute

booking_link_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'BookingLinkTypeEnum'})

Booking link type.

booking_type_id class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

check_in_date class-attribute instance-attribute

check_in_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDate'})

Main (contract) check-in date.

check_in_date_actual class-attribute instance-attribute

check_in_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActual'})

Actual date the entry arrives.

check_out_date class-attribute instance-attribute

check_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDate'})

Main (contract) check-out date.

check_out_date_actual class-attribute instance-attribute

check_out_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActual'})

Actual date the entry departs.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments

contract_date_end class-attribute instance-attribute

contract_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateEnd'})

Contact chargeable date end.

contract_date_start class-attribute instance-attribute

contract_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateStart'})

Contact chargeable date start.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

custom_string7 class-attribute instance-attribute

custom_string7: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString7'})

Custom string field value.

custom_string8 class-attribute instance-attribute

custom_string8: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString8'})

Custom string field value.

custom_string9 class-attribute instance-attribute

custom_string9: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString9'})

Custom string field value.

custom_string10 class-attribute instance-attribute

custom_string10: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString10'})

Custom string field value.

date_billed class-attribute instance-attribute

date_billed: Optional[str] = field(default=None, metadata={'wire_name': 'DateBilled'})

Date when this booking was processed for billing.

date_charged_to class-attribute instance-attribute

date_charged_to: Optional[str] = field(default=None, metadata={'wire_name': 'DateChargedTo'})

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

emotional_support_animal_count class-attribute instance-attribute

emotional_support_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'EmotionalSupportAnimalCount'})

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

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

The reason this booking finished.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

entry_invitation_id class-attribute instance-attribute

entry_invitation_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryInvitationID'})

Identifies the entry invitation that the booking is created for.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the booking.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Date and time of estimated arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Date and time of estimated departure.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Amount of excess.

group_id class-attribute instance-attribute

group_id: Optional[int] = field(default=None, metadata={'wire_name': 'GroupID'})

Pointer to the group record.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

The housekeeping rules that should be applied to this booking.

number_of_children class-attribute instance-attribute

number_of_children: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildren'})

The number of children in the booking.

number_of_children_free class-attribute instance-attribute

number_of_children_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildrenFree'})

The number of children that are free to stay.

number_of_guests class-attribute instance-attribute

number_of_guests: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuests'})

The number of guests in the booking.

number_of_guests_free class-attribute instance-attribute

number_of_guests_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuestsFree'})

The number of guests that are free to stay.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Date the booking is paid to.

pet_count class-attribute instance-attribute

pet_count: Optional[int] = field(default=None, metadata={'wire_name': 'PetCount'})

The number of additional pet occupants in this booking.

resv_charge_to_entry class-attribute instance-attribute

resv_charge_to_entry: Optional[bool] = field(default=None, metadata={'wire_name': 'ResvChargeToEntry'})

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

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

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

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Actual dollar amount of room rate.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Selected room rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

service_animal_count class-attribute instance-attribute

service_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'ServiceAnimalCount'})

The number of additional Service Animal occupants in this booking.

special_requirement class-attribute instance-attribute

special_requirement: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialRequirement'})

Special requirements for this booking.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

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

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

CreateBookingResponse dataclass

CreateBookingResponse(additional_occupant_count: Optional[int] = None, auto_allocation_detail: Optional[str] = None, booking_id: Optional[int] = None, booking_link_type_enum: Optional[str] = None, booking_type_id: Optional[int] = None, check_in_date: Optional[str] = None, check_in_date_actual: Optional[str] = None, check_out_date: Optional[str] = None, check_out_date_actual: Optional[str] = None, comments: Optional[str] = None, contract_date_end: Optional[str] = None, contract_date_start: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, custom_string7: Optional[str] = None, custom_string8: Optional[str] = None, custom_string9: Optional[str] = None, custom_string10: Optional[str] = None, date_billed: Optional[str] = None, date_charged_to: Optional[str] = None, date_modified_billing: Optional[str] = None, emotional_support_animal_count: Optional[int] = None, end_booking_reason_id: Optional[int] = None, entry_id: Optional[int] = None, entry_invitation_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, excess: Optional[float] = None, group_id: Optional[int] = None, housekeeping_id: Optional[int] = None, number_of_children: Optional[int] = None, number_of_children_free: Optional[int] = None, number_of_guests: Optional[int] = None, number_of_guests_free: Optional[int] = None, paid_to: Optional[str] = None, pet_count: Optional[int] = None, resv_charge_to_entry: Optional[bool] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_type_id: Optional[int] = None, security_user_id: Optional[int] = None, service_animal_count: Optional[int] = None, special_requirement: Optional[str] = None, start_booking_reason_id: Optional[int] = None, term_session_id: Optional[int] = None)

Response for Create Booking

Attributes

additional_occupant_count class-attribute instance-attribute

additional_occupant_count: Optional[int] = field(default=None, metadata={'wire_name': 'AdditionalOccupantCount'})

The number of additional human occupants in this booking.

auto_allocation_detail class-attribute instance-attribute

auto_allocation_detail: Optional[str] = field(default=None, metadata={'wire_name': 'AutoAllocationDetail'})

Details of the auto allocation.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Unique ID for this booking record.

booking_link_type_enum class-attribute instance-attribute

booking_link_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'BookingLinkTypeEnum'})

Booking link type.

booking_type_id class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

check_in_date class-attribute instance-attribute

check_in_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDate'})

Main (contract) check-in date.

check_in_date_actual class-attribute instance-attribute

check_in_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActual'})

Actual date the entry arrives.

check_out_date class-attribute instance-attribute

check_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDate'})

Main (contract) check-out date.

check_out_date_actual class-attribute instance-attribute

check_out_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActual'})

Actual date the entry departs.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments

contract_date_end class-attribute instance-attribute

contract_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateEnd'})

Contact chargeable date end.

contract_date_start class-attribute instance-attribute

contract_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateStart'})

Contact chargeable date start.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

custom_string7 class-attribute instance-attribute

custom_string7: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString7'})

Custom string field value.

custom_string8 class-attribute instance-attribute

custom_string8: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString8'})

Custom string field value.

custom_string9 class-attribute instance-attribute

custom_string9: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString9'})

Custom string field value.

custom_string10 class-attribute instance-attribute

custom_string10: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString10'})

Custom string field value.

date_billed class-attribute instance-attribute

date_billed: Optional[str] = field(default=None, metadata={'wire_name': 'DateBilled'})

Date when this booking was processed for billing.

date_charged_to class-attribute instance-attribute

date_charged_to: Optional[str] = field(default=None, metadata={'wire_name': 'DateChargedTo'})

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

date_modified_billing class-attribute instance-attribute

date_modified_billing: Optional[str] = field(default=None, metadata={'wire_name': 'DateModifiedBilling'})

Indicates when critical booking fields are modified.

emotional_support_animal_count class-attribute instance-attribute

emotional_support_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'EmotionalSupportAnimalCount'})

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

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

The reason this booking finished.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

entry_invitation_id class-attribute instance-attribute

entry_invitation_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryInvitationID'})

Identifies the entry invitation that the booking is created for.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the booking.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Date and time of estimated arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Date and time of estimated departure.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Amount of excess.

group_id class-attribute instance-attribute

group_id: Optional[int] = field(default=None, metadata={'wire_name': 'GroupID'})

Pointer to the group record.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

The housekeeping rules that should be applied to this booking.

number_of_children class-attribute instance-attribute

number_of_children: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildren'})

The number of children in the booking.

number_of_children_free class-attribute instance-attribute

number_of_children_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildrenFree'})

The number of children that are free to stay.

number_of_guests class-attribute instance-attribute

number_of_guests: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuests'})

The number of guests in the booking.

number_of_guests_free class-attribute instance-attribute

number_of_guests_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuestsFree'})

The number of guests that are free to stay.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Date the booking is paid to.

pet_count class-attribute instance-attribute

pet_count: Optional[int] = field(default=None, metadata={'wire_name': 'PetCount'})

The number of additional pet occupants in this booking.

resv_charge_to_entry class-attribute instance-attribute

resv_charge_to_entry: Optional[bool] = field(default=None, metadata={'wire_name': 'ResvChargeToEntry'})

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

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

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

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Actual dollar amount of room rate.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Selected room rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

service_animal_count class-attribute instance-attribute

service_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'ServiceAnimalCount'})

The number of additional Service Animal occupants in this booking.

special_requirement class-attribute instance-attribute

special_requirement: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialRequirement'})

Special requirements for this booking.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

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

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

UpdateBookingInput dataclass

UpdateBookingInput(additional_occupant_count: Optional[int] = None, auto_allocation_detail: Optional[str] = None, booking_id: Optional[int] = None, booking_link_type_enum: Optional[str] = None, booking_type_id: Optional[int] = None, check_in_date: Optional[str] = None, check_in_date_actual: Optional[str] = None, check_out_date: Optional[str] = None, check_out_date_actual: Optional[str] = None, comments: Optional[str] = None, contract_date_end: Optional[str] = None, contract_date_start: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, custom_string7: Optional[str] = None, custom_string8: Optional[str] = None, custom_string9: Optional[str] = None, custom_string10: Optional[str] = None, date_billed: Optional[str] = None, date_charged_to: Optional[str] = None, emotional_support_animal_count: Optional[int] = None, end_booking_reason_id: Optional[int] = None, entry_id: Optional[int] = None, entry_invitation_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, excess: Optional[float] = None, group_id: Optional[int] = None, housekeeping_id: Optional[int] = None, number_of_children: Optional[int] = None, number_of_children_free: Optional[int] = None, number_of_guests: Optional[int] = None, number_of_guests_free: Optional[int] = None, paid_to: Optional[str] = None, pet_count: Optional[int] = None, resv_charge_to_entry: Optional[bool] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_type_id: Optional[int] = None, security_user_id: Optional[int] = None, service_animal_count: Optional[int] = None, special_requirement: Optional[str] = None, start_booking_reason_id: Optional[int] = None, term_session_id: Optional[int] = None)

Update Booking

Attributes

additional_occupant_count class-attribute instance-attribute

additional_occupant_count: Optional[int] = field(default=None, metadata={'wire_name': 'AdditionalOccupantCount'})

The number of additional human occupants in this booking.

auto_allocation_detail class-attribute instance-attribute

auto_allocation_detail: Optional[str] = field(default=None, metadata={'wire_name': 'AutoAllocationDetail'})

Details of the auto allocation.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Unique ID for this booking record.

booking_link_type_enum class-attribute instance-attribute

booking_link_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'BookingLinkTypeEnum'})

Booking link type.

booking_type_id class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

check_in_date class-attribute instance-attribute

check_in_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDate'})

Main (contract) check-in date.

check_in_date_actual class-attribute instance-attribute

check_in_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActual'})

Actual date the entry arrives.

check_out_date class-attribute instance-attribute

check_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDate'})

Main (contract) check-out date.

check_out_date_actual class-attribute instance-attribute

check_out_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActual'})

Actual date the entry departs.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments

contract_date_end class-attribute instance-attribute

contract_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateEnd'})

Contact chargeable date end.

contract_date_start class-attribute instance-attribute

contract_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateStart'})

Contact chargeable date start.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

custom_string7 class-attribute instance-attribute

custom_string7: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString7'})

Custom string field value.

custom_string8 class-attribute instance-attribute

custom_string8: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString8'})

Custom string field value.

custom_string9 class-attribute instance-attribute

custom_string9: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString9'})

Custom string field value.

custom_string10 class-attribute instance-attribute

custom_string10: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString10'})

Custom string field value.

date_billed class-attribute instance-attribute

date_billed: Optional[str] = field(default=None, metadata={'wire_name': 'DateBilled'})

Date when this booking was processed for billing.

date_charged_to class-attribute instance-attribute

date_charged_to: Optional[str] = field(default=None, metadata={'wire_name': 'DateChargedTo'})

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

emotional_support_animal_count class-attribute instance-attribute

emotional_support_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'EmotionalSupportAnimalCount'})

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

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

The reason this booking finished.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

entry_invitation_id class-attribute instance-attribute

entry_invitation_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryInvitationID'})

Identifies the entry invitation that the booking is created for.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the booking.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Date and time of estimated arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Date and time of estimated departure.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Amount of excess.

group_id class-attribute instance-attribute

group_id: Optional[int] = field(default=None, metadata={'wire_name': 'GroupID'})

Pointer to the group record.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

The housekeeping rules that should be applied to this booking.

number_of_children class-attribute instance-attribute

number_of_children: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildren'})

The number of children in the booking.

number_of_children_free class-attribute instance-attribute

number_of_children_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildrenFree'})

The number of children that are free to stay.

number_of_guests class-attribute instance-attribute

number_of_guests: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuests'})

The number of guests in the booking.

number_of_guests_free class-attribute instance-attribute

number_of_guests_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuestsFree'})

The number of guests that are free to stay.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Date the booking is paid to.

pet_count class-attribute instance-attribute

pet_count: Optional[int] = field(default=None, metadata={'wire_name': 'PetCount'})

The number of additional pet occupants in this booking.

resv_charge_to_entry class-attribute instance-attribute

resv_charge_to_entry: Optional[bool] = field(default=None, metadata={'wire_name': 'ResvChargeToEntry'})

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

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

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

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Actual dollar amount of room rate.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Selected room rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

service_animal_count class-attribute instance-attribute

service_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'ServiceAnimalCount'})

The number of additional Service Animal occupants in this booking.

special_requirement class-attribute instance-attribute

special_requirement: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialRequirement'})

Special requirements for this booking.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

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

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

UpdateBookingResponse dataclass

UpdateBookingResponse(additional_occupant_count: Optional[int] = None, auto_allocation_detail: Optional[str] = None, booking_id: Optional[int] = None, booking_link_type_enum: Optional[str] = None, booking_type_id: Optional[int] = None, check_in_date: Optional[str] = None, check_in_date_actual: Optional[str] = None, check_out_date: Optional[str] = None, check_out_date_actual: Optional[str] = None, comments: Optional[str] = None, contract_date_end: Optional[str] = None, contract_date_start: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_bit3: Optional[bool] = None, custom_bit4: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_date3: Optional[str] = None, custom_date4: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, custom_string7: Optional[str] = None, custom_string8: Optional[str] = None, custom_string9: Optional[str] = None, custom_string10: Optional[str] = None, date_billed: Optional[str] = None, date_charged_to: Optional[str] = None, date_modified_billing: Optional[str] = None, emotional_support_animal_count: Optional[int] = None, end_booking_reason_id: Optional[int] = None, entry_id: Optional[int] = None, entry_invitation_id: Optional[int] = None, entry_status_enum: Optional[str] = None, e_t_a: Optional[str] = None, e_t_d: Optional[str] = None, excess: Optional[float] = None, group_id: Optional[int] = None, housekeeping_id: Optional[int] = None, number_of_children: Optional[int] = None, number_of_children_free: Optional[int] = None, number_of_guests: Optional[int] = None, number_of_guests_free: Optional[int] = None, paid_to: Optional[str] = None, pet_count: Optional[int] = None, resv_charge_to_entry: Optional[bool] = None, room_location_fixed: Optional[bool] = None, room_location_id: Optional[int] = None, room_rate_amount: Optional[float] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_type_id: Optional[int] = None, security_user_id: Optional[int] = None, service_animal_count: Optional[int] = None, special_requirement: Optional[str] = None, start_booking_reason_id: Optional[int] = None, term_session_id: Optional[int] = None)

Response for Update Booking

Attributes

additional_occupant_count class-attribute instance-attribute

additional_occupant_count: Optional[int] = field(default=None, metadata={'wire_name': 'AdditionalOccupantCount'})

The number of additional human occupants in this booking.

auto_allocation_detail class-attribute instance-attribute

auto_allocation_detail: Optional[str] = field(default=None, metadata={'wire_name': 'AutoAllocationDetail'})

Details of the auto allocation.

booking_id class-attribute instance-attribute

booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingID'})

Unique ID for this booking record.

booking_link_type_enum class-attribute instance-attribute

booking_link_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'BookingLinkTypeEnum'})

Booking link type.

booking_type_id class-attribute instance-attribute

booking_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'BookingTypeID'})

Pointer to the booking type record.

check_in_date class-attribute instance-attribute

check_in_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDate'})

Main (contract) check-in date.

check_in_date_actual class-attribute instance-attribute

check_in_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckInDateActual'})

Actual date the entry arrives.

check_out_date class-attribute instance-attribute

check_out_date: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDate'})

Main (contract) check-out date.

check_out_date_actual class-attribute instance-attribute

check_out_date_actual: Optional[str] = field(default=None, metadata={'wire_name': 'CheckOutDateActual'})

Actual date the entry departs.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Comments

contract_date_end class-attribute instance-attribute

contract_date_end: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateEnd'})

Contact chargeable date end.

contract_date_start class-attribute instance-attribute

contract_date_start: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDateStart'})

Contact chargeable date start.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_bit3 class-attribute instance-attribute

custom_bit3: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit3'})

Custom boolean field value.

custom_bit4 class-attribute instance-attribute

custom_bit4: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit4'})

Custom boolean field value.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date field value.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date field value.

custom_date3 class-attribute instance-attribute

custom_date3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate3'})

Custom date field value.

custom_date4 class-attribute instance-attribute

custom_date4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate4'})

Custom date field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

custom_string7 class-attribute instance-attribute

custom_string7: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString7'})

Custom string field value.

custom_string8 class-attribute instance-attribute

custom_string8: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString8'})

Custom string field value.

custom_string9 class-attribute instance-attribute

custom_string9: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString9'})

Custom string field value.

custom_string10 class-attribute instance-attribute

custom_string10: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString10'})

Custom string field value.

date_billed class-attribute instance-attribute

date_billed: Optional[str] = field(default=None, metadata={'wire_name': 'DateBilled'})

Date when this booking was processed for billing.

date_charged_to class-attribute instance-attribute

date_charged_to: Optional[str] = field(default=None, metadata={'wire_name': 'DateChargedTo'})

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

date_modified_billing class-attribute instance-attribute

date_modified_billing: Optional[str] = field(default=None, metadata={'wire_name': 'DateModifiedBilling'})

Indicates when critical booking fields are modified.

emotional_support_animal_count class-attribute instance-attribute

emotional_support_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'EmotionalSupportAnimalCount'})

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

end_booking_reason_id class-attribute instance-attribute

end_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'End_BookingReasonID'})

The reason this booking finished.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

entry_invitation_id class-attribute instance-attribute

entry_invitation_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryInvitationID'})

Identifies the entry invitation that the booking is created for.

entry_status_enum class-attribute instance-attribute

entry_status_enum: Optional[str] = field(default=None, metadata={'wire_name': 'EntryStatusEnum'})

The status of the booking.

e_t_a class-attribute instance-attribute

e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ETA'})

Date and time of estimated arrival.

e_t_d class-attribute instance-attribute

e_t_d: Optional[str] = field(default=None, metadata={'wire_name': 'ETD'})

Date and time of estimated departure.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Amount of excess.

group_id class-attribute instance-attribute

group_id: Optional[int] = field(default=None, metadata={'wire_name': 'GroupID'})

Pointer to the group record.

housekeeping_id class-attribute instance-attribute

housekeeping_id: Optional[int] = field(default=None, metadata={'wire_name': 'HousekeepingID'})

The housekeeping rules that should be applied to this booking.

number_of_children class-attribute instance-attribute

number_of_children: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildren'})

The number of children in the booking.

number_of_children_free class-attribute instance-attribute

number_of_children_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfChildrenFree'})

The number of children that are free to stay.

number_of_guests class-attribute instance-attribute

number_of_guests: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuests'})

The number of guests in the booking.

number_of_guests_free class-attribute instance-attribute

number_of_guests_free: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfGuestsFree'})

The number of guests that are free to stay.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Date the booking is paid to.

pet_count class-attribute instance-attribute

pet_count: Optional[int] = field(default=None, metadata={'wire_name': 'PetCount'})

The number of additional pet occupants in this booking.

resv_charge_to_entry class-attribute instance-attribute

resv_charge_to_entry: Optional[bool] = field(default=None, metadata={'wire_name': 'ResvChargeToEntry'})

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

room_location_fixed class-attribute instance-attribute

room_location_fixed: Optional[bool] = field(default=None, metadata={'wire_name': 'RoomLocationFixed'})

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

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Pointer to the room location record.

room_rate_amount class-attribute instance-attribute

room_rate_amount: Optional[float] = field(default=None, metadata={'wire_name': 'RoomRateAmount'})

Actual dollar amount of room rate.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Selected room rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_type_id class-attribute instance-attribute

room_type_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomTypeID'})

Pointer to the room type record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

service_animal_count class-attribute instance-attribute

service_animal_count: Optional[int] = field(default=None, metadata={'wire_name': 'ServiceAnimalCount'})

The number of additional Service Animal occupants in this booking.

special_requirement class-attribute instance-attribute

special_requirement: Optional[str] = field(default=None, metadata={'wire_name': 'SpecialRequirement'})

Special requirements for this booking.

start_booking_reason_id class-attribute instance-attribute

start_booking_reason_id: Optional[int] = field(default=None, metadata={'wire_name': 'Start_BookingReasonID'})

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

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

SelectRoomSpaceInput dataclass

SelectRoomSpaceInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, allocate_exclude: Optional[bool] = None, allocate_sort_order: Optional[int] = None, bathrooms: Optional[int] = None, bed_capacity: Optional[int] = None, comments: Optional[str] = None, date_modified: Optional[Dict[str, Any]] = None, description: Optional[str] = None, extension_id: Optional[int] = None, hold: Optional[bool] = None, networked: Optional[bool] = None, record_type_enum: Optional[str] = None, room_base_id: Optional[int] = None, room_id: Optional[int] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_type_enum: Optional[str] = None, security_user_id: Optional[int] = None, sort_order: Optional[int] = None, street: Optional[str] = None, street2: Optional[str] = None, web_description: Optional[str] = None, zip_postcode: Optional[str] = None)

Get Room Space

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

allocate_exclude class-attribute instance-attribute

allocate_exclude: Optional[bool] = field(default=None, metadata={'wire_name': 'AllocateExclude'})

Room Allocation - Do not include room in allocations.

allocate_sort_order class-attribute instance-attribute

allocate_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'AllocateSortOrder'})

Room Allocation - Allows allocating nicer rooms first.

bathrooms class-attribute instance-attribute

bathrooms: Optional[int] = field(default=None, metadata={'wire_name': 'Bathrooms'})

The number of bathrooms available.

bed_capacity class-attribute instance-attribute

bed_capacity: Optional[int] = field(default=None, metadata={'wire_name': 'BedCapacity'})

The number of beds available.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Room space comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

The actual room name.

extension_id class-attribute instance-attribute

extension_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExtensionID'})

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

hold class-attribute instance-attribute

hold: Optional[bool] = field(default=None, metadata={'wire_name': 'Hold'})

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

networked class-attribute instance-attribute

networked: Optional[bool] = field(default=None, metadata={'wire_name': 'Networked'})

Indicates if the room space is networked.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

room_base_id class-attribute instance-attribute

room_base_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomBaseID'})

Pointer to the room base record.

room_id class-attribute instance-attribute

room_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomID'})

Pointer to the room record.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Default tariff rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Unique ID for this room space record.

room_space_type_enum class-attribute instance-attribute

room_space_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSpaceTypeEnum'})

Room space type.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

sort_order class-attribute instance-attribute

sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'SortOrder'})

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

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

The room space displayed in the Portal.

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

CreateRoomSpaceInput dataclass

CreateRoomSpaceInput(allocate_exclude: Optional[bool] = None, allocate_sort_order: Optional[int] = None, bathrooms: Optional[int] = None, bed_capacity: Optional[int] = None, comments: Optional[str] = None, description: Optional[str] = None, extension_id: Optional[int] = None, hold: Optional[bool] = None, networked: Optional[bool] = None, record_type_enum: Optional[str] = None, room_base_id: Optional[int] = None, room_id: Optional[int] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_type_enum: Optional[str] = None, security_user_id: Optional[int] = None, sort_order: Optional[int] = None, street: Optional[str] = None, street2: Optional[str] = None, web_description: Optional[str] = None, zip_postcode: Optional[str] = None)

Create Room Space

Attributes

allocate_exclude class-attribute instance-attribute

allocate_exclude: Optional[bool] = field(default=None, metadata={'wire_name': 'AllocateExclude'})

Room Allocation - Do not include room in allocations.

allocate_sort_order class-attribute instance-attribute

allocate_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'AllocateSortOrder'})

Room Allocation - Allows allocating nicer rooms first.

bathrooms class-attribute instance-attribute

bathrooms: Optional[int] = field(default=None, metadata={'wire_name': 'Bathrooms'})

The number of bathrooms available.

bed_capacity class-attribute instance-attribute

bed_capacity: Optional[int] = field(default=None, metadata={'wire_name': 'BedCapacity'})

The number of beds available.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Room space comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

The actual room name.

extension_id class-attribute instance-attribute

extension_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExtensionID'})

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

hold class-attribute instance-attribute

hold: Optional[bool] = field(default=None, metadata={'wire_name': 'Hold'})

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

networked class-attribute instance-attribute

networked: Optional[bool] = field(default=None, metadata={'wire_name': 'Networked'})

Indicates if the room space is networked.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

room_base_id class-attribute instance-attribute

room_base_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomBaseID'})

Pointer to the room base record.

room_id class-attribute instance-attribute

room_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomID'})

Pointer to the room record.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Default tariff rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Unique ID for this room space record.

room_space_type_enum class-attribute instance-attribute

room_space_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSpaceTypeEnum'})

Room space type.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

sort_order class-attribute instance-attribute

sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'SortOrder'})

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

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

The room space displayed in the Portal.

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

CreateRoomSpaceResponse dataclass

CreateRoomSpaceResponse(allocate_exclude: Optional[bool] = None, allocate_sort_order: Optional[int] = None, bathrooms: Optional[int] = None, bed_capacity: Optional[int] = None, comments: Optional[str] = None, description: Optional[str] = None, extension_id: Optional[int] = None, hold: Optional[bool] = None, networked: Optional[bool] = None, record_type_enum: Optional[str] = None, room_base_id: Optional[int] = None, room_id: Optional[int] = None, room_rate_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_type_enum: Optional[str] = None, security_user_id: Optional[int] = None, sort_order: Optional[int] = None, street: Optional[str] = None, street2: Optional[str] = None, web_description: Optional[str] = None, zip_postcode: Optional[str] = None)

Response for Create Room Space

Attributes

allocate_exclude class-attribute instance-attribute

allocate_exclude: Optional[bool] = field(default=None, metadata={'wire_name': 'AllocateExclude'})

Room Allocation - Do not include room in allocations.

allocate_sort_order class-attribute instance-attribute

allocate_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'AllocateSortOrder'})

Room Allocation - allows allocating nicer rooms first.

bathrooms class-attribute instance-attribute

bathrooms: Optional[int] = field(default=None, metadata={'wire_name': 'Bathrooms'})

The number of bathrooms available.

bed_capacity class-attribute instance-attribute

bed_capacity: Optional[int] = field(default=None, metadata={'wire_name': 'BedCapacity'})

The number of beds available.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Room space comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

The actual room name.

extension_id class-attribute instance-attribute

extension_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExtensionID'})

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

hold class-attribute instance-attribute

hold: Optional[bool] = field(default=None, metadata={'wire_name': 'Hold'})

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

networked class-attribute instance-attribute

networked: Optional[bool] = field(default=None, metadata={'wire_name': 'Networked'})

Indicates if the room space is networked.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

room_base_id class-attribute instance-attribute

room_base_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomBaseID'})

Pointer to the room base record.

room_id class-attribute instance-attribute

room_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomID'})

Pointer to the room record.

room_rate_id class-attribute instance-attribute

room_rate_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomRateID'})

Default tariff rate.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Unique ID for this room space record.

room_space_type_enum class-attribute instance-attribute

room_space_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RoomSpaceTypeEnum'})

Room space type.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

sort_order class-attribute instance-attribute

sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'SortOrder'})

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

street class-attribute instance-attribute

street: Optional[str] = field(default=None, metadata={'wire_name': 'Street'})

Street

street2 class-attribute instance-attribute

street2: Optional[str] = field(default=None, metadata={'wire_name': 'Street2'})

Street

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

The room space displayed in the Portal.

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode

SelectRoomLocationInput dataclass

SelectRoomLocationInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, allocate_sort_order: Optional[int] = None, category_id: Optional[int] = None, city: Optional[str] = None, comments: Optional[str] = None, country_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_modified: Optional[Dict[str, Any]] = None, description: Optional[str] = None, gender_type_enum: Optional[str] = None, lease: Optional[bool] = None, managed_externally: Optional[bool] = None, non_residential: Optional[bool] = None, record_type_enum: Optional[str] = None, room_location_area_id: Optional[int] = None, room_location_id: Optional[int] = None, state_province: Optional[str] = None, view_on_web: Optional[bool] = None, web_comments: Optional[str] = None, web_description: Optional[str] = None, web_image_alt_text: Optional[str] = None, web_image_location: Optional[str] = None, zip_postcode: Optional[str] = None)

Get Room Location

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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 class-attribute instance-attribute

allocate_sort_order: Optional[int] = field(default=None, metadata={'wire_name': 'AllocateSortOrder'})

Allocate sort order.

category_id class-attribute instance-attribute

category_id: Optional[int] = field(default=None, metadata={'wire_name': 'CategoryID'})

Pointer to the category record.

city class-attribute instance-attribute

city: Optional[str] = field(default=None, metadata={'wire_name': 'City'})

City

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Room location comments.

country_id class-attribute instance-attribute

country_id: Optional[int] = field(default=None, metadata={'wire_name': 'CountryID'})

Pointer to the country record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom boolean field value.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom boolean field value.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string field value.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string field value.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string field value.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string field value.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string field value.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string field value.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Room location description.

gender_type_enum class-attribute instance-attribute

gender_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'GenderTypeEnum'})

Gender type suitability.

lease class-attribute instance-attribute

lease: Optional[bool] = field(default=None, metadata={'wire_name': 'Lease'})

Indicates if the room location is leased.

managed_externally class-attribute instance-attribute

managed_externally: Optional[bool] = field(default=None, metadata={'wire_name': 'ManagedExternally'})

Indicates if the room location is managed externally.

non_residential class-attribute instance-attribute

non_residential: Optional[bool] = field(default=None, metadata={'wire_name': 'NonResidential'})

Indicates if the room location is non residential.

record_type_enum class-attribute instance-attribute

record_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'RecordTypeEnum'})

Record type.

room_location_area_id class-attribute instance-attribute

room_location_area_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationAreaID'})

Pointer to the room location area record.

room_location_id class-attribute instance-attribute

room_location_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomLocationID'})

Unique ID for this room location record.

state_province class-attribute instance-attribute

state_province: Optional[str] = field(default=None, metadata={'wire_name': 'StateProvince'})

State/Province

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

Indicates if the room space is viewable on the web.

web_comments class-attribute instance-attribute

web_comments: Optional[str] = field(default=None, metadata={'wire_name': 'WebComments'})

Comments to display if visible on the web.

web_description class-attribute instance-attribute

web_description: Optional[str] = field(default=None, metadata={'wire_name': 'WebDescription'})

Description to display if visible on the web.

web_image_alt_text class-attribute instance-attribute

web_image_alt_text: Optional[str] = field(default=None, metadata={'wire_name': 'WebImageAltText'})

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

web_image_location class-attribute instance-attribute

web_image_location: Optional[str] = field(default=None, metadata={'wire_name': 'WebImageLocation'})

Path for the web image.

zip_postcode class-attribute instance-attribute

zip_postcode: Optional[str] = field(default=None, metadata={'wire_name': 'ZipPostcode'})

Zip/Postcode.

SelectTransactionInput dataclass

SelectTransactionInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, amount: Optional[float] = None, call_type_enum: Optional[str] = None, charge_group_id: Optional[int] = None, charge_item_id: Optional[int] = None, comments: Optional[str] = None, created_by_security_user_id: Optional[int] = None, date_modified: Optional[Dict[str, Any]] = None, description: Optional[str] = None, due_date: Optional[Dict[str, Any]] = None, duration: Optional[int] = None, end_of_session_id: Optional[int] = None, entry_id: Optional[int] = None, excess: Optional[float] = None, extension: Optional[int] = None, external_id: Optional[int] = None, external_receipt_id: Optional[str] = None, invoice_id: Optional[int] = None, paid_from: Optional[Dict[str, Any]] = None, paid_to: Optional[Dict[str, Any]] = None, payment_id: Optional[int] = None, processed_date: Optional[Dict[str, Any]] = None, reference_booking_id: Optional[int] = None, security_user_id: Optional[int] = None, table_id: Optional[int] = None, table_name: Optional[str] = None, tag: Optional[str] = None, tag_finance: Optional[str] = None, tax_amount: Optional[float] = None, tax_amount2: Optional[float] = None, tax_amount3: Optional[float] = None, term_session_id: Optional[int] = None, transaction_date: Optional[Dict[str, Any]] = None, transaction_id: Optional[int] = None, transaction_type_enum: Optional[str] = None)

Get Transaction

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

amount class-attribute instance-attribute

amount: Optional[float] = field(default=None, metadata={'wire_name': 'Amount'})

The total amount for this transaction (including tax).

call_type_enum class-attribute instance-attribute

call_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CallTypeEnum'})

Call type.

charge_group_id class-attribute instance-attribute

charge_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeGroupID'})

Pointer to the charge group record.

charge_item_id class-attribute instance-attribute

charge_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeItemID'})

Pointer to the charge item record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Transaction comments.

created_by_security_user_id class-attribute instance-attribute

created_by_security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'CreatedBy_SecurityUserID'})

Pointer to the created by security user record.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Transaction description.

duration class-attribute instance-attribute

duration: Optional[int] = field(default=None, metadata={'wire_name': 'Duration'})

Phone call duration in seconds.

end_of_session_id class-attribute instance-attribute

end_of_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'EndOfSessionID'})

Pointer to the end of session record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Excess amount.

extension class-attribute instance-attribute

extension: Optional[int] = field(default=None, metadata={'wire_name': 'Extension'})

Extension qty.

external_id class-attribute instance-attribute

external_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExternalID'})

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

external_receipt_id class-attribute instance-attribute

external_receipt_id: Optional[str] = field(default=None, metadata={'wire_name': 'ExternalReceiptID'})

Pointer to the external receipt record.

invoice_id class-attribute instance-attribute

invoice_id: Optional[int] = field(default=None, metadata={'wire_name': 'InvoiceID'})

Pointer to the invoice record.

payment_id class-attribute instance-attribute

payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'PaymentID'})

Pointer to the payment record.

reference_booking_id class-attribute instance-attribute

reference_booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'Reference_BookingID'})

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

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

table_id class-attribute instance-attribute

table_id: Optional[int] = field(default=None, metadata={'wire_name': 'TableID'})

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

table_name class-attribute instance-attribute

table_name: Optional[str] = field(default=None, metadata={'wire_name': 'TableName'})

Reference link table.

tag class-attribute instance-attribute

tag: Optional[str] = field(default=None, metadata={'wire_name': 'Tag'})

Transaction tag.

tag_finance class-attribute instance-attribute

tag_finance: Optional[str] = field(default=None, metadata={'wire_name': 'TagFinance'})

Finance tag.

tax_amount class-attribute instance-attribute

tax_amount: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount'})

Tax amount

tax_amount2 class-attribute instance-attribute

tax_amount2: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount2'})

Tax amount

tax_amount3 class-attribute instance-attribute

tax_amount3: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount3'})

Tax amount

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

transaction_id class-attribute instance-attribute

transaction_id: Optional[int] = field(default=None, metadata={'wire_name': 'TransactionID'})

Unique ID for this transaction record.

transaction_type_enum class-attribute instance-attribute

transaction_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TransactionTypeEnum'})

Transaction type.

CreateTransactionInput dataclass

CreateTransactionInput(amount: Optional[float] = None, call_type_enum: Optional[str] = None, charge_group_id: Optional[int] = None, charge_item_id: Optional[int] = None, comments: Optional[str] = None, description: Optional[str] = None, due_date: Optional[str] = None, duration: Optional[int] = None, end_of_session_id: Optional[int] = None, entry_id: Optional[int] = None, excess: Optional[float] = None, extension: Optional[int] = None, external_id: Optional[int] = None, external_receipt_id: Optional[str] = None, invoice_id: Optional[int] = None, paid_from: Optional[str] = None, paid_to: Optional[str] = None, payment_id: Optional[int] = None, processed_date: Optional[str] = None, reference_booking_id: Optional[int] = None, security_user_id: Optional[int] = None, table_id: Optional[int] = None, table_name: Optional[str] = None, tag: Optional[str] = None, tag_finance: Optional[str] = None, tax_amount: Optional[float] = None, tax_amount2: Optional[float] = None, tax_amount3: Optional[float] = None, term_session_id: Optional[int] = None, transaction_date: Optional[str] = None, transaction_id: Optional[int] = None, transaction_type_enum: Optional[str] = None)

Create Transaction

Attributes

amount class-attribute instance-attribute

amount: Optional[float] = field(default=None, metadata={'wire_name': 'Amount'})

The total amount for this transaction (including tax).

call_type_enum class-attribute instance-attribute

call_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CallTypeEnum'})

Call type.

charge_group_id class-attribute instance-attribute

charge_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeGroupID'})

Pointer to the charge group record.

charge_item_id class-attribute instance-attribute

charge_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeItemID'})

This is only required for Adjustments and Charges.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Transaction comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Transaction description.

due_date class-attribute instance-attribute

due_date: Optional[str] = field(default=None, metadata={'wire_name': 'DueDate'})

Due date.

duration class-attribute instance-attribute

duration: Optional[int] = field(default=None, metadata={'wire_name': 'Duration'})

Phone call duration in seconds.

end_of_session_id class-attribute instance-attribute

end_of_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'EndOfSessionID'})

Pointer to the end of session record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Excess amount.

extension class-attribute instance-attribute

extension: Optional[int] = field(default=None, metadata={'wire_name': 'Extension'})

Extension qty.

external_id class-attribute instance-attribute

external_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExternalID'})

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

external_receipt_id class-attribute instance-attribute

external_receipt_id: Optional[str] = field(default=None, metadata={'wire_name': 'ExternalReceiptID'})

Pointer to the external receipt record.

invoice_id class-attribute instance-attribute

invoice_id: Optional[int] = field(default=None, metadata={'wire_name': 'InvoiceID'})

Pointer to the invoice record.

paid_from class-attribute instance-attribute

paid_from: Optional[str] = field(default=None, metadata={'wire_name': 'PaidFrom'})

Paid from date.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Paid to date.

payment_id class-attribute instance-attribute

payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'PaymentID'})

Pointer to the payment record.

processed_date class-attribute instance-attribute

processed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ProcessedDate'})

Date transaction was processed.

reference_booking_id class-attribute instance-attribute

reference_booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'Reference_BookingID'})

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

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

table_id class-attribute instance-attribute

table_id: Optional[int] = field(default=None, metadata={'wire_name': 'TableID'})

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

table_name class-attribute instance-attribute

table_name: Optional[str] = field(default=None, metadata={'wire_name': 'TableName'})

Reference link table.

tag class-attribute instance-attribute

tag: Optional[str] = field(default=None, metadata={'wire_name': 'Tag'})

Transaction tag.

tag_finance class-attribute instance-attribute

tag_finance: Optional[str] = field(default=None, metadata={'wire_name': 'TagFinance'})

Finance tag.

tax_amount class-attribute instance-attribute

tax_amount: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount'})

Tax amount

tax_amount2 class-attribute instance-attribute

tax_amount2: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount2'})

Tax amount

tax_amount3 class-attribute instance-attribute

tax_amount3: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount3'})

Tax amount

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

transaction_date class-attribute instance-attribute

transaction_date: Optional[str] = field(default=None, metadata={'wire_name': 'TransactionDate'})

Date of the transaction.

transaction_id class-attribute instance-attribute

transaction_id: Optional[int] = field(default=None, metadata={'wire_name': 'TransactionID'})

Unique ID for this transaction record.

transaction_type_enum class-attribute instance-attribute

transaction_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TransactionTypeEnum'})

Transaction type.

CreateTransactionResponse dataclass

CreateTransactionResponse(amount: Optional[float] = None, call_type_enum: Optional[str] = None, charge_group_id: Optional[int] = None, charge_item_id: Optional[int] = None, comments: Optional[str] = None, description: Optional[str] = None, due_date: Optional[str] = None, duration: Optional[int] = None, end_of_session_id: Optional[int] = None, entry_id: Optional[int] = None, excess: Optional[float] = None, extension: Optional[int] = None, external_id: Optional[int] = None, external_receipt_id: Optional[str] = None, invoice_id: Optional[int] = None, paid_from: Optional[str] = None, paid_to: Optional[str] = None, payment_id: Optional[int] = None, processed_date: Optional[str] = None, reference_booking_id: Optional[int] = None, security_user_id: Optional[int] = None, table_id: Optional[int] = None, table_name: Optional[str] = None, tag: Optional[str] = None, tag_finance: Optional[str] = None, tax_amount: Optional[float] = None, tax_amount2: Optional[float] = None, tax_amount3: Optional[float] = None, term_session_id: Optional[int] = None, transaction_date: Optional[str] = None, transaction_id: Optional[int] = None, transaction_type_enum: Optional[str] = None)

Response for Create Transaction

Attributes

amount class-attribute instance-attribute

amount: Optional[float] = field(default=None, metadata={'wire_name': 'Amount'})

The total amount for this transaction (including tax).

call_type_enum class-attribute instance-attribute

call_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'CallTypeEnum'})

Call type.

charge_group_id class-attribute instance-attribute

charge_group_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeGroupID'})

Pointer to the charge group record.

charge_item_id class-attribute instance-attribute

charge_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'ChargeItemID'})

Pointer to the charge item record.

comments class-attribute instance-attribute

comments: Optional[str] = field(default=None, metadata={'wire_name': 'Comments'})

Transaction comments.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Transaction description.

due_date class-attribute instance-attribute

due_date: Optional[str] = field(default=None, metadata={'wire_name': 'DueDate'})

Due date.

duration class-attribute instance-attribute

duration: Optional[int] = field(default=None, metadata={'wire_name': 'Duration'})

Phone call duration in seconds.

end_of_session_id class-attribute instance-attribute

end_of_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'EndOfSessionID'})

Pointer to the end of session record.

entry_id class-attribute instance-attribute

entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'EntryID'})

Pointer to the entry record.

excess class-attribute instance-attribute

excess: Optional[float] = field(default=None, metadata={'wire_name': 'Excess'})

Excess amount.

extension class-attribute instance-attribute

extension: Optional[int] = field(default=None, metadata={'wire_name': 'Extension'})

Extension qty.

external_id class-attribute instance-attribute

external_id: Optional[int] = field(default=None, metadata={'wire_name': 'ExternalID'})

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

external_receipt_id class-attribute instance-attribute

external_receipt_id: Optional[str] = field(default=None, metadata={'wire_name': 'ExternalReceiptID'})

Pointer to the external receipt record.

invoice_id class-attribute instance-attribute

invoice_id: Optional[int] = field(default=None, metadata={'wire_name': 'InvoiceID'})

Pointer to the invoice record.

paid_from class-attribute instance-attribute

paid_from: Optional[str] = field(default=None, metadata={'wire_name': 'PaidFrom'})

Paid from date.

paid_to class-attribute instance-attribute

paid_to: Optional[str] = field(default=None, metadata={'wire_name': 'PaidTo'})

Paid to date.

payment_id class-attribute instance-attribute

payment_id: Optional[int] = field(default=None, metadata={'wire_name': 'PaymentID'})

Pointer to the payment record.

processed_date class-attribute instance-attribute

processed_date: Optional[str] = field(default=None, metadata={'wire_name': 'ProcessedDate'})

Date transaction was processed.

reference_booking_id class-attribute instance-attribute

reference_booking_id: Optional[int] = field(default=None, metadata={'wire_name': 'Reference_BookingID'})

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

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

table_id class-attribute instance-attribute

table_id: Optional[int] = field(default=None, metadata={'wire_name': 'TableID'})

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

table_name class-attribute instance-attribute

table_name: Optional[str] = field(default=None, metadata={'wire_name': 'TableName'})

Reference link table.

tag class-attribute instance-attribute

tag: Optional[str] = field(default=None, metadata={'wire_name': 'Tag'})

Transaction tag.

tag_finance class-attribute instance-attribute

tag_finance: Optional[str] = field(default=None, metadata={'wire_name': 'TagFinance'})

Finance tag.

tax_amount class-attribute instance-attribute

tax_amount: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount'})

Tax amount

tax_amount2 class-attribute instance-attribute

tax_amount2: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount2'})

Tax amount

tax_amount3 class-attribute instance-attribute

tax_amount3: Optional[float] = field(default=None, metadata={'wire_name': 'TaxAmount3'})

Tax amount

term_session_id class-attribute instance-attribute

term_session_id: Optional[int] = field(default=None, metadata={'wire_name': 'TermSessionID'})

Pointer to the term session record.

transaction_date class-attribute instance-attribute

transaction_date: Optional[str] = field(default=None, metadata={'wire_name': 'TransactionDate'})

Date of the transaction.

transaction_id class-attribute instance-attribute

transaction_id: Optional[int] = field(default=None, metadata={'wire_name': 'TransactionID'})

Unique ID for this transaction record.

transaction_type_enum class-attribute instance-attribute

transaction_type_enum: Optional[str] = field(default=None, metadata={'wire_name': 'TransactionTypeEnum'})

Transaction type.

SelectRoomSpaceMaintenanceInput dataclass

SelectRoomSpaceMaintenanceInput(return_empty_array_on_no_result: Optional[bool] = None, page_size: Optional[int] = None, page_index: Optional[int] = None, orderby: Optional[str] = None, account_code: Optional[str] = None, cause: Optional[str] = None, charge: Optional[bool] = None, charge_entry_id: Optional[int] = None, charge_amount: Optional[float] = None, charge_invoiced: Optional[bool] = None, charge_invoice_number: Optional[str] = None, charge_type: Optional[str] = None, complete_date: Optional[Dict[str, Any]] = None, contact_id: Optional[int] = None, contract_date: Optional[Dict[str, Any]] = None, contractor_cost: Optional[float] = None, contractor_cost_estimate: Optional[float] = None, contractor_date: Optional[Dict[str, Any]] = None, contractor_e_t_a: Optional[str] = None, contractor_order_number: Optional[str] = None, created_by_security_user_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[Dict[str, Any]] = None, custom_date2: Optional[Dict[str, Any]] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_created: Optional[Dict[str, Any]] = None, date_due: Optional[Dict[str, Any]] = None, date_modified: Optional[Dict[str, Any]] = None, date_reported: Optional[Dict[str, Any]] = None, description: Optional[str] = None, job_sent: Optional[bool] = None, job_status: Optional[str] = None, location: Optional[str] = None, occupant_entry_id: Optional[int] = None, occupant_entry_name: Optional[str] = None, occupant_present: Optional[bool] = None, occupant_present_reason: Optional[str] = None, other_service_number: Optional[str] = None, priority_id: Optional[int] = None, repair_description: Optional[str] = None, reported_by_name: Optional[str] = None, reported_by_phone: Optional[str] = None, room_space_closed_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_maintenance_category_id: Optional[int] = None, room_space_maintenance_id: Optional[int] = None, room_space_maintenance_item_id: Optional[int] = None, security_user_id: Optional[int] = None, start_date: Optional[Dict[str, Any]] = None, status: Optional[str] = None, technician: Optional[str] = None, view_on_web: Optional[bool] = None)

Get Room Space Maintenance

Attributes

return_empty_array_on_no_result class-attribute instance-attribute

return_empty_array_on_no_result: Optional[bool] = field(default=None, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})

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

page_size class-attribute instance-attribute

page_size: Optional[int] = field(default=None, metadata={'wire_name': '_pageSize'})

Maximum number of records to return.

page_index class-attribute instance-attribute

page_index: Optional[int] = field(default=None, metadata={'wire_name': '_pageIndex'})

Index of the first record to return.

orderby class-attribute instance-attribute

orderby: Optional[str] = field(default=None, metadata={'wire_name': '_orderby'})

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

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

cause class-attribute instance-attribute

cause: Optional[str] = field(default=None, metadata={'wire_name': 'Cause'})

Cause.

charge class-attribute instance-attribute

charge: Optional[bool] = field(default=None, metadata={'wire_name': 'Charge'})

Indicates if a charge should be applied.

charge_entry_id class-attribute instance-attribute

charge_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Charge_EntryID'})

Pointer to the charge entry record.

charge_amount class-attribute instance-attribute

charge_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ChargeAmount'})

Charge amount.

charge_invoiced class-attribute instance-attribute

charge_invoiced: Optional[bool] = field(default=None, metadata={'wire_name': 'ChargeInvoiced'})

Indicates if the charge has been invoiced.

charge_invoice_number class-attribute instance-attribute

charge_invoice_number: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeInvoiceNumber'})

Charge invoice number.

charge_type class-attribute instance-attribute

charge_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeType'})

Charge type.

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

contractor_cost class-attribute instance-attribute

contractor_cost: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCost'})

Contractor cost.

contractor_cost_estimate class-attribute instance-attribute

contractor_cost_estimate: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCostEstimate'})

Contractor cost estimate.

contractor_e_t_a class-attribute instance-attribute

contractor_e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorETA'})

Contractor ETA.

contractor_order_number class-attribute instance-attribute

contractor_order_number: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorOrderNumber'})

Contractor order number.

created_by_security_user_id class-attribute instance-attribute

created_by_security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'CreatedBy_SecurityUserID'})

Pointer to the security user record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom bit 1.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom bit 2.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string 1.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string 2.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string 3.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string 4.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string 5.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string 6.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Description.

job_sent class-attribute instance-attribute

job_sent: Optional[bool] = field(default=None, metadata={'wire_name': 'JobSent'})

Indicates if a job has been sent.

job_status class-attribute instance-attribute

job_status: Optional[str] = field(default=None, metadata={'wire_name': 'JobStatus'})

Job status.

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location.

occupant_entry_id class-attribute instance-attribute

occupant_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Occupant_EntryID'})

Pointer to the occupant entry record.

occupant_entry_name class-attribute instance-attribute

occupant_entry_name: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantEntryName'})

Occupant entry name.

occupant_present class-attribute instance-attribute

occupant_present: Optional[bool] = field(default=None, metadata={'wire_name': 'OccupantPresent'})

Indicates if an occupant is present.

occupant_present_reason class-attribute instance-attribute

occupant_present_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantPresentReason'})

Occupant present reason.

other_service_number class-attribute instance-attribute

other_service_number: Optional[str] = field(default=None, metadata={'wire_name': 'OtherServiceNumber'})

Other service number.

priority_id class-attribute instance-attribute

priority_id: Optional[int] = field(default=None, metadata={'wire_name': 'PriorityID'})

Pointer to the priority record.

repair_description class-attribute instance-attribute

repair_description: Optional[str] = field(default=None, metadata={'wire_name': 'RepairDescription'})

Repair description.

reported_by_name class-attribute instance-attribute

reported_by_name: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByName'})

Reported by name.

reported_by_phone class-attribute instance-attribute

reported_by_phone: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByPhone'})

Reported by phone.

room_space_closed_id class-attribute instance-attribute

room_space_closed_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceClosedID'})

Pointer to the room space closed record.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_space_maintenance_category_id class-attribute instance-attribute

room_space_maintenance_category_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})

Pointer to the room space maintenance category record.

room_space_maintenance_id class-attribute instance-attribute

room_space_maintenance_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceID'})

Unique ID for this room space maintenance record.

room_space_maintenance_item_id class-attribute instance-attribute

room_space_maintenance_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})

Pointer to the room space maintenance item record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

status class-attribute instance-attribute

status: Optional[str] = field(default=None, metadata={'wire_name': 'Status'})

Status.

technician class-attribute instance-attribute

technician: Optional[str] = field(default=None, metadata={'wire_name': 'Technician'})

Technician.

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

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

CreateRoomSpaceMaintenanceInput dataclass

CreateRoomSpaceMaintenanceInput(account_code: Optional[str] = None, cause: Optional[str] = None, charge: Optional[bool] = None, charge_entry_id: Optional[int] = None, charge_amount: Optional[float] = None, charge_invoiced: Optional[bool] = None, charge_invoice_number: Optional[str] = None, charge_type: Optional[str] = None, complete_date: Optional[str] = None, contact_id: Optional[int] = None, contract_date: Optional[str] = None, contractor_cost: Optional[float] = None, contractor_cost_estimate: Optional[float] = None, contractor_date: Optional[str] = None, contractor_e_t_a: Optional[str] = None, contractor_order_number: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_due: Optional[str] = None, date_reported: Optional[str] = None, description: Optional[str] = None, job_sent: Optional[bool] = None, job_status: Optional[str] = None, location: Optional[str] = None, occupant_entry_id: Optional[int] = None, occupant_entry_name: Optional[str] = None, occupant_present: Optional[bool] = None, occupant_present_reason: Optional[str] = None, other_service_number: Optional[str] = None, priority_id: Optional[int] = None, repair_description: Optional[str] = None, reported_by_name: Optional[str] = None, reported_by_phone: Optional[str] = None, room_space_closed_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_maintenance_category_id: Optional[int] = None, room_space_maintenance_id: Optional[int] = None, room_space_maintenance_item_id: Optional[int] = None, security_user_id: Optional[int] = None, start_date: Optional[str] = None, status: Optional[str] = None, technician: Optional[str] = None, view_on_web: Optional[bool] = None)

Create Room Space Maintenance

Attributes

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

cause class-attribute instance-attribute

cause: Optional[str] = field(default=None, metadata={'wire_name': 'Cause'})

Cause.

charge class-attribute instance-attribute

charge: Optional[bool] = field(default=None, metadata={'wire_name': 'Charge'})

Indicates if a charge should be applied.

charge_entry_id class-attribute instance-attribute

charge_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Charge_EntryID'})

Pointer to the charge entry record.

charge_amount class-attribute instance-attribute

charge_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ChargeAmount'})

Charge amount.

charge_invoiced class-attribute instance-attribute

charge_invoiced: Optional[bool] = field(default=None, metadata={'wire_name': 'ChargeInvoiced'})

Indicates if the charge has been invoiced.

charge_invoice_number class-attribute instance-attribute

charge_invoice_number: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeInvoiceNumber'})

Charge invoice number.

charge_type class-attribute instance-attribute

charge_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeType'})

Charge type.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Complete date.

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

contract_date class-attribute instance-attribute

contract_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDate'})

Contract date.

contractor_cost class-attribute instance-attribute

contractor_cost: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCost'})

Contractor cost.

contractor_cost_estimate class-attribute instance-attribute

contractor_cost_estimate: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCostEstimate'})

Contractor cost estimate.

contractor_date class-attribute instance-attribute

contractor_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorDate'})

Contractor date.

contractor_e_t_a class-attribute instance-attribute

contractor_e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorETA'})

Contractor ETA.

contractor_order_number class-attribute instance-attribute

contractor_order_number: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorOrderNumber'})

Contractor order number.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom bit 1.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom bit 2.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date 1.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date 2.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string 1.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string 2.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string 3.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string 4.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string 5.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string 6.

date_due class-attribute instance-attribute

date_due: Optional[str] = field(default=None, metadata={'wire_name': 'DateDue'})

Date due.

date_reported class-attribute instance-attribute

date_reported: Optional[str] = field(default=None, metadata={'wire_name': 'DateReported'})

Date reported.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Description.

job_sent class-attribute instance-attribute

job_sent: Optional[bool] = field(default=None, metadata={'wire_name': 'JobSent'})

Indicates if a job has been sent.

job_status class-attribute instance-attribute

job_status: Optional[str] = field(default=None, metadata={'wire_name': 'JobStatus'})

Job status.

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location.

occupant_entry_id class-attribute instance-attribute

occupant_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Occupant_EntryID'})

Pointer to the occupant entry record.

occupant_entry_name class-attribute instance-attribute

occupant_entry_name: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantEntryName'})

Occupant entry name.

occupant_present class-attribute instance-attribute

occupant_present: Optional[bool] = field(default=None, metadata={'wire_name': 'OccupantPresent'})

Indicates if an occupant is present.

occupant_present_reason class-attribute instance-attribute

occupant_present_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantPresentReason'})

Occupant present reason.

other_service_number class-attribute instance-attribute

other_service_number: Optional[str] = field(default=None, metadata={'wire_name': 'OtherServiceNumber'})

Other service number.

priority_id class-attribute instance-attribute

priority_id: Optional[int] = field(default=None, metadata={'wire_name': 'PriorityID'})

Pointer to the priority record.

repair_description class-attribute instance-attribute

repair_description: Optional[str] = field(default=None, metadata={'wire_name': 'RepairDescription'})

Repair description.

reported_by_name class-attribute instance-attribute

reported_by_name: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByName'})

Reported by name.

reported_by_phone class-attribute instance-attribute

reported_by_phone: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByPhone'})

Reported by phone.

room_space_closed_id class-attribute instance-attribute

room_space_closed_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceClosedID'})

Pointer to the room space closed record.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_space_maintenance_category_id class-attribute instance-attribute

room_space_maintenance_category_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})

Pointer to the room space maintenance category record.

room_space_maintenance_id class-attribute instance-attribute

room_space_maintenance_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceID'})

Unique ID for this room space maintenance record.

room_space_maintenance_item_id class-attribute instance-attribute

room_space_maintenance_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})

Pointer to the room space maintenance item record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'StartDate'})

Start date.

status class-attribute instance-attribute

status: Optional[str] = field(default=None, metadata={'wire_name': 'Status'})

Status.

technician class-attribute instance-attribute

technician: Optional[str] = field(default=None, metadata={'wire_name': 'Technician'})

Technician.

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

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

CreateRoomSpaceMaintenanceResponse dataclass

CreateRoomSpaceMaintenanceResponse(account_code: Optional[str] = None, cause: Optional[str] = None, charge: Optional[bool] = None, charge_entry_id: Optional[int] = None, charge_amount: Optional[float] = None, charge_invoiced: Optional[bool] = None, charge_invoice_number: Optional[str] = None, charge_type: Optional[str] = None, complete_date: Optional[str] = None, contact_id: Optional[int] = None, contract_date: Optional[str] = None, contractor_cost: Optional[float] = None, contractor_cost_estimate: Optional[float] = None, contractor_date: Optional[str] = None, contractor_e_t_a: Optional[str] = None, contractor_order_number: Optional[str] = None, created_by_security_user_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_created: Optional[str] = None, date_due: Optional[str] = None, date_modified: Optional[str] = None, date_reported: Optional[str] = None, description: Optional[str] = None, job_sent: Optional[bool] = None, job_status: Optional[str] = None, location: Optional[str] = None, occupant_entry_id: Optional[int] = None, occupant_entry_name: Optional[str] = None, occupant_present: Optional[bool] = None, occupant_present_reason: Optional[str] = None, other_service_number: Optional[str] = None, priority_id: Optional[int] = None, repair_description: Optional[str] = None, reported_by_name: Optional[str] = None, reported_by_phone: Optional[str] = None, room_space_closed_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_maintenance_category_id: Optional[int] = None, room_space_maintenance_id: Optional[int] = None, room_space_maintenance_item_id: Optional[int] = None, security_user_id: Optional[int] = None, start_date: Optional[str] = None, status: Optional[str] = None, technician: Optional[str] = None, view_on_web: Optional[bool] = None)

Response for Create Room Space Maintenance

Attributes

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

cause class-attribute instance-attribute

cause: Optional[str] = field(default=None, metadata={'wire_name': 'Cause'})

Cause.

charge class-attribute instance-attribute

charge: Optional[bool] = field(default=None, metadata={'wire_name': 'Charge'})

Indicates if a charge should be applied.

charge_entry_id class-attribute instance-attribute

charge_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Charge_EntryID'})

Pointer to the charge entry record.

charge_amount class-attribute instance-attribute

charge_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ChargeAmount'})

Charge amount.

charge_invoiced class-attribute instance-attribute

charge_invoiced: Optional[bool] = field(default=None, metadata={'wire_name': 'ChargeInvoiced'})

Indicates if the charge has been invoiced.

charge_invoice_number class-attribute instance-attribute

charge_invoice_number: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeInvoiceNumber'})

Charge invoice number.

charge_type class-attribute instance-attribute

charge_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeType'})

Charge type.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Complete date.

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

contract_date class-attribute instance-attribute

contract_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDate'})

Contract date.

contractor_cost class-attribute instance-attribute

contractor_cost: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCost'})

Contractor cost.

contractor_cost_estimate class-attribute instance-attribute

contractor_cost_estimate: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCostEstimate'})

Contractor cost estimate.

contractor_date class-attribute instance-attribute

contractor_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorDate'})

Contractor date.

contractor_e_t_a class-attribute instance-attribute

contractor_e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorETA'})

Contractor ETA.

contractor_order_number class-attribute instance-attribute

contractor_order_number: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorOrderNumber'})

Contractor order number.

created_by_security_user_id class-attribute instance-attribute

created_by_security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'CreatedBy_SecurityUserID'})

Pointer to the security user record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom bit 1.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom bit 2.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date 1.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date 2.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string 1.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string 2.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string 3.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string 4.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string 5.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string 6.

date_created class-attribute instance-attribute

date_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateCreated'})

Date created.

date_due class-attribute instance-attribute

date_due: Optional[str] = field(default=None, metadata={'wire_name': 'DateDue'})

Date due.

date_modified class-attribute instance-attribute

date_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateModified'})

Date modified.

date_reported class-attribute instance-attribute

date_reported: Optional[str] = field(default=None, metadata={'wire_name': 'DateReported'})

Date reported.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Description.

job_sent class-attribute instance-attribute

job_sent: Optional[bool] = field(default=None, metadata={'wire_name': 'JobSent'})

Indicates if a job has been sent.

job_status class-attribute instance-attribute

job_status: Optional[str] = field(default=None, metadata={'wire_name': 'JobStatus'})

Job status.

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location.

occupant_entry_id class-attribute instance-attribute

occupant_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Occupant_EntryID'})

Pointer to the occupant entry record.

occupant_entry_name class-attribute instance-attribute

occupant_entry_name: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantEntryName'})

Occupant entry name.

occupant_present class-attribute instance-attribute

occupant_present: Optional[bool] = field(default=None, metadata={'wire_name': 'OccupantPresent'})

Indicates if an occupant is present.

occupant_present_reason class-attribute instance-attribute

occupant_present_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantPresentReason'})

Occupant present reason.

other_service_number class-attribute instance-attribute

other_service_number: Optional[str] = field(default=None, metadata={'wire_name': 'OtherServiceNumber'})

Other service number.

priority_id class-attribute instance-attribute

priority_id: Optional[int] = field(default=None, metadata={'wire_name': 'PriorityID'})

Pointer to the priority record.

repair_description class-attribute instance-attribute

repair_description: Optional[str] = field(default=None, metadata={'wire_name': 'RepairDescription'})

Repair description.

reported_by_name class-attribute instance-attribute

reported_by_name: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByName'})

Reported by name.

reported_by_phone class-attribute instance-attribute

reported_by_phone: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByPhone'})

Reported by phone.

room_space_closed_id class-attribute instance-attribute

room_space_closed_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceClosedID'})

Pointer to the room space closed record.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_space_maintenance_category_id class-attribute instance-attribute

room_space_maintenance_category_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})

Pointer to the room space maintenance category record.

room_space_maintenance_id class-attribute instance-attribute

room_space_maintenance_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceID'})

Unique ID for this room space maintenance record.

room_space_maintenance_item_id class-attribute instance-attribute

room_space_maintenance_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})

Pointer to the room space maintenance item record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'StartDate'})

Start date.

status class-attribute instance-attribute

status: Optional[str] = field(default=None, metadata={'wire_name': 'Status'})

Status.

technician class-attribute instance-attribute

technician: Optional[str] = field(default=None, metadata={'wire_name': 'Technician'})

Technician.

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

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

UpdateRoomSpaceMaintenanceInput dataclass

UpdateRoomSpaceMaintenanceInput(account_code: Optional[str] = None, cause: Optional[str] = None, charge: Optional[bool] = None, charge_entry_id: Optional[int] = None, charge_amount: Optional[float] = None, charge_invoiced: Optional[bool] = None, charge_invoice_number: Optional[str] = None, charge_type: Optional[str] = None, complete_date: Optional[str] = None, contact_id: Optional[int] = None, contract_date: Optional[str] = None, contractor_cost: Optional[float] = None, contractor_cost_estimate: Optional[float] = None, contractor_date: Optional[str] = None, contractor_e_t_a: Optional[str] = None, contractor_order_number: Optional[str] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_due: Optional[str] = None, date_reported: Optional[str] = None, description: Optional[str] = None, job_sent: Optional[bool] = None, job_status: Optional[str] = None, location: Optional[str] = None, occupant_entry_id: Optional[int] = None, occupant_entry_name: Optional[str] = None, occupant_present: Optional[bool] = None, occupant_present_reason: Optional[str] = None, other_service_number: Optional[str] = None, priority_id: Optional[int] = None, repair_description: Optional[str] = None, reported_by_name: Optional[str] = None, reported_by_phone: Optional[str] = None, room_space_closed_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_maintenance_category_id: Optional[int] = None, room_space_maintenance_id: Optional[int] = None, room_space_maintenance_item_id: Optional[int] = None, security_user_id: Optional[int] = None, start_date: Optional[str] = None, status: Optional[str] = None, technician: Optional[str] = None, view_on_web: Optional[bool] = None)

Update Room Space Maintenance

Attributes

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

cause class-attribute instance-attribute

cause: Optional[str] = field(default=None, metadata={'wire_name': 'Cause'})

Cause.

charge class-attribute instance-attribute

charge: Optional[bool] = field(default=None, metadata={'wire_name': 'Charge'})

Indicates if a charge should be applied.

charge_entry_id class-attribute instance-attribute

charge_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Charge_EntryID'})

Pointer to the charge entry record.

charge_amount class-attribute instance-attribute

charge_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ChargeAmount'})

Charge amount.

charge_invoiced class-attribute instance-attribute

charge_invoiced: Optional[bool] = field(default=None, metadata={'wire_name': 'ChargeInvoiced'})

Indicates if the charge has been invoiced.

charge_invoice_number class-attribute instance-attribute

charge_invoice_number: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeInvoiceNumber'})

Charge invoice number.

charge_type class-attribute instance-attribute

charge_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeType'})

Charge type.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Complete date.

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

contract_date class-attribute instance-attribute

contract_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDate'})

Contract date.

contractor_cost class-attribute instance-attribute

contractor_cost: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCost'})

Contractor cost.

contractor_cost_estimate class-attribute instance-attribute

contractor_cost_estimate: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCostEstimate'})

Contractor cost estimate.

contractor_date class-attribute instance-attribute

contractor_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorDate'})

Contractor date.

contractor_e_t_a class-attribute instance-attribute

contractor_e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorETA'})

Contractor ETA.

contractor_order_number class-attribute instance-attribute

contractor_order_number: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorOrderNumber'})

Contractor order number.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom bit 1.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom bit 2.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date 1.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date 2.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string 1.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string 2.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string 3.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string 4.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string 5.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string 6.

date_due class-attribute instance-attribute

date_due: Optional[str] = field(default=None, metadata={'wire_name': 'DateDue'})

Date due.

date_reported class-attribute instance-attribute

date_reported: Optional[str] = field(default=None, metadata={'wire_name': 'DateReported'})

Date reported.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Description.

job_sent class-attribute instance-attribute

job_sent: Optional[bool] = field(default=None, metadata={'wire_name': 'JobSent'})

Indicates if a job has been sent.

job_status class-attribute instance-attribute

job_status: Optional[str] = field(default=None, metadata={'wire_name': 'JobStatus'})

Job status.

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location.

occupant_entry_id class-attribute instance-attribute

occupant_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Occupant_EntryID'})

Pointer to the occupant entry record.

occupant_entry_name class-attribute instance-attribute

occupant_entry_name: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantEntryName'})

Occupant entry name.

occupant_present class-attribute instance-attribute

occupant_present: Optional[bool] = field(default=None, metadata={'wire_name': 'OccupantPresent'})

Indicates if an occupant is present.

occupant_present_reason class-attribute instance-attribute

occupant_present_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantPresentReason'})

Occupant present reason.

other_service_number class-attribute instance-attribute

other_service_number: Optional[str] = field(default=None, metadata={'wire_name': 'OtherServiceNumber'})

Other service number.

priority_id class-attribute instance-attribute

priority_id: Optional[int] = field(default=None, metadata={'wire_name': 'PriorityID'})

Pointer to the priority record.

repair_description class-attribute instance-attribute

repair_description: Optional[str] = field(default=None, metadata={'wire_name': 'RepairDescription'})

Repair description.

reported_by_name class-attribute instance-attribute

reported_by_name: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByName'})

Reported by name.

reported_by_phone class-attribute instance-attribute

reported_by_phone: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByPhone'})

Reported by phone.

room_space_closed_id class-attribute instance-attribute

room_space_closed_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceClosedID'})

Pointer to the room space closed record.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_space_maintenance_category_id class-attribute instance-attribute

room_space_maintenance_category_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})

Pointer to the room space maintenance category record.

room_space_maintenance_id class-attribute instance-attribute

room_space_maintenance_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceID'})

Unique ID for this room space maintenance record.

room_space_maintenance_item_id class-attribute instance-attribute

room_space_maintenance_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})

Pointer to the room space maintenance item record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'StartDate'})

Start date.

status class-attribute instance-attribute

status: Optional[str] = field(default=None, metadata={'wire_name': 'Status'})

Status.

technician class-attribute instance-attribute

technician: Optional[str] = field(default=None, metadata={'wire_name': 'Technician'})

Technician.

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

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

UpdateRoomSpaceMaintenanceResponse dataclass

UpdateRoomSpaceMaintenanceResponse(account_code: Optional[str] = None, cause: Optional[str] = None, charge: Optional[bool] = None, charge_entry_id: Optional[int] = None, charge_amount: Optional[float] = None, charge_invoiced: Optional[bool] = None, charge_invoice_number: Optional[str] = None, charge_type: Optional[str] = None, complete_date: Optional[str] = None, contact_id: Optional[int] = None, contract_date: Optional[str] = None, contractor_cost: Optional[float] = None, contractor_cost_estimate: Optional[float] = None, contractor_date: Optional[str] = None, contractor_e_t_a: Optional[str] = None, contractor_order_number: Optional[str] = None, created_by_security_user_id: Optional[int] = None, custom_bit1: Optional[bool] = None, custom_bit2: Optional[bool] = None, custom_date1: Optional[str] = None, custom_date2: Optional[str] = None, custom_string1: Optional[str] = None, custom_string2: Optional[str] = None, custom_string3: Optional[str] = None, custom_string4: Optional[str] = None, custom_string5: Optional[str] = None, custom_string6: Optional[str] = None, date_created: Optional[str] = None, date_due: Optional[str] = None, date_modified: Optional[str] = None, date_reported: Optional[str] = None, description: Optional[str] = None, job_sent: Optional[bool] = None, job_status: Optional[str] = None, location: Optional[str] = None, occupant_entry_id: Optional[int] = None, occupant_entry_name: Optional[str] = None, occupant_present: Optional[bool] = None, occupant_present_reason: Optional[str] = None, other_service_number: Optional[str] = None, priority_id: Optional[int] = None, repair_description: Optional[str] = None, reported_by_name: Optional[str] = None, reported_by_phone: Optional[str] = None, room_space_closed_id: Optional[int] = None, room_space_id: Optional[int] = None, room_space_maintenance_category_id: Optional[int] = None, room_space_maintenance_id: Optional[int] = None, room_space_maintenance_item_id: Optional[int] = None, security_user_id: Optional[int] = None, start_date: Optional[str] = None, status: Optional[str] = None, technician: Optional[str] = None, view_on_web: Optional[bool] = None)

Response for Update Room Space Maintenance

Attributes

account_code class-attribute instance-attribute

account_code: Optional[str] = field(default=None, metadata={'wire_name': 'AccountCode'})

Account code.

cause class-attribute instance-attribute

cause: Optional[str] = field(default=None, metadata={'wire_name': 'Cause'})

Cause.

charge class-attribute instance-attribute

charge: Optional[bool] = field(default=None, metadata={'wire_name': 'Charge'})

Indicates if a charge should be applied.

charge_entry_id class-attribute instance-attribute

charge_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Charge_EntryID'})

Pointer to the charge entry record.

charge_amount class-attribute instance-attribute

charge_amount: Optional[float] = field(default=None, metadata={'wire_name': 'ChargeAmount'})

Charge amount.

charge_invoiced class-attribute instance-attribute

charge_invoiced: Optional[bool] = field(default=None, metadata={'wire_name': 'ChargeInvoiced'})

Indicates if the charge has been invoiced.

charge_invoice_number class-attribute instance-attribute

charge_invoice_number: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeInvoiceNumber'})

Charge invoice number.

charge_type class-attribute instance-attribute

charge_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChargeType'})

Charge type.

complete_date class-attribute instance-attribute

complete_date: Optional[str] = field(default=None, metadata={'wire_name': 'CompleteDate'})

Complete date.

contact_id class-attribute instance-attribute

contact_id: Optional[int] = field(default=None, metadata={'wire_name': 'ContactID'})

Pointer to the contact record.

contract_date class-attribute instance-attribute

contract_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractDate'})

Contract date.

contractor_cost class-attribute instance-attribute

contractor_cost: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCost'})

Contractor cost.

contractor_cost_estimate class-attribute instance-attribute

contractor_cost_estimate: Optional[float] = field(default=None, metadata={'wire_name': 'ContractorCostEstimate'})

Contractor cost estimate.

contractor_date class-attribute instance-attribute

contractor_date: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorDate'})

Contractor date.

contractor_e_t_a class-attribute instance-attribute

contractor_e_t_a: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorETA'})

Contractor ETA.

contractor_order_number class-attribute instance-attribute

contractor_order_number: Optional[str] = field(default=None, metadata={'wire_name': 'ContractorOrderNumber'})

Contractor order number.

created_by_security_user_id class-attribute instance-attribute

created_by_security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'CreatedBy_SecurityUserID'})

Pointer to the security user record.

custom_bit1 class-attribute instance-attribute

custom_bit1: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit1'})

Custom bit 1.

custom_bit2 class-attribute instance-attribute

custom_bit2: Optional[bool] = field(default=None, metadata={'wire_name': 'CustomBit2'})

Custom bit 2.

custom_date1 class-attribute instance-attribute

custom_date1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate1'})

Custom date 1.

custom_date2 class-attribute instance-attribute

custom_date2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomDate2'})

Custom date 2.

custom_string1 class-attribute instance-attribute

custom_string1: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString1'})

Custom string 1.

custom_string2 class-attribute instance-attribute

custom_string2: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString2'})

Custom string 2.

custom_string3 class-attribute instance-attribute

custom_string3: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString3'})

Custom string 3.

custom_string4 class-attribute instance-attribute

custom_string4: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString4'})

Custom string 4.

custom_string5 class-attribute instance-attribute

custom_string5: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString5'})

Custom string 5.

custom_string6 class-attribute instance-attribute

custom_string6: Optional[str] = field(default=None, metadata={'wire_name': 'CustomString6'})

Custom string 6.

date_created class-attribute instance-attribute

date_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateCreated'})

Date created.

date_due class-attribute instance-attribute

date_due: Optional[str] = field(default=None, metadata={'wire_name': 'DateDue'})

Date due.

date_modified class-attribute instance-attribute

date_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateModified'})

Date modified.

date_reported class-attribute instance-attribute

date_reported: Optional[str] = field(default=None, metadata={'wire_name': 'DateReported'})

Date reported.

description class-attribute instance-attribute

description: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

Description.

job_sent class-attribute instance-attribute

job_sent: Optional[bool] = field(default=None, metadata={'wire_name': 'JobSent'})

Indicates if a job has been sent.

job_status class-attribute instance-attribute

job_status: Optional[str] = field(default=None, metadata={'wire_name': 'JobStatus'})

Job status.

location class-attribute instance-attribute

location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location.

occupant_entry_id class-attribute instance-attribute

occupant_entry_id: Optional[int] = field(default=None, metadata={'wire_name': 'Occupant_EntryID'})

Pointer to the occupant entry record.

occupant_entry_name class-attribute instance-attribute

occupant_entry_name: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantEntryName'})

Occupant entry name.

occupant_present class-attribute instance-attribute

occupant_present: Optional[bool] = field(default=None, metadata={'wire_name': 'OccupantPresent'})

Indicates if an occupant is present.

occupant_present_reason class-attribute instance-attribute

occupant_present_reason: Optional[str] = field(default=None, metadata={'wire_name': 'OccupantPresentReason'})

Occupant present reason.

other_service_number class-attribute instance-attribute

other_service_number: Optional[str] = field(default=None, metadata={'wire_name': 'OtherServiceNumber'})

Other service number.

priority_id class-attribute instance-attribute

priority_id: Optional[int] = field(default=None, metadata={'wire_name': 'PriorityID'})

Pointer to the priority record.

repair_description class-attribute instance-attribute

repair_description: Optional[str] = field(default=None, metadata={'wire_name': 'RepairDescription'})

Repair description.

reported_by_name class-attribute instance-attribute

reported_by_name: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByName'})

Reported by name.

reported_by_phone class-attribute instance-attribute

reported_by_phone: Optional[str] = field(default=None, metadata={'wire_name': 'ReportedByPhone'})

Reported by phone.

room_space_closed_id class-attribute instance-attribute

room_space_closed_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceClosedID'})

Pointer to the room space closed record.

room_space_id class-attribute instance-attribute

room_space_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceID'})

Pointer to the room space record.

room_space_maintenance_category_id class-attribute instance-attribute

room_space_maintenance_category_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})

Pointer to the room space maintenance category record.

room_space_maintenance_id class-attribute instance-attribute

room_space_maintenance_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceID'})

Unique ID for this room space maintenance record.

room_space_maintenance_item_id class-attribute instance-attribute

room_space_maintenance_item_id: Optional[int] = field(default=None, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})

Pointer to the room space maintenance item record.

security_user_id class-attribute instance-attribute

security_user_id: Optional[int] = field(default=None, metadata={'wire_name': 'SecurityUserID'})

Pointer to the security user record.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'StartDate'})

Start date.

status class-attribute instance-attribute

status: Optional[str] = field(default=None, metadata={'wire_name': 'Status'})

Status.

technician class-attribute instance-attribute

technician: Optional[str] = field(default=None, metadata={'wire_name': 'Technician'})

Technician.

view_on_web class-attribute instance-attribute

view_on_web: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewOnWeb'})

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

Starrezrestv1Client

Starrezrestv1Client(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for starrezrestv1 connector.

Initialize a Starrezrestv1Client.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

select_entry_async async

select_entry_async(input: SelectEntryInput) -> dict[str, Any] | None

Get Entry

Retrieves one or more records from the Entry table.

create_entry_async async

create_entry_async(input: CreateEntryInput) -> dict[str, Any] | None

Create Entry

Creates a new record in the Entry table.

update_entry_async async

update_entry_async(input: UpdateEntryInput, entry_id: int) -> dict[str, Any] | None

Update Entry

Updates an existing record in the Entry table.

delete_async async

delete_async(table_name: str, row_id: int) -> dict[str, Any] | None

Delete

Deletes a record from the specified table.

select_entry_custom_field_async async

select_entry_custom_field_async(input: SelectEntryCustomFieldInput) -> dict[str, Any] | None

Get Entry Custom Field

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

update_entry_custom_field_async async

update_entry_custom_field_async(input: UpdateEntryCustomFieldInput, entry_custom_field_id: int) -> dict[str, Any] | None

Update Entry Custom Field

Updates an existing record in the Entry Custom Field table.

select_term_async async

select_term_async(input: SelectTermInput) -> dict[str, Any] | None

Get Term

Retrieves one or more records from the Term table.

select_entry_address_async async

select_entry_address_async(input: SelectEntryAddressInput) -> dict[str, Any] | None

Get Entry Address

Retrieves one or more records from the Entry Address table.

update_entry_address_async async

update_entry_address_async(input: UpdateEntryAddressInput, entry_address_id: int) -> dict[str, Any] | None

Update Entry Address

Updates an existing record in the Entry Address table.

select_entry_application_async async

select_entry_application_async(input: SelectEntryApplicationInput) -> dict[str, Any] | None

Get Entry Application

Retrieves one or more records from the Entry Application table.

create_entry_application_async async

create_entry_application_async(input: CreateEntryApplicationInput) -> dict[str, Any] | None

Create Entry Application

Creates a new record in the Entry Application table.

update_entry_application_async async

update_entry_application_async(input: UpdateEntryApplicationInput, entry_application_id: int) -> dict[str, Any] | None

Update Entry Application

Updates an existing record in the Entry Application table.

select_term_session_async async

select_term_session_async(input: SelectTermSessionInput) -> dict[str, Any] | None

Get Term Session

Retrieves one or more records from the Term Session table.

select_entry_detail_async async

select_entry_detail_async(input: SelectEntryDetailInput) -> dict[str, Any] | None

Get Entry Detail

Retrieves one or more records from the Entry Detail table.

update_entry_detail_async async

update_entry_detail_async(input: UpdateEntryDetailInput, entry_detail_id: int) -> dict[str, Any] | None

Update Entry Detail

Updates an existing record in the Entry Detail table.

select_entry_enrollment_async async

select_entry_enrollment_async(input: SelectEntryEnrollmentInput) -> dict[str, Any] | None

Get Entry Enrollment

Retrieves one or more records from the Entry Enrollment table.

create_entry_enrollment_async async

create_entry_enrollment_async(input: CreateEntryEnrollmentInput) -> dict[str, Any] | None

Create Entry Enrollment

Creates a new record in the Entry Enrollment table.

update_entry_enrollment_async async

update_entry_enrollment_async(input: UpdateEntryEnrollmentInput, entry_enrollment_id: int) -> dict[str, Any] | None

Update Entry Enrollment

Updates an existing record in the Entry Enrollment table.

select_booking_async async

select_booking_async(input: SelectBookingInput) -> dict[str, Any] | None

Get Booking

Retrieves one or more records from the Booking table.

create_booking_async async

create_booking_async(input: CreateBookingInput) -> dict[str, Any] | None

Create Booking

Creates a new record in the Booking table.

update_booking_async async

update_booking_async(input: UpdateBookingInput, booking_id: int) -> dict[str, Any] | None

Update Booking

Updates an existing record in the Booking table.

select_room_space_async async

select_room_space_async(input: SelectRoomSpaceInput) -> dict[str, Any] | None

Get Room Space

Retrieves one or more records from the Room Space table.

create_room_space_async async

create_room_space_async(input: CreateRoomSpaceInput) -> dict[str, Any] | None

Create Room Space

Creates a new record in the Room Space table.

select_room_location_async async

select_room_location_async(input: SelectRoomLocationInput) -> dict[str, Any] | None

Get Room Location

Retrieves one or more records from the Room Location table.

select_transaction_async async

select_transaction_async(input: SelectTransactionInput) -> dict[str, Any] | None

Get Transaction

Retrieves one or more records from the Transaction table.

create_transaction_async async

create_transaction_async(input: CreateTransactionInput) -> dict[str, Any] | None

Create Transaction

Creates a new record in the Transaction table.

select_room_space_maintenance_async async

select_room_space_maintenance_async(input: SelectRoomSpaceMaintenanceInput) -> dict[str, Any] | None

Get Room Space Maintenance

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

create_room_space_maintenance_async async

create_room_space_maintenance_async(input: CreateRoomSpaceMaintenanceInput) -> dict[str, Any] | None

Create Room Space Maintenance

Creates a new record in the Room Space Maintenance table.

update_room_space_maintenance_async async

update_room_space_maintenance_async(input: UpdateRoomSpaceMaintenanceInput, room_space_maintenance_id: int) -> dict[str, Any] | None

Update Room Space Maintenance

Updates an existing record in the Room Space Maintenance table.