Starrezrestv1Client
Classes
dataclass
SelectEntryInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Address type of the entry's active address record.
class-attribute
instance-attribute
birth_gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Birth_GenderEnum'})
The gender of the entry at birth.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Pointer to the active booking record.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
The category that the entry belongs to.
class-attribute
instance-attribute
conference_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConferenceEmail'})
The email that is used to identify a student through Conference registration.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
created_by_security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedBy_SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
directory_flag_privacy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryFlagPrivacy'})
Determines if the entry has elected to remain private.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Pointer to the active application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Unique ID for this Entry field.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the entry.
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventID'})
Pointer to the event record.
class-attribute
instance-attribute
gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderEnum'})
Entry gender.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
name_first: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameFirst'})
The first or given name of the entry.
class-attribute
instance-attribute
name_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameInitials'})
Name initials.
class-attribute
instance-attribute
name_last: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameLast'})
The surname, family name or last name of the entry.
class-attribute
instance-attribute
name_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameOther'})
Alternative name.
class-attribute
instance-attribute
name_preferred: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NamePreferred'})
Preferred name.
class-attribute
instance-attribute
name_sharer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameSharer'})
Additional occupant name.
class-attribute
instance-attribute
name_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameTitle'})
The title or salutation of the entry.
class-attribute
instance-attribute
name_web: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameWeb'})
A name to display for this entry on the Web.
class-attribute
instance-attribute
pin_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PinNumber'})
Personal Identification Number.
class-attribute
instance-attribute
portal_auth_provider_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalAuthProviderUserID'})
User identification used to identify the entry in PortalX. This could be an email, username or other identifier.
class-attribute
instance-attribute
portal_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalEmail'})
The email that is used by the student to login to the portal.
class-attribute
instance-attribute
position: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Position'})
Entry position in the institution.
class-attribute
instance-attribute
previous_entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Previous_EntryStatusEnum'})
The previous entry status.
dataclass
CreateEntryInput(name_first: str, name_last: str, *, 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_initials: 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
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Address type of the entry's active address record.
class-attribute
instance-attribute
birth_gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Birth_GenderEnum'})
The gender of the entry at birth.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Pointer to the active booking record.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
The category that the entry belongs to.
class-attribute
instance-attribute
conference_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConferenceEmail'})
The email that is used to identify a student through Conference registration.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
directory_flag_privacy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryFlagPrivacy'})
Determines if the entry has elected to remain private.
class-attribute
instance-attribute
Date of birth.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Pointer to the active application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Unique ID for this Entry field.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the entry.
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventID'})
Pointer to the event record.
class-attribute
instance-attribute
gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderEnum'})
Entry gender.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
last_check_in_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastCheckInOutDate'})
The last date a check-in or check-out was performed.
class-attribute
instance-attribute
The first or given name of the entry.
class-attribute
instance-attribute
name_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameInitials'})
Name initials.
class-attribute
instance-attribute
The surname, family name or last name of the entry.
class-attribute
instance-attribute
name_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameOther'})
Alternative name.
class-attribute
instance-attribute
name_preferred: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NamePreferred'})
Preferred name.
class-attribute
instance-attribute
name_sharer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameSharer'})
Additional occupant name.
class-attribute
instance-attribute
name_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameTitle'})
The title or salutation of the entry.
class-attribute
instance-attribute
name_web: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameWeb'})
A name to display for this entry on the Web.
class-attribute
instance-attribute
password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Password'})
Password
class-attribute
instance-attribute
pin_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PinNumber'})
Personal Identification Number.
class-attribute
instance-attribute
portal_auth_provider_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalAuthProviderUserID'})
User identification used to identify the entry in PortalX. This could be an email, username or other identifier.
class-attribute
instance-attribute
portal_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalEmail'})
The email that is used by the student to login to the portal.
class-attribute
instance-attribute
position: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Position'})
Entry position in the institution.
class-attribute
instance-attribute
previous_entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Previous_EntryStatusEnum'})
The previous entry status.
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
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Address type of the entry's active address record.
class-attribute
instance-attribute
birth_gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Birth_GenderEnum'})
The gender of the entry at birth.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Pointer to the active booking record.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
The category that the entry belongs to.
class-attribute
instance-attribute
conference_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConferenceEmail'})
The email that is used to identify a student through Conference registration.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
directory_flag_privacy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryFlagPrivacy'})
Determines if the entry has elected to remain private.
class-attribute
instance-attribute
Date of birth.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Pointer to the active application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Unique ID for this Entry field.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the entry.
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventID'})
Pointer to the event record.
class-attribute
instance-attribute
gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderEnum'})
Entry gender.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
last_check_in_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastCheckInOutDate'})
The last date a check-in or check-out was performed.
class-attribute
instance-attribute
name_first: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameFirst'})
The first or given name of the entry.
class-attribute
instance-attribute
name_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameInitials'})
Initials in name.
class-attribute
instance-attribute
name_last: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameLast'})
The surname, family name or last name of the entry.
class-attribute
instance-attribute
name_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameOther'})
Alternative name.
class-attribute
instance-attribute
name_preferred: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NamePreferred'})
Preferred name.
class-attribute
instance-attribute
name_sharer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameSharer'})
Additional occupant name.
class-attribute
instance-attribute
name_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameTitle'})
The title or salutation of the entry.
class-attribute
instance-attribute
name_web: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameWeb'})
A name to display for this entry on the Web.
class-attribute
instance-attribute
password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Password'})
Password
class-attribute
instance-attribute
pin_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PinNumber'})
Personal Identification Number.
class-attribute
instance-attribute
portal_auth_provider_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalAuthProviderUserID'})
User identification used to identify the entry in PortalX. This could be an email, username or other identifier.
class-attribute
instance-attribute
portal_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalEmail'})
Portal email.
class-attribute
instance-attribute
position: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Position'})
Entry position in the institution.
class-attribute
instance-attribute
previous_entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Previous_EntryStatusEnum'})
The previous entry status.
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
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Address type of the entry's active address record.
class-attribute
instance-attribute
birth_gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Birth_GenderEnum'})
The gender of the entry at birth.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Pointer to the active booking record.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
The category that the entry belongs to.
class-attribute
instance-attribute
conference_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConferenceEmail'})
The email that is used to identify a student through Conference registration.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
directory_flag_privacy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryFlagPrivacy'})
Determines if the entry has elected to remain private.
class-attribute
instance-attribute
Date of birth.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Pointer to the active application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Unique ID for this Entry field.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the entry.
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventID'})
Pointer to the event record.
class-attribute
instance-attribute
gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderEnum'})
Entry gender.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
last_check_in_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastCheckInOutDate'})
The last date a check-in or check-out was performed.
class-attribute
instance-attribute
name_first: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameFirst'})
The first or given name of the entry.
class-attribute
instance-attribute
name_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameInitials'})
Name initials.
class-attribute
instance-attribute
name_last: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameLast'})
The surname, family name or last name of the entry.
class-attribute
instance-attribute
name_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameOther'})
Alternative name.
class-attribute
instance-attribute
name_preferred: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NamePreferred'})
Preferred name.
class-attribute
instance-attribute
name_sharer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameSharer'})
Additional occupant name.
class-attribute
instance-attribute
name_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameTitle'})
The title or salutation of the entry.
class-attribute
instance-attribute
name_web: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameWeb'})
A name to display for this entry on the Web.
class-attribute
instance-attribute
password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Password'})
Password
class-attribute
instance-attribute
pin_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PinNumber'})
Personal Identification Number.
class-attribute
instance-attribute
portal_auth_provider_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalAuthProviderUserID'})
User identification used to identify the entry in PortalX. This could be an email, username or other identifier.
class-attribute
instance-attribute
portal_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalEmail'})
The email that is used by the student to login to the portal.
class-attribute
instance-attribute
position: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Position'})
Entry position in the institution.
class-attribute
instance-attribute
previous_entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Previous_EntryStatusEnum'})
The previous entry status.
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
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Pointer to this entry's active address record.
class-attribute
instance-attribute
birth_gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Birth_GenderEnum'})
The gender of the entry at birth.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Pointer to the active booking record.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
The category that the entry belongs to.
class-attribute
instance-attribute
conference_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConferenceEmail'})
The email that is used to identify a student through Conference registration.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
directory_flag_privacy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryFlagPrivacy'})
Determines if the entry has elected to remain private.
class-attribute
instance-attribute
Date of birth.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Pointer to the active application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Unique ID for this Entry field.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the entry.
class-attribute
instance-attribute
event_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventID'})
Pointer to the event record.
class-attribute
instance-attribute
gender_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderEnum'})
Entry gender.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
Generic ID field.
class-attribute
instance-attribute
last_check_in_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastCheckInOutDate'})
The last date a check-in or check-out was performed.
class-attribute
instance-attribute
name_first: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameFirst'})
The first or given name of the entry.
class-attribute
instance-attribute
name_initials: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameInitials'})
Name initials.
class-attribute
instance-attribute
name_last: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameLast'})
The surname, family name or last name of the entry.
class-attribute
instance-attribute
name_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameOther'})
Alternative name.
class-attribute
instance-attribute
name_preferred: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NamePreferred'})
Preferred name.
class-attribute
instance-attribute
name_sharer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameSharer'})
Additional occupant name.
class-attribute
instance-attribute
name_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameTitle'})
The title or salutation of the entry.
class-attribute
instance-attribute
name_web: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NameWeb'})
A name to display for this entry on the Web.
class-attribute
instance-attribute
password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Password'})
Password
class-attribute
instance-attribute
pin_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PinNumber'})
Personal Identification Number.
class-attribute
instance-attribute
portal_auth_provider_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalAuthProviderUserID'})
User identification used to identify the entry in PortalX. This could be an email, username or other identifier.
class-attribute
instance-attribute
portal_email: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalEmail'})
The email that is used by the student to login to the portal.
class-attribute
instance-attribute
position: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Position'})
Entry position in the institution.
class-attribute
instance-attribute
previous_entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Previous_EntryStatusEnum'})
The previous entry status.
dataclass
dataclass
SelectEntryCustomFieldInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
custom_field_definition_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomFieldDefinitionID'})
Pointer to the custom field definition record.
class-attribute
instance-attribute
entry_custom_field_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryCustomFieldID'})
Unique ID for this entry custom field record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
field_data_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldDataTypeEnum'})
Field data type.
class-attribute
instance-attribute
value_boolean: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueBoolean'})
Boolean value.
class-attribute
instance-attribute
value_integer: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueInteger'})
Integer value.
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
class-attribute
instance-attribute
custom_field_definition_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomFieldDefinitionID'})
Pointer to the custom field definition record.
class-attribute
instance-attribute
entry_custom_field_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryCustomFieldID'})
Unique ID for this entry custom field record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
field_data_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldDataTypeEnum'})
Field data type.
class-attribute
instance-attribute
value_boolean: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueBoolean'})
Boolean value.
class-attribute
instance-attribute
value_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueDate'})
Date value.
class-attribute
instance-attribute
value_integer: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueInteger'})
Integer value.
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
class-attribute
instance-attribute
custom_field_definition_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomFieldDefinitionID'})
Pointer to the custom field definition record.
class-attribute
instance-attribute
entry_custom_field_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryCustomFieldID'})
Unique ID for this entry custom field record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
field_data_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldDataTypeEnum'})
Field data type.
class-attribute
instance-attribute
value_boolean: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueBoolean'})
Boolean value.
class-attribute
instance-attribute
value_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueDate'})
Date value.
class-attribute
instance-attribute
value_integer: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ValueInteger'})
Integer value.
dataclass
SelectTermInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
active: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Active'})
Current active state.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
Pointer to the category record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Term comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Term description.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
term_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermCode'})
Term code.
class-attribute
instance-attribute
term_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermID'})
Unique ID for this term record.
dataclass
SelectEntryAddressInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Pointer to the address type record.
class-attribute
instance-attribute
City
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Address comments.
class-attribute
instance-attribute
contact_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName'})
Contact name.
class-attribute
instance-attribute
contact_name2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName2'})
Contact name 2.
class-attribute
instance-attribute
country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryID'})
Pointer to the country record.
class-attribute
instance-attribute
class-attribute
instance-attribute
entry_address_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryAddressID'})
Unique ID for this entry address record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
Phone
class-attribute
instance-attribute
phone_mobile_cell: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneMobileCell'})
Mobile/Cell
class-attribute
instance-attribute
phone_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther'})
Alternative phone.
class-attribute
instance-attribute
phone_other2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther2'})
Alternative phone 2.
class-attribute
instance-attribute
reference: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference'})
Reference
class-attribute
instance-attribute
relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Relationship'})
Relationship this address has to the entry.
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Salutation'})
Salutation
class-attribute
instance-attribute
state_province: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StateProvince'})
State/Province
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
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
class-attribute
instance-attribute
active_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActiveDateEnd'})
End active date.
class-attribute
instance-attribute
active_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActiveDateStart'})
Date when this address becomes active.
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Pointer to the address type record.
class-attribute
instance-attribute
City
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Address comments.
class-attribute
instance-attribute
contact_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName'})
Contact name.
class-attribute
instance-attribute
contact_name2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName2'})
Contact name 2.
class-attribute
instance-attribute
country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryID'})
Pointer to the country record.
class-attribute
instance-attribute
class-attribute
instance-attribute
entry_address_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryAddressID'})
Unique ID for this entry address record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
Phone
class-attribute
instance-attribute
phone_mobile_cell: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneMobileCell'})
Mobile/Cell
class-attribute
instance-attribute
phone_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther'})
Alternative phone.
class-attribute
instance-attribute
phone_other2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther2'})
Alternative phone 2.
class-attribute
instance-attribute
reference: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference'})
Reference
class-attribute
instance-attribute
relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Relationship'})
Relationship this address has to the entry.
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Salutation'})
Salutation
class-attribute
instance-attribute
state_province: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StateProvince'})
State/Province
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
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
class-attribute
instance-attribute
active_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActiveDateEnd'})
End active date.
class-attribute
instance-attribute
active_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActiveDateStart'})
Date when this address becomes active.
class-attribute
instance-attribute
address_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AddressTypeID'})
Pointer to the address type record.
class-attribute
instance-attribute
City
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Address comments.
class-attribute
instance-attribute
contact_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName'})
Contact name.
class-attribute
instance-attribute
contact_name2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactName2'})
Contact name 2.
class-attribute
instance-attribute
country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryID'})
Pointer to the country record.
class-attribute
instance-attribute
class-attribute
instance-attribute
entry_address_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryAddressID'})
Unique ID for this entry address record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
Phone
class-attribute
instance-attribute
phone_mobile_cell: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneMobileCell'})
Mobile/Cell
class-attribute
instance-attribute
phone_other: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther'})
Alternative phone.
class-attribute
instance-attribute
phone_other2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhoneOther2'})
Alternative phone 2.
class-attribute
instance-attribute
reference: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference'})
Reference
class-attribute
instance-attribute
relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Relationship'})
Relationship this address has to the entry.
class-attribute
instance-attribute
salutation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Salutation'})
Salutation
class-attribute
instance-attribute
state_province: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StateProvince'})
State/Province
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
dataclass
SelectEntryApplicationInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
allocate_option_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateOptionEnum'})
Allocate option.
class-attribute
instance-attribute
application_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationStatusID'})
Pointer to the application status record.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Application comments.
class-attribute
instance-attribute
comments_internal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentsInternal'})
Internal comments.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Unique ID for this entry application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
offer_reply_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyEnum'})
Offer reply.
class-attribute
instance-attribute
offer_reply_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyReason'})
Offer reply reason.
class-attribute
instance-attribute
portal_tracking_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalTrackingOnly'})
Whether this application is just for the portal to track progress.
class-attribute
instance-attribute
preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreferenceComments'})
Preference comments.
class-attribute
instance-attribute
rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rating'})
Application rating.
class-attribute
instance-attribute
received_deposit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit'})
Indicates if the deposit has been received.
class-attribute
instance-attribute
received_deposit_waived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositWaived'})
Date deposit was waived.
class-attribute
instance-attribute
received_deposit_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_deposit_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_deposit_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositAmount'})
Received deposit amount.
class-attribute
instance-attribute
received_fee: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee'})
Indicates if the fee has been received.
class-attribute
instance-attribute
received_fee_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_fee_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_fee_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeAmount'})
Received fee amount.
class-attribute
instance-attribute
returning: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Returning'})
Indicates if the entry has been here before and is returning.
class-attribute
instance-attribute
room_mate_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateDescription'})
Description the applicant can write which is displayed in the roommate module.
class-attribute
instance-attribute
roommate_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoommateGroupID'})
Pointer to the Roommate group record.
class-attribute
instance-attribute
room_mate_group_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateGroupSortOrder'})
Order that group members should be processed in.
class-attribute
instance-attribute
room_mate_show_in_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateShowInSearch'})
Whether to include this applicant in roommate searches.
class-attribute
instance-attribute
room_preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomPreferenceComments'})
Room preference comments.
class-attribute
instance-attribute
room_selection_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionNumber'})
Room selection number.
class-attribute
instance-attribute
room_selection_timeslot: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionTimeslot'})
Room selection timeslot.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
dataclass
CreateEntryApplicationInput(entry_id: int, *, 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, 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
class-attribute
instance-attribute
allocate_option_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateOptionEnum'})
Allocate option.
class-attribute
instance-attribute
application_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationDate'})
Date of application.
class-attribute
instance-attribute
application_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationStatusID'})
Pointer to the application status record.
class-attribute
instance-attribute
cancel_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelDate'})
Cancellation date.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Application comments.
class-attribute
instance-attribute
comments_internal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentsInternal'})
Internal comments.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Completion date.
class-attribute
instance-attribute
contract_signed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractSignedDate'})
Date contract was signed.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
enquiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnquiryDate'})
Date of enquiry.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Unique ID for this entry application record.
class-attribute
instance-attribute
Pointer to the entry record.
class-attribute
instance-attribute
expected_arrival_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDate'})
Date entry is expected to arrive.
class-attribute
instance-attribute
expected_arrival_date_latest: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDateLatest'})
Latest expected arrival date.
class-attribute
instance-attribute
expected_departure_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedDepartureDate'})
Date entry is expected to depart.
class-attribute
instance-attribute
offered_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferedDate'})
Date application was offered.
class-attribute
instance-attribute
offer_reply_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyDate'})
Date offer was replied to.
class-attribute
instance-attribute
offer_reply_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyEnum'})
Offer reply.
class-attribute
instance-attribute
offer_reply_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyReason'})
Offer reply reason.
class-attribute
instance-attribute
offer_sent_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferSentDate'})
Date offer sent.
class-attribute
instance-attribute
portal_tracking_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalTrackingOnly'})
Whether this application is just for the portal to track progress.
class-attribute
instance-attribute
preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreferenceComments'})
Preference comments.
class-attribute
instance-attribute
rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rating'})
Application rating.
class-attribute
instance-attribute
received_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDate'})
Date received.
class-attribute
instance-attribute
received_deposit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit'})
Indicates if the deposit has been received.
class-attribute
instance-attribute
received_deposit_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})
Pointer to the payment record for the received deposit.
class-attribute
instance-attribute
received_deposit_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})
Most recent deposit payment that was attempted.
class-attribute
instance-attribute
received_deposit_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositAmount'})
Received deposit amount.
class-attribute
instance-attribute
received_deposit_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositDate'})
Date deposit was received.
class-attribute
instance-attribute
received_deposit_waived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositWaived'})
Date deposit was waived.
class-attribute
instance-attribute
received_fee: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee'})
Indicates if the fee has been received.
class-attribute
instance-attribute
received_fee_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_fee_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_fee_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeAmount'})
Received fee amount.
class-attribute
instance-attribute
received_fee_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeDate'})
Date fee was received.
class-attribute
instance-attribute
received_photo_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedPhotoDate'})
Date photo was received.
class-attribute
instance-attribute
returning: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Returning'})
Indicates if the entry has been here before and is returning.
class-attribute
instance-attribute
room_mate_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateDescription'})
Description the applicant can write which is displayed in the roommate module.
class-attribute
instance-attribute
roommate_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoommateGroupID'})
Pointer to the Roommate group record.
class-attribute
instance-attribute
room_mate_group_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateGroupSortOrder'})
Order that group members should be processed in.
class-attribute
instance-attribute
room_mate_show_in_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateShowInSearch'})
Whether to include this applicant in roommate searches.
class-attribute
instance-attribute
room_preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomPreferenceComments'})
Room preference comments.
class-attribute
instance-attribute
room_selection_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionNumber'})
Room selection number.
class-attribute
instance-attribute
room_selection_timeslot: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionTimeslot'})
Room selection timeslot.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
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
class-attribute
instance-attribute
allocate_option_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateOptionEnum'})
Allocate option.
class-attribute
instance-attribute
application_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationDate'})
Date of application.
class-attribute
instance-attribute
application_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationStatusID'})
Pointer to the application status record.
class-attribute
instance-attribute
cancel_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelDate'})
Cancellation date.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Application comments.
class-attribute
instance-attribute
comments_internal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentsInternal'})
Internal comments.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Completion date.
class-attribute
instance-attribute
contract_signed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractSignedDate'})
Date contract was signed.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Unique ID for this entry application record.
class-attribute
instance-attribute
enquiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnquiryDate'})
Date of enquiry.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
expected_arrival_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDate'})
Date entry is expected to arrive.
class-attribute
instance-attribute
expected_arrival_date_latest: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDateLatest'})
Latest expected arrival date.
class-attribute
instance-attribute
expected_departure_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedDepartureDate'})
Date entry is expected to depart.
class-attribute
instance-attribute
offered_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferedDate'})
Date application was offered.
class-attribute
instance-attribute
offer_reply_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyDate'})
Date offer was replied to.
class-attribute
instance-attribute
offer_reply_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyEnum'})
Offer reply.
class-attribute
instance-attribute
offer_reply_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyReason'})
Offer reply reason.
class-attribute
instance-attribute
offer_sent_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferSentDate'})
Date offer sent.
class-attribute
instance-attribute
portal_tracking_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalTrackingOnly'})
Whether this application is just for the portal to track progress.
class-attribute
instance-attribute
preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreferenceComments'})
Preference comments.
class-attribute
instance-attribute
rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rating'})
Application rating.
class-attribute
instance-attribute
received_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDate'})
Date received.
class-attribute
instance-attribute
received_deposit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit'})
Indicates if the deposit has been received.
class-attribute
instance-attribute
received_deposit_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})
Pointer to the payment record for the received deposit.
class-attribute
instance-attribute
received_deposit_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})
Most recent deposit payment that was attempted.
class-attribute
instance-attribute
received_deposit_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositAmount'})
Received deposit amount.
class-attribute
instance-attribute
received_deposit_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositDate'})
Date deposit was received.
class-attribute
instance-attribute
received_deposit_waived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositWaived'})
Date deposit was waived.
class-attribute
instance-attribute
received_fee: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee'})
Indicates if the fee has been received.
class-attribute
instance-attribute
received_fee_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_fee_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_fee_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeAmount'})
Received fee amount.
class-attribute
instance-attribute
received_fee_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeDate'})
Date fee was received.
class-attribute
instance-attribute
received_photo_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedPhotoDate'})
Date photo was received.
class-attribute
instance-attribute
returning: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Returning'})
Indicates if the entry has been here before and is returning.
class-attribute
instance-attribute
room_mate_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateDescription'})
Description the applicant can write which is displayed in the roommate module.
class-attribute
instance-attribute
roommate_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoommateGroupID'})
Pointer to the Roommate group record.
class-attribute
instance-attribute
room_mate_group_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateGroupSortOrder'})
Order that group members should be processed in.
class-attribute
instance-attribute
room_mate_show_in_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateShowInSearch'})
Whether to include this applicant in roommate searches.
class-attribute
instance-attribute
room_preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomPreferenceComments'})
Room preference comments.
class-attribute
instance-attribute
room_selection_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionNumber'})
Room selection number.
class-attribute
instance-attribute
room_selection_timeslot: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionTimeslot'})
Room selection timeslot.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
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
class-attribute
instance-attribute
allocate_option_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateOptionEnum'})
Allocate option.
class-attribute
instance-attribute
application_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationDate'})
Date of application.
class-attribute
instance-attribute
application_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationStatusID'})
Pointer to the application status record.
class-attribute
instance-attribute
cancel_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelDate'})
Cancellation date.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Application comments.
class-attribute
instance-attribute
comments_internal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentsInternal'})
Internal comments.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Completion date.
class-attribute
instance-attribute
contract_signed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractSignedDate'})
Date contract was signed.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Unique ID for this entry application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
enquiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnquiryDate'})
Date of enquiry.
class-attribute
instance-attribute
expected_arrival_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDate'})
Date entry is expected to arrive.
class-attribute
instance-attribute
expected_arrival_date_latest: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDateLatest'})
Latest expected arrival date.
class-attribute
instance-attribute
expected_departure_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedDepartureDate'})
Date entry is expected to depart.
class-attribute
instance-attribute
offered_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferedDate'})
Date application was offered.
class-attribute
instance-attribute
offer_reply_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyDate'})
Date offer was replied to.
class-attribute
instance-attribute
offer_reply_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyEnum'})
Offer reply.
class-attribute
instance-attribute
offer_reply_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyReason'})
Offer reply reason.
class-attribute
instance-attribute
offer_sent_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferSentDate'})
Date offer sent.
class-attribute
instance-attribute
portal_tracking_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalTrackingOnly'})
Whether this application is just for the portal to track progress.
class-attribute
instance-attribute
preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreferenceComments'})
Preference comments.
class-attribute
instance-attribute
rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rating'})
Application rating.
class-attribute
instance-attribute
received_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDate'})
Date received.
class-attribute
instance-attribute
received_deposit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit'})
Indicates if the deposit has been received.
class-attribute
instance-attribute
received_deposit_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})
Pointer to the payment record for the received deposit.
class-attribute
instance-attribute
received_deposit_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})
Most recent deposit payment that was attempted.
class-attribute
instance-attribute
received_deposit_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositAmount'})
Received deposit amount.
class-attribute
instance-attribute
received_deposit_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositDate'})
Date deposit was received.
class-attribute
instance-attribute
received_deposit_waived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositWaived'})
Date deposit was waived.
class-attribute
instance-attribute
received_fee: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee'})
Indicates if the fee has been received.
class-attribute
instance-attribute
received_fee_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_fee_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_fee_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeAmount'})
Received fee amount.
class-attribute
instance-attribute
received_fee_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeDate'})
Date fee was received.
class-attribute
instance-attribute
received_photo_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedPhotoDate'})
Date photo was received.
class-attribute
instance-attribute
returning: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Returning'})
Indicates if the entry has been here before and is returning.
class-attribute
instance-attribute
room_mate_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateDescription'})
Description the applicant can write which is displayed in the roommate module.
class-attribute
instance-attribute
roommate_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoommateGroupID'})
Pointer to the Roommate group record.
class-attribute
instance-attribute
room_mate_group_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateGroupSortOrder'})
Order that group members should be processed in.
class-attribute
instance-attribute
room_mate_show_in_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateShowInSearch'})
Whether to include this applicant in roommate searches.
class-attribute
instance-attribute
room_preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomPreferenceComments'})
Room preference comments.
class-attribute
instance-attribute
room_selection_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionNumber'})
Room selection number.
class-attribute
instance-attribute
room_selection_timeslot: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionTimeslot'})
Room selection timeslot.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
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
class-attribute
instance-attribute
allocate_option_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateOptionEnum'})
Allocate option.
class-attribute
instance-attribute
application_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationDate'})
Date of application.
class-attribute
instance-attribute
application_status_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApplicationStatusID'})
Pointer to the application status record.
class-attribute
instance-attribute
cancel_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelDate'})
Cancellation date.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Application comments.
class-attribute
instance-attribute
comments_internal: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CommentsInternal'})
Internal comments.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Completion date.
class-attribute
instance-attribute
contract_signed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractSignedDate'})
Date contract was signed.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
entry_application_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryApplicationID'})
Unique ID for this entry application record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
enquiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnquiryDate'})
Date of enquiry.
class-attribute
instance-attribute
expected_arrival_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDate'})
Date entry is expected to arrive.
class-attribute
instance-attribute
expected_arrival_date_latest: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedArrivalDateLatest'})
Latest expected arrival date.
class-attribute
instance-attribute
expected_departure_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedDepartureDate'})
Date entry is expected to depart.
class-attribute
instance-attribute
offered_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferedDate'})
Date application was offered.
class-attribute
instance-attribute
offer_reply_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyDate'})
Date offer was replied to.
class-attribute
instance-attribute
offer_reply_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyEnum'})
Offer reply.
class-attribute
instance-attribute
offer_reply_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferReplyReason'})
Offer reply reason.
class-attribute
instance-attribute
offer_sent_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfferSentDate'})
Date offer sent.
class-attribute
instance-attribute
portal_tracking_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PortalTrackingOnly'})
Whether this application is just for the portal to track progress.
class-attribute
instance-attribute
preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreferenceComments'})
Preference comments.
class-attribute
instance-attribute
rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rating'})
Application rating.
class-attribute
instance-attribute
received_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDate'})
Date received.
class-attribute
instance-attribute
received_deposit: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit'})
Indicates if the deposit has been received.
class-attribute
instance-attribute
received_deposit_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_PaymentID'})
Pointer to the payment record for the received deposit.
class-attribute
instance-attribute
received_deposit_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDeposit_WebPaymentID'})
Most recent deposit payment that was attempted.
class-attribute
instance-attribute
received_deposit_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositAmount'})
Received deposit amount.
class-attribute
instance-attribute
received_deposit_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositDate'})
Date deposit was received.
class-attribute
instance-attribute
received_deposit_waived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDepositWaived'})
Date deposit was waived.
class-attribute
instance-attribute
received_fee: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee'})
Indicates if the fee has been received.
class-attribute
instance-attribute
received_fee_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_PaymentID'})
Pointer to the payment record for the received fee.
class-attribute
instance-attribute
received_fee_web_payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFee_WebPaymentID'})
Most recent fee payment that was attempted.
class-attribute
instance-attribute
received_fee_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeAmount'})
Received fee amount.
class-attribute
instance-attribute
received_fee_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedFeeDate'})
Date fee was received.
class-attribute
instance-attribute
received_photo_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedPhotoDate'})
Date photo was received.
class-attribute
instance-attribute
returning: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Returning'})
Indicates if the entry has been here before and is returning.
class-attribute
instance-attribute
room_mate_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateDescription'})
Description the applicant can write which is displayed in the roommate module.
class-attribute
instance-attribute
roommate_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoommateGroupID'})
Pointer to the Roommate group record.
class-attribute
instance-attribute
room_mate_group_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateGroupSortOrder'})
Order that group members should be processed in.
class-attribute
instance-attribute
room_mate_show_in_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomMateShowInSearch'})
Whether to include this applicant in roommate searches.
class-attribute
instance-attribute
room_preference_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomPreferenceComments'})
Room preference comments.
class-attribute
instance-attribute
room_selection_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionNumber'})
Room selection number.
class-attribute
instance-attribute
room_selection_timeslot: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSelectionTimeslot'})
Room selection timeslot.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
dataclass
SelectTermSessionInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
cancel_booking_default_end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelBookingDefaultEnd_BookingReasonID'})
The default booking end reason when cancelling a booking.
class-attribute
instance-attribute
cancel_booking_update_end_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CancelBookingUpdateEndBookingReason_BooleanAskEnum'})
Update booking end reason on booking cancel.
class-attribute
instance-attribute
check_in_date_actual_decrease_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActualDecrease_BooleanAskEnum'})
Update CheckInDateActual if check-in date moves backward (in the past).
class-attribute
instance-attribute
check_in_date_actual_increase_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActualIncrease_BooleanAskEnum'})
Update CheckInDateActual if check-in date moves forward (in the future).
class-attribute
instance-attribute
check_in_default_start_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDefaultStart_BookingReasonID'})
The default booking start reason when checking in.
class-attribute
instance-attribute
check_in_update_start_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInUpdateStartBookingReason_BooleanAskEnum'})
Update booking start reason on check-in.
class-attribute
instance-attribute
check_out_date_actual_decrease_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActualDecrease_BooleanAskEnum'})
Update CheckOutDateActual if check-in date moves backward (in the past).
class-attribute
instance-attribute
check_out_date_actual_increase_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActualIncrease_BooleanAskEnum'})
Update CheckOutDateActual if check-in date moves forward (in the future).
class-attribute
instance-attribute
check_out_default_end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDefaultEnd_BookingReasonID'})
The default booking end reason when checking out.
class-attribute
instance-attribute
check_out_update_end_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutUpdateEndBookingReason_BooleanAskEnum'})
Update booking end reason on check-out.
class-attribute
instance-attribute
contract_date_check_in_decrease_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateCheckInDecrease_BooleanAskEnum'})
Update Charge Dates if check-in date moves backward (in the past).
class-attribute
instance-attribute
contract_date_check_in_increase_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateCheckInIncrease_BooleanAskEnum'})
Update Charge Dates if check-in date moves forward (in the future).
class-attribute
instance-attribute
contract_date_check_out_decrease_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateCheckOutDecrease_BooleanAskEnum'})
Update Charge Dates if check-out date moves backward (in the past).
class-attribute
instance-attribute
contract_date_check_out_increase_boolean_ask_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateCheckOutIncrease_BooleanAskEnum'})
Update Charge Dates if check-out date moves forward (in the future).
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Term description.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
Pointer to the end booking reason record.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
Entry status.
class-attribute
instance-attribute
Minutes since midnight for estimated time of arrival.
class-attribute
instance-attribute
Minutes since midnight for estimated time of departure.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
Pointer to the house-keeping record.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Fixed room location.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the address room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Room rate amount.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Pointer to the room rate record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
start_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Start_BookingReasonID'})
Pointer to the start booking reason record.
class-attribute
instance-attribute
term_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermID'})
Pointer to the term record.
class-attribute
instance-attribute
term_session_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermSessionCode'})
Term session code.
class-attribute
instance-attribute
term_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermSessionID'})
Unique ID for this term session record.
dataclass
SelectEntryDetailInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
academic_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AcademicHold'})
Indicates if the academic hold flag has been set.
class-attribute
instance-attribute
account_payment_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Account_PaymentTypeID'})
Pointer to the payment type record.
class-attribute
instance-attribute
account_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountHold'})
Indicates if the account hold flag has been set.
class-attribute
instance-attribute
account_bank_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankName'})
Account bank name.
class-attribute
instance-attribute
account_bank_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankNumber'})
Account bank number.
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
account_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountComments'})
Account comments.
class-attribute
instance-attribute
account_detail1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail1'})
Account detail.
class-attribute
instance-attribute
account_detail2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail2'})
Account detail.
class-attribute
instance-attribute
account_detail3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail3'})
Account detail.
class-attribute
instance-attribute
account_detail4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail4'})
Account detail.
class-attribute
instance-attribute
athlete: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Athlete'})
Indicates if the athlete flag has been set.
class-attribute
instance-attribute
athlete_team: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AthleteTeam'})
Athlete team.
class-attribute
instance-attribute
attendee_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AttendeeStatusEnum'})
Attendee status.
class-attribute
instance-attribute
career: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Career'})
Intended career.
class-attribute
instance-attribute
career_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CareerComments'})
Reasons for choosing intended career.
class-attribute
instance-attribute
citizenship_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Citizenship_CountryID'})
Pointer to the citizenship record.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
classification_override: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationOverride'})
Classification override.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments.
class-attribute
instance-attribute
country_of_birth_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfBirth_CountryID'})
Pointer to the country of birth record.
class-attribute
instance-attribute
country_of_residence_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfResidence_CountryID'})
Pointer to the country of residence record.
class-attribute
instance-attribute
cumulative_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeGPA'})
Cumulative GPA.
class-attribute
instance-attribute
cumulative_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeHours'})
Cumulative hours.
class-attribute
instance-attribute
current_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentGPA'})
Current GPA.
class-attribute
instance-attribute
current_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentHours'})
Current hours.
class-attribute
instance-attribute
current_major: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMajor'})
The major chosen by the Entry.
class-attribute
instance-attribute
current_minor: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMinor'})
The minor chosen by the Entry.
class-attribute
instance-attribute
deceased: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Deceased'})
Indicates if the Entry is deceased.
class-attribute
instance-attribute
dietary: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Dietary'})
Dietary requirements.
class-attribute
instance-attribute
disability: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Disability'})
Disability.
class-attribute
instance-attribute
employment_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmploymentDetails'})
Employment details.
class-attribute
instance-attribute
enrollment_class: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentClass'})
First year, freshman, sophomore, etc.
class-attribute
instance-attribute
enrollment_level: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentLevel'})
Undergraduate, post graduate, etc.
class-attribute
instance-attribute
enrollment_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentStatus'})
Newly admitted, current, active, etc.
class-attribute
instance-attribute
enrollment_term: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTerm'})
Spring, fall, post graduate, etc.
class-attribute
instance-attribute
enrollment_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentYear'})
Year/Level of enrollment.
class-attribute
instance-attribute
entry_detail_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryDetailID'})
Unique ID for this entry detail record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
ethnicity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Ethnicity'})
Ethnicity.
class-attribute
instance-attribute
event_registration_fee_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventRegistrationFeeID'})
Pointer to the event registration fee record.
class-attribute
instance-attribute
financial_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialComments'})
Financial support comments.
class-attribute
instance-attribute
financial_support_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialSupportID'})
Pointer to the financial support record.
class-attribute
instance-attribute
hear_about_us: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HearAboutUs'})
How did the Entry hear about us.
class-attribute
instance-attribute
honors_indicator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HonorsIndicator'})
Honors indicator.
class-attribute
instance-attribute
immunizations_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImmunizationsHold'})
Immunizations hold.
class-attribute
instance-attribute
incident_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHold'})
Incident hold.
class-attribute
instance-attribute
incident_hold_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHoldComments'})
Incident hold comments.
class-attribute
instance-attribute
international: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'International'})
Indicates if the Entry is considered an international student.
class-attribute
instance-attribute
international_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternationalDetails'})
International details.
class-attribute
instance-attribute
living_with_dependents: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LivingWithDependents'})
Living with dependents.
class-attribute
instance-attribute
married: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Married'})
Indicates if the Entry is married.
class-attribute
instance-attribute
medical: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Medical'})
Medical details.
class-attribute
instance-attribute
nationality_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NationalityID'})
Pointer to the nationality record.
class-attribute
instance-attribute
occupation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupation'})
Occupation.
class-attribute
instance-attribute
photo_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhotoPath'})
Photo path.
class-attribute
instance-attribute
previous_member_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberName'})
Previous member name.
class-attribute
instance-attribute
previous_member_relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberRelationship'})
Previous member relationship.
class-attribute
instance-attribute
previous_membership: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembership'})
Previous membership.
class-attribute
instance-attribute
previous_membership_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembershipYears'})
Previous membership years.
class-attribute
instance-attribute
previous_member_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberYears'})
Previous member years.
class-attribute
instance-attribute
profile_interests: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProfileInterests'})
Profile interests.
class-attribute
instance-attribute
region_of_birth_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RegionOfBirthID'})
Pointer to the Region of birth record.
class-attribute
instance-attribute
religion: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Religion'})
Religion.
class-attribute
instance-attribute
residency: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Residency'})
Residency.
class-attribute
instance-attribute
resident_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentStatus'})
Resident status.
class-attribute
instance-attribute
resident_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentYear'})
Resident year.
class-attribute
instance-attribute
situation_response_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseComments'})
Situation response comments.
class-attribute
instance-attribute
situation_response_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseDetail'})
Situation response detail.
class-attribute
instance-attribute
situation_response_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseEnum'})
Situation response.
class-attribute
instance-attribute
situation_response_situation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseSituation'})
Situation response situation.
class-attribute
instance-attribute
special_needs: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialNeeds'})
Special needs.
class-attribute
instance-attribute
staff_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StaffID'})
Pointer to the staff record.
class-attribute
instance-attribute
uses_screen_reader: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UsesScreenReader'})
Uses screen reader.
class-attribute
instance-attribute
vehicle_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleDetails'})
Vehicle details.
class-attribute
instance-attribute
vehicle_permit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehiclePermit'})
Vehicle permit.
class-attribute
instance-attribute
vehicle_registration: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleRegistration'})
Vehicle registration.
class-attribute
instance-attribute
veteran_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VeteranStatus'})
Veteran status.
class-attribute
instance-attribute
Indicates if the Entry holds a visa.
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
class-attribute
instance-attribute
academic_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AcademicHold'})
Indicates if the academic hold flag has been set.
class-attribute
instance-attribute
account_payment_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Account_PaymentTypeID'})
Pointer to the preferred payment type record.
class-attribute
instance-attribute
account_bank_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankName'})
Account bank name.
class-attribute
instance-attribute
account_bank_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankNumber'})
Account bank number.
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
account_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountComments'})
Account comments.
class-attribute
instance-attribute
account_detail1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail1'})
Account detail.
class-attribute
instance-attribute
account_detail2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail2'})
Account detail.
class-attribute
instance-attribute
account_detail3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail3'})
Account detail.
class-attribute
instance-attribute
account_detail4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail4'})
Account detail.
class-attribute
instance-attribute
account_due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDueDate'})
Paid to date.
class-attribute
instance-attribute
account_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountHold'})
Indicates if the account hold flag has been set.
class-attribute
instance-attribute
athlete: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Athlete'})
Indicates if the athlete flag has been set.
class-attribute
instance-attribute
athlete_team: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AthleteTeam'})
Athlete team.
class-attribute
instance-attribute
attendee_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AttendeeStatusEnum'})
Attendee status.
class-attribute
instance-attribute
career: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Career'})
Intended career.
class-attribute
instance-attribute
career_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CareerComments'})
Reasons for choosing intended career.
class-attribute
instance-attribute
citizenship_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Citizenship_CountryID'})
Pointer to the citizenship record.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
classification_override: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationOverride'})
Classification override.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments.
class-attribute
instance-attribute
country_of_birth_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfBirth_CountryID'})
Pointer to the country of birth record.
class-attribute
instance-attribute
country_of_residence_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfResidence_CountryID'})
Pointer to the country of residence record.
class-attribute
instance-attribute
cumulative_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeGPA'})
Cumulative GPA.
class-attribute
instance-attribute
cumulative_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeHours'})
Cumulative hours.
class-attribute
instance-attribute
current_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentGPA'})
Current GPA.
class-attribute
instance-attribute
current_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentHours'})
Current hours.
class-attribute
instance-attribute
current_major: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMajor'})
The major chosen by the Entry.
class-attribute
instance-attribute
current_minor: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMinor'})
The minor chosen by the Entry.
class-attribute
instance-attribute
date_entry: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEntry'})
Entry date.
class-attribute
instance-attribute
date_exit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateExit'})
Exit date.
class-attribute
instance-attribute
deceased: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Deceased'})
Indicates if the Entry is deceased.
class-attribute
instance-attribute
deceased_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DeceasedDate'})
Deceased date.
class-attribute
instance-attribute
dietary: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Dietary'})
Dietary requirements.
class-attribute
instance-attribute
disability: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Disability'})
Disability.
class-attribute
instance-attribute
employment_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmploymentDetails'})
Employment details.
class-attribute
instance-attribute
enrollment_class: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentClass'})
First year, freshman, sophomore, etc.
class-attribute
instance-attribute
enrollment_level: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentLevel'})
Undergraduate, post graduate, etc.
class-attribute
instance-attribute
enrollment_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentStatus'})
Newly admitted, current, active, etc.
class-attribute
instance-attribute
enrollment_term: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTerm'})
Spring, fall, post graduate, etc.
class-attribute
instance-attribute
enrollment_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentYear'})
Year/Level of enrollment.
class-attribute
instance-attribute
entry_detail_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryDetailID'})
Unique ID for this entry detail record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
ethnicity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Ethnicity'})
Ethnicity.
class-attribute
instance-attribute
event_registration_fee_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventRegistrationFeeID'})
Pointer to the Event registration fee record.
class-attribute
instance-attribute
expected_graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedGraduationDate'})
Expected graduation date.
class-attribute
instance-attribute
financial_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialComments'})
Financial support comments.
class-attribute
instance-attribute
financial_support_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialSupportID'})
Pointer to the financial support record.
class-attribute
instance-attribute
hear_about_us: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HearAboutUs'})
How did the Entry hear about us.
class-attribute
instance-attribute
honors_indicator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HonorsIndicator'})
Honors indicator.
class-attribute
instance-attribute
immunizations_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImmunizationsHold'})
Immunizations hold.
class-attribute
instance-attribute
incident_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHold'})
Incident hold.
class-attribute
instance-attribute
incident_hold_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHoldComments'})
Incident hold comments.
class-attribute
instance-attribute
international: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'International'})
Indicates if the Entry is considered an international student.
class-attribute
instance-attribute
international_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternationalDetails'})
International details.
class-attribute
instance-attribute
living_with_dependents: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LivingWithDependents'})
Living with dependents.
class-attribute
instance-attribute
married: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Married'})
Indicates if the Entry is married.
class-attribute
instance-attribute
medical: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Medical'})
Medical details.
class-attribute
instance-attribute
nationality_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NationalityID'})
Pointer to the nationality record.
class-attribute
instance-attribute
occupation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupation'})
Occupation.
class-attribute
instance-attribute
photo_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhotoPath'})
Photo path.
class-attribute
instance-attribute
previous_member_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberName'})
Previous member name.
class-attribute
instance-attribute
previous_member_relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberRelationship'})
Previous member relationship.
class-attribute
instance-attribute
previous_membership: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembership'})
Previous membership.
class-attribute
instance-attribute
previous_membership_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembershipYears'})
Previous membership years.
class-attribute
instance-attribute
previous_member_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberYears'})
Previous member years.
class-attribute
instance-attribute
profile_interests: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProfileInterests'})
Profile interests.
class-attribute
instance-attribute
region_of_birth_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RegionOfBirthID'})
Pointer to the region of birth record.
class-attribute
instance-attribute
religion: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Religion'})
Religion.
class-attribute
instance-attribute
residency: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Residency'})
Residency.
class-attribute
instance-attribute
resident_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentStatus'})
Resident status.
class-attribute
instance-attribute
resident_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentYear'})
Resident year.
class-attribute
instance-attribute
situation_response_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseComments'})
Situation response comments.
class-attribute
instance-attribute
situation_response_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseDetail'})
Situation response detail.
class-attribute
instance-attribute
situation_response_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseEnum'})
Situation response.
class-attribute
instance-attribute
situation_response_expiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseExpiryDate'})
The date when the response ends (e.g because the emergency is over)
class-attribute
instance-attribute
situation_response_modified_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseModifiedDate'})
The date the response was last modified.
class-attribute
instance-attribute
situation_response_situation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseSituation'})
Situation response situation.
class-attribute
instance-attribute
special_needs: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialNeeds'})
Special needs.
class-attribute
instance-attribute
staff_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StaffID'})
Pointer to the staff record.
class-attribute
instance-attribute
uses_screen_reader: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UsesScreenReader'})
Uses screen reader.
class-attribute
instance-attribute
vehicle_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleDetails'})
Vehicle details.
class-attribute
instance-attribute
vehicle_permit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehiclePermit'})
Vehicle permit.
class-attribute
instance-attribute
vehicle_registration: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleRegistration'})
Vehicle registration.
class-attribute
instance-attribute
veteran_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VeteranStatus'})
Veteran status.
class-attribute
instance-attribute
Indicates if the Entry holds a visa.
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
class-attribute
instance-attribute
academic_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AcademicHold'})
Indicates if the academic hold flag has been set.
class-attribute
instance-attribute
account_payment_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Account_PaymentTypeID'})
Pointer to the preferred payment type record.
class-attribute
instance-attribute
account_bank_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankName'})
Account bank name.
class-attribute
instance-attribute
account_bank_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountBankNumber'})
Account bank number.
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
account_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountComments'})
Account comments.
class-attribute
instance-attribute
account_detail1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail1'})
Account detail.
class-attribute
instance-attribute
account_detail2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail2'})
Account detail.
class-attribute
instance-attribute
account_detail3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail3'})
Account detail.
class-attribute
instance-attribute
account_detail4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDetail4'})
Account detail.
class-attribute
instance-attribute
account_due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountDueDate'})
Paid to date.
class-attribute
instance-attribute
account_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountHold'})
Indicates if the account hold flag has been set.
class-attribute
instance-attribute
athlete: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Athlete'})
Indicates if the athlete flag has been set.
class-attribute
instance-attribute
athlete_team: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AthleteTeam'})
Athlete team.
class-attribute
instance-attribute
attendee_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AttendeeStatusEnum'})
Attendee status.
class-attribute
instance-attribute
career: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Career'})
Intended career.
class-attribute
instance-attribute
career_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CareerComments'})
Reasons for choosing intended career.
class-attribute
instance-attribute
citizenship_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Citizenship_CountryID'})
Pointer to the citizenship record.
class-attribute
instance-attribute
classification_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationID'})
Pointer to the classification record.
class-attribute
instance-attribute
classification_override: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ClassificationOverride'})
Classification override.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments.
class-attribute
instance-attribute
country_of_birth_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfBirth_CountryID'})
Pointer to the country of birth record.
class-attribute
instance-attribute
country_of_residence_country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryOfResidence_CountryID'})
Pointer to the country of residence record.
class-attribute
instance-attribute
cumulative_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeGPA'})
Cumulative GPA.
class-attribute
instance-attribute
cumulative_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CumulativeHours'})
Cumulative hours.
class-attribute
instance-attribute
current_g_p_a: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentGPA'})
Current GPA.
class-attribute
instance-attribute
current_hours: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentHours'})
Current hours.
class-attribute
instance-attribute
current_major: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMajor'})
The major chosen by the Entry.
class-attribute
instance-attribute
current_minor: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CurrentMinor'})
The minor chosen by the Entry.
class-attribute
instance-attribute
date_entry: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEntry'})
Entry date.
class-attribute
instance-attribute
date_exit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateExit'})
Exit date.
class-attribute
instance-attribute
deceased: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Deceased'})
Indicates if the Entry is deceased.
class-attribute
instance-attribute
deceased_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DeceasedDate'})
Deceased date.
class-attribute
instance-attribute
dietary: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Dietary'})
Dietary requirements.
class-attribute
instance-attribute
disability: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Disability'})
Disability.
class-attribute
instance-attribute
employment_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmploymentDetails'})
Employment details.
class-attribute
instance-attribute
enrollment_class: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentClass'})
First year, freshman, sophomore, etc.
class-attribute
instance-attribute
enrollment_level: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentLevel'})
Undergraduate, post graduate, etc.
class-attribute
instance-attribute
enrollment_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentStatus'})
Newly admitted, current, active, etc.
class-attribute
instance-attribute
enrollment_term: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTerm'})
Spring, fall, post graduate, etc.
class-attribute
instance-attribute
enrollment_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentYear'})
Year/Level of enrollment.
class-attribute
instance-attribute
entry_detail_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryDetailID'})
Unique ID for this entry detail record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
ethnicity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Ethnicity'})
Ethnicity.
class-attribute
instance-attribute
event_registration_fee_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EventRegistrationFeeID'})
Pointer to the event registration fee record.
class-attribute
instance-attribute
expected_graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpectedGraduationDate'})
Expected graduation date.
class-attribute
instance-attribute
financial_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialComments'})
Financial support comments.
class-attribute
instance-attribute
financial_support_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinancialSupportID'})
Pointer to the financial support fee record.
class-attribute
instance-attribute
hear_about_us: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HearAboutUs'})
How did the Entry hear about us.
class-attribute
instance-attribute
honors_indicator: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HonorsIndicator'})
Honors indicator.
class-attribute
instance-attribute
immunizations_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ImmunizationsHold'})
Immunizations hold.
class-attribute
instance-attribute
incident_hold: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHold'})
Incident hold.
class-attribute
instance-attribute
incident_hold_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IncidentHoldComments'})
Incident hold comments.
class-attribute
instance-attribute
international: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'International'})
Indicates if the Entry is considered an international student.
class-attribute
instance-attribute
international_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternationalDetails'})
International details.
class-attribute
instance-attribute
living_with_dependents: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LivingWithDependents'})
Living with dependents.
class-attribute
instance-attribute
married: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Married'})
Indicates if the Entry is married.
class-attribute
instance-attribute
medical: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Medical'})
Medical details.
class-attribute
instance-attribute
nationality_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NationalityID'})
Pointer to the nationality record.
class-attribute
instance-attribute
occupation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupation'})
Occupation.
class-attribute
instance-attribute
photo_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhotoPath'})
Photo path.
class-attribute
instance-attribute
previous_member_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberName'})
Previous member name.
class-attribute
instance-attribute
previous_member_relationship: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberRelationship'})
Previous member relationship.
class-attribute
instance-attribute
previous_membership: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembership'})
Previous membership.
class-attribute
instance-attribute
previous_membership_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMembershipYears'})
Previous membership years.
class-attribute
instance-attribute
previous_member_years: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PreviousMemberYears'})
Previous member years.
class-attribute
instance-attribute
profile_interests: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProfileInterests'})
Profile interests.
class-attribute
instance-attribute
region_of_birth_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RegionOfBirthID'})
Pointer to the region of birth record.
class-attribute
instance-attribute
religion: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Religion'})
Religion.
class-attribute
instance-attribute
residency: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Residency'})
Residency.
class-attribute
instance-attribute
resident_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentStatus'})
Resident status.
class-attribute
instance-attribute
resident_year: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResidentYear'})
Resident year.
class-attribute
instance-attribute
situation_response_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseComments'})
Situation response comments.
class-attribute
instance-attribute
situation_response_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseDetail'})
Situation response detail.
class-attribute
instance-attribute
situation_response_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseEnum'})
Situation response.
class-attribute
instance-attribute
situation_response_expiry_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseExpiryDate'})
The date when the response ends (e.g. because the emergency is over)
class-attribute
instance-attribute
situation_response_modified_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseModifiedDate'})
The date the response was last modified.
class-attribute
instance-attribute
situation_response_situation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SituationResponseSituation'})
Situation response situation.
class-attribute
instance-attribute
special_needs: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialNeeds'})
Special needs.
class-attribute
instance-attribute
staff_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StaffID'})
Pointer to the staff record.
class-attribute
instance-attribute
uses_screen_reader: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UsesScreenReader'})
Uses screen reader.
class-attribute
instance-attribute
vehicle_details: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleDetails'})
Vehicle details.
class-attribute
instance-attribute
vehicle_permit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehiclePermit'})
Vehicle permit.
class-attribute
instance-attribute
vehicle_registration: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VehicleRegistration'})
Vehicle registration.
class-attribute
instance-attribute
veteran_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VeteranStatus'})
Veteran status.
class-attribute
instance-attribute
Indicates if the Entry holds a visa.
dataclass
SelectEntryEnrollmentInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
campus: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Campus'})
Campus where entry is enrolled.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Enrollment comments.
class-attribute
instance-attribute
course_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CourseID'})
Pointer to the course record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
Department entry is enrolled in.
class-attribute
instance-attribute
enrollment_field: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentField'})
Field of enrollment.
class-attribute
instance-attribute
enrollment_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentOrder'})
Enrollment order.
class-attribute
instance-attribute
enrollment_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTypeEnum'})
Enrollment type.
class-attribute
instance-attribute
entry_enrollment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryEnrollmentID'})
Unique ID for this entry enrollment record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
faculty: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Faculty'})
Course faculty.
class-attribute
instance-attribute
full_time: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FullTime'})
Indicates if the entry is enrolled full time.
class-attribute
instance-attribute
institution: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Institution'})
Course institution.
class-attribute
instance-attribute
is_enrolled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsEnrolled'})
Indicates if the entry is enrolled.
class-attribute
instance-attribute
Course Major.
class-attribute
instance-attribute
major_category: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MajorCategory'})
Major category.
class-attribute
instance-attribute
Course Minor.
class-attribute
instance-attribute
post_grad: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PostGrad'})
Indicates if this is a post graduate course.
class-attribute
instance-attribute
sequence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sequence'})
Sequence
class-attribute
instance-attribute
subjects: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subjects'})
The subjects the entry is enrolled in.
dataclass
CreateEntryEnrollmentInput(entry_id: int, *, 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, 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
class-attribute
instance-attribute
campus: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Campus'})
Campus where entry is enrolled.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Enrollment comments.
class-attribute
instance-attribute
course_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CourseID'})
Pointer to the course record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEnd'})
Date enrollment ends.
class-attribute
instance-attribute
date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateStart'})
Date enrollment starts.
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
Department entry is enrolled in.
class-attribute
instance-attribute
enrollment_field: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentField'})
Field of enrollment.
class-attribute
instance-attribute
enrollment_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentOrder'})
Enrollment order.
class-attribute
instance-attribute
enrollment_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTypeEnum'})
Enrollment type.
class-attribute
instance-attribute
entry_enrollment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryEnrollmentID'})
Unique ID for this entry enrollment record.
class-attribute
instance-attribute
Pointer to the entry record.
class-attribute
instance-attribute
faculty: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Faculty'})
Course faculty.
class-attribute
instance-attribute
full_time: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FullTime'})
Indicates if the entry is enrolled full time.
class-attribute
instance-attribute
graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GraduationDate'})
Date of graduation.
class-attribute
instance-attribute
institution: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Institution'})
Course institution.
class-attribute
instance-attribute
is_enrolled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsEnrolled'})
Indicates if the entry is enrolled.
class-attribute
instance-attribute
Course Major.
class-attribute
instance-attribute
major_category: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MajorCategory'})
Major category.
class-attribute
instance-attribute
Course Minor.
class-attribute
instance-attribute
post_grad: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PostGrad'})
Indicates if this is a post graduate course.
class-attribute
instance-attribute
sequence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sequence'})
Sequence
class-attribute
instance-attribute
subjects: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subjects'})
The subjects the entry is enrolled in.
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
class-attribute
instance-attribute
campus: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Campus'})
Campus where entry is enrolled.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Enrollment comments.
class-attribute
instance-attribute
course_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CourseID'})
Pointer to the course record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEnd'})
Date enrollment ends.
class-attribute
instance-attribute
date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateStart'})
Date enrollment starts.
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
Department entry is enrolled in.
class-attribute
instance-attribute
enrollment_field: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentField'})
Field of enrollment.
class-attribute
instance-attribute
enrollment_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentOrder'})
Enrollment order.
class-attribute
instance-attribute
enrollment_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTypeEnum'})
Enrollment type.
class-attribute
instance-attribute
entry_enrollment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryEnrollmentID'})
Unique ID for this entry enrollment record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
faculty: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Faculty'})
Course faculty.
class-attribute
instance-attribute
full_time: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FullTime'})
Indicates if the entry is enrolled full time.
class-attribute
instance-attribute
graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GraduationDate'})
Date of graduation.
class-attribute
instance-attribute
institution: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Institution'})
Course institution.
class-attribute
instance-attribute
is_enrolled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsEnrolled'})
Indicates if the entry is enrolled.
class-attribute
instance-attribute
Course Major.
class-attribute
instance-attribute
major_category: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MajorCategory'})
Major category.
class-attribute
instance-attribute
Course Minor.
class-attribute
instance-attribute
post_grad: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PostGrad'})
Indicates if this is a post graduate course.
class-attribute
instance-attribute
sequence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sequence'})
Sequence
class-attribute
instance-attribute
subjects: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subjects'})
The subjects the entry is enrolled in.
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
class-attribute
instance-attribute
campus: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Campus'})
Campus where entry is enrolled.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Enrollment comments.
class-attribute
instance-attribute
course_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CourseID'})
Pointer to the course record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEnd'})
Date enrollment ends.
class-attribute
instance-attribute
date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateStart'})
Date enrollment starts.
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
Department entry is enrolled in.
class-attribute
instance-attribute
enrollment_field: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentField'})
Field of enrollment.
class-attribute
instance-attribute
enrollment_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentOrder'})
Enrollment order.
class-attribute
instance-attribute
enrollment_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTypeEnum'})
Enrollment type.
class-attribute
instance-attribute
entry_enrollment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryEnrollmentID'})
Unique ID for this entry enrollment record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
faculty: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Faculty'})
Course faculty.
class-attribute
instance-attribute
full_time: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FullTime'})
Indicates if the entry is enrolled full time.
class-attribute
instance-attribute
graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GraduationDate'})
Date of graduation.
class-attribute
instance-attribute
institution: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Institution'})
Course institution.
class-attribute
instance-attribute
is_enrolled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsEnrolled'})
Indicates if the entry is enrolled.
class-attribute
instance-attribute
Course Major.
class-attribute
instance-attribute
major_category: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MajorCategory'})
Major category.
class-attribute
instance-attribute
Course Minor.
class-attribute
instance-attribute
post_grad: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PostGrad'})
Indicates if this is a post graduate course.
class-attribute
instance-attribute
sequence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sequence'})
Sequence
class-attribute
instance-attribute
subjects: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subjects'})
The subjects the entry is enrolled in.
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
class-attribute
instance-attribute
campus: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Campus'})
Campus where entry is enrolled.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Enrollment comments.
class-attribute
instance-attribute
course_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CourseID'})
Pointer to the course record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEnd'})
Date enrollment ends.
class-attribute
instance-attribute
date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateStart'})
Date enrollment starts.
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
Department entry is enrolled in.
class-attribute
instance-attribute
enrollment_field: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentField'})
Field of enrollment.
class-attribute
instance-attribute
enrollment_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentOrder'})
Enrollment order.
class-attribute
instance-attribute
enrollment_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnrollmentTypeEnum'})
Enrollment type.
class-attribute
instance-attribute
entry_enrollment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryEnrollmentID'})
Unique ID for this entry enrollment record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
faculty: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Faculty'})
Course faculty.
class-attribute
instance-attribute
full_time: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FullTime'})
Indicates if the entry is enrolled full time.
class-attribute
instance-attribute
graduation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GraduationDate'})
Date of graduation.
class-attribute
instance-attribute
institution: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Institution'})
Course institution.
class-attribute
instance-attribute
is_enrolled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsEnrolled'})
Indicates if the entry is enrolled.
class-attribute
instance-attribute
Course Major.
class-attribute
instance-attribute
major_category: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MajorCategory'})
Major category.
class-attribute
instance-attribute
Course Minor.
class-attribute
instance-attribute
post_grad: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PostGrad'})
Indicates if this is a post graduate course.
class-attribute
instance-attribute
sequence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sequence'})
Sequence
class-attribute
instance-attribute
subjects: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subjects'})
The subjects the entry is enrolled in.
dataclass
SelectBookingInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
additional_occupant_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalOccupantCount'})
The number of additional human occupants in this booking.
class-attribute
instance-attribute
auto_allocation_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoAllocationDetail'})
Details of the auto allocation.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Unique ID for this booking record.
class-attribute
instance-attribute
booking_link_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingLinkTypeEnum'})
Booking link type.
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
custom_string7: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString7'})
Custom string field value.
class-attribute
instance-attribute
custom_string8: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString8'})
Custom string field value.
class-attribute
instance-attribute
custom_string9: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString9'})
Custom string field value.
class-attribute
instance-attribute
custom_string10: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString10'})
Custom string field value.
class-attribute
instance-attribute
emotional_support_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmotionalSupportAnimalCount'})
The number of additional Emotional Support Animal occupants in this booking.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
The reason this booking finished.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
entry_invitation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryInvitationID'})
Identifies the entry invitation that the booking is created for.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the booking.
class-attribute
instance-attribute
Minutes since midnight for estimated time of arrival.
class-attribute
instance-attribute
Minutes since midnight for estimated time of departure.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Amount of excess.
class-attribute
instance-attribute
group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupID'})
Pointer to the group record.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
The housekeeping rules that should be applied to this booking.
class-attribute
instance-attribute
number_of_children: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildren'})
The number of children in the booking.
class-attribute
instance-attribute
number_of_children_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildrenFree'})
The number of children that are free to stay.
class-attribute
instance-attribute
number_of_guests: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuests'})
The number of guests in the booking.
class-attribute
instance-attribute
number_of_guests_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuestsFree'})
The number of guests that are free to stay.
class-attribute
instance-attribute
pet_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PetCount'})
The number of additional pet occupants in this booking.
class-attribute
instance-attribute
resv_charge_to_entry: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResvChargeToEntry'})
Whether reservation charges are charged to the entry or group master account.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Actual dollar amount of room rate.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Selected room rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
service_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceAnimalCount'})
The number of additional Service Animal occupants in this booking.
class-attribute
instance-attribute
special_requirement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialRequirement'})
Special requirements for this booking.
dataclass
CreateBookingInput(entry_id: int, *, 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_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
class-attribute
instance-attribute
additional_occupant_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalOccupantCount'})
The number of additional human occupants in this booking.
class-attribute
instance-attribute
auto_allocation_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoAllocationDetail'})
Details of the auto allocation.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Unique ID for this booking record.
class-attribute
instance-attribute
booking_link_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingLinkTypeEnum'})
Booking link type.
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
check_in_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDate'})
Main (contract) check-in date.
class-attribute
instance-attribute
check_in_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActual'})
Actual date the entry arrives.
class-attribute
instance-attribute
check_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDate'})
Main (contract) check-out date.
class-attribute
instance-attribute
check_out_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActual'})
Actual date the entry departs.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments
class-attribute
instance-attribute
contract_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateEnd'})
Contact chargeable date end.
class-attribute
instance-attribute
contract_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateStart'})
Contact chargeable date start.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
custom_string7: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString7'})
Custom string field value.
class-attribute
instance-attribute
custom_string8: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString8'})
Custom string field value.
class-attribute
instance-attribute
custom_string9: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString9'})
Custom string field value.
class-attribute
instance-attribute
custom_string10: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString10'})
Custom string field value.
class-attribute
instance-attribute
date_billed: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateBilled'})
Date when this booking was processed for billing.
class-attribute
instance-attribute
date_charged_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateChargedTo'})
Date this booking has been charged up to (using reservation charges).
class-attribute
instance-attribute
emotional_support_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmotionalSupportAnimalCount'})
The number of additional Emotional Support Animal occupants in this booking.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
The reason this booking finished.
class-attribute
instance-attribute
Pointer to the entry record.
class-attribute
instance-attribute
entry_invitation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryInvitationID'})
Identifies the entry invitation that the booking is created for.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the booking.
class-attribute
instance-attribute
Date and time of estimated arrival.
class-attribute
instance-attribute
Date and time of estimated departure.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Amount of excess.
class-attribute
instance-attribute
group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupID'})
Pointer to the group record.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
The housekeeping rules that should be applied to this booking.
class-attribute
instance-attribute
number_of_children: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildren'})
The number of children in the booking.
class-attribute
instance-attribute
number_of_children_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildrenFree'})
The number of children that are free to stay.
class-attribute
instance-attribute
number_of_guests: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuests'})
The number of guests in the booking.
class-attribute
instance-attribute
number_of_guests_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuestsFree'})
The number of guests that are free to stay.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Date the booking is paid to.
class-attribute
instance-attribute
pet_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PetCount'})
The number of additional pet occupants in this booking.
class-attribute
instance-attribute
resv_charge_to_entry: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResvChargeToEntry'})
Whether reservation charges are charged to the entry or group master account.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Actual dollar amount of room rate.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Selected room rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
service_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceAnimalCount'})
The number of additional Service Animal occupants in this booking.
class-attribute
instance-attribute
special_requirement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialRequirement'})
Special requirements for this booking.
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
class-attribute
instance-attribute
additional_occupant_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalOccupantCount'})
The number of additional human occupants in this booking.
class-attribute
instance-attribute
auto_allocation_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoAllocationDetail'})
Details of the auto allocation.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Unique ID for this booking record.
class-attribute
instance-attribute
booking_link_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingLinkTypeEnum'})
Booking link type.
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
check_in_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDate'})
Main (contract) check-in date.
class-attribute
instance-attribute
check_in_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActual'})
Actual date the entry arrives.
class-attribute
instance-attribute
check_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDate'})
Main (contract) check-out date.
class-attribute
instance-attribute
check_out_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActual'})
Actual date the entry departs.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments
class-attribute
instance-attribute
contract_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateEnd'})
Contact chargeable date end.
class-attribute
instance-attribute
contract_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateStart'})
Contact chargeable date start.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
custom_string7: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString7'})
Custom string field value.
class-attribute
instance-attribute
custom_string8: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString8'})
Custom string field value.
class-attribute
instance-attribute
custom_string9: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString9'})
Custom string field value.
class-attribute
instance-attribute
custom_string10: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString10'})
Custom string field value.
class-attribute
instance-attribute
date_billed: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateBilled'})
Date when this booking was processed for billing.
class-attribute
instance-attribute
date_charged_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateChargedTo'})
Date this booking has been charged up to (using reservation charges).
class-attribute
instance-attribute
date_modified_billing: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModifiedBilling'})
Indicates when critical booking fields are modified.
class-attribute
instance-attribute
emotional_support_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmotionalSupportAnimalCount'})
The number of additional Emotional Support Animal occupants in this booking.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
The reason this booking finished.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
entry_invitation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryInvitationID'})
Identifies the entry invitation that the booking is created for.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the booking.
class-attribute
instance-attribute
Date and time of estimated arrival.
class-attribute
instance-attribute
Date and time of estimated departure.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Amount of excess.
class-attribute
instance-attribute
group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupID'})
Pointer to the group record.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
The housekeeping rules that should be applied to this booking.
class-attribute
instance-attribute
number_of_children: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildren'})
The number of children in the booking.
class-attribute
instance-attribute
number_of_children_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildrenFree'})
The number of children that are free to stay.
class-attribute
instance-attribute
number_of_guests: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuests'})
The number of guests in the booking.
class-attribute
instance-attribute
number_of_guests_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuestsFree'})
The number of guests that are free to stay.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Date the booking is paid to.
class-attribute
instance-attribute
pet_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PetCount'})
The number of additional pet occupants in this booking.
class-attribute
instance-attribute
resv_charge_to_entry: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResvChargeToEntry'})
Whether reservation charges are charged to the entry or group master account.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Actual dollar amount of room rate.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Selected room rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
service_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceAnimalCount'})
The number of additional Service Animal occupants in this booking.
class-attribute
instance-attribute
special_requirement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialRequirement'})
Special requirements for this booking.
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
class-attribute
instance-attribute
additional_occupant_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalOccupantCount'})
The number of additional human occupants in this booking.
class-attribute
instance-attribute
auto_allocation_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoAllocationDetail'})
Details of the auto allocation.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Unique ID for this booking record.
class-attribute
instance-attribute
booking_link_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingLinkTypeEnum'})
Booking link type.
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
check_in_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDate'})
Main (contract) check-in date.
class-attribute
instance-attribute
check_in_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActual'})
Actual date the entry arrives.
class-attribute
instance-attribute
check_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDate'})
Main (contract) check-out date.
class-attribute
instance-attribute
check_out_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActual'})
Actual date the entry departs.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments
class-attribute
instance-attribute
contract_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateEnd'})
Contact chargeable date end.
class-attribute
instance-attribute
contract_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateStart'})
Contact chargeable date start.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
custom_string7: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString7'})
Custom string field value.
class-attribute
instance-attribute
custom_string8: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString8'})
Custom string field value.
class-attribute
instance-attribute
custom_string9: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString9'})
Custom string field value.
class-attribute
instance-attribute
custom_string10: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString10'})
Custom string field value.
class-attribute
instance-attribute
date_billed: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateBilled'})
Date when this booking was processed for billing.
class-attribute
instance-attribute
date_charged_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateChargedTo'})
Date this booking has been charged up to (using reservation charges).
class-attribute
instance-attribute
emotional_support_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmotionalSupportAnimalCount'})
The number of additional Emotional Support Animal occupants in this booking.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
The reason this booking finished.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
entry_invitation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryInvitationID'})
Identifies the entry invitation that the booking is created for.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the booking.
class-attribute
instance-attribute
Date and time of estimated arrival.
class-attribute
instance-attribute
Date and time of estimated departure.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Amount of excess.
class-attribute
instance-attribute
group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupID'})
Pointer to the group record.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
The housekeeping rules that should be applied to this booking.
class-attribute
instance-attribute
number_of_children: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildren'})
The number of children in the booking.
class-attribute
instance-attribute
number_of_children_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildrenFree'})
The number of children that are free to stay.
class-attribute
instance-attribute
number_of_guests: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuests'})
The number of guests in the booking.
class-attribute
instance-attribute
number_of_guests_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuestsFree'})
The number of guests that are free to stay.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Date the booking is paid to.
class-attribute
instance-attribute
pet_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PetCount'})
The number of additional pet occupants in this booking.
class-attribute
instance-attribute
resv_charge_to_entry: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResvChargeToEntry'})
Whether reservation charges are charged to the entry or group master account.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Actual dollar amount of room rate.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Selected room rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
service_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceAnimalCount'})
The number of additional Service Animal occupants in this booking.
class-attribute
instance-attribute
special_requirement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialRequirement'})
Special requirements for this booking.
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
class-attribute
instance-attribute
additional_occupant_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AdditionalOccupantCount'})
The number of additional human occupants in this booking.
class-attribute
instance-attribute
auto_allocation_detail: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoAllocationDetail'})
Details of the auto allocation.
class-attribute
instance-attribute
booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingID'})
Unique ID for this booking record.
class-attribute
instance-attribute
booking_link_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingLinkTypeEnum'})
Booking link type.
class-attribute
instance-attribute
booking_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BookingTypeID'})
Pointer to the booking type record.
class-attribute
instance-attribute
check_in_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDate'})
Main (contract) check-in date.
class-attribute
instance-attribute
check_in_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckInDateActual'})
Actual date the entry arrives.
class-attribute
instance-attribute
check_out_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDate'})
Main (contract) check-out date.
class-attribute
instance-attribute
check_out_date_actual: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckOutDateActual'})
Actual date the entry departs.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Comments
class-attribute
instance-attribute
contract_date_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateEnd'})
Contact chargeable date end.
class-attribute
instance-attribute
contract_date_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDateStart'})
Contact chargeable date start.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit3: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit3'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit4: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit4'})
Custom boolean field value.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date field value.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date field value.
class-attribute
instance-attribute
custom_date3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate3'})
Custom date field value.
class-attribute
instance-attribute
custom_date4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate4'})
Custom date field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
custom_string7: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString7'})
Custom string field value.
class-attribute
instance-attribute
custom_string8: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString8'})
Custom string field value.
class-attribute
instance-attribute
custom_string9: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString9'})
Custom string field value.
class-attribute
instance-attribute
custom_string10: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString10'})
Custom string field value.
class-attribute
instance-attribute
date_billed: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateBilled'})
Date when this booking was processed for billing.
class-attribute
instance-attribute
date_charged_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateChargedTo'})
Date this booking has been charged up to (using reservation charges).
class-attribute
instance-attribute
date_modified_billing: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModifiedBilling'})
Indicates when critical booking fields are modified.
class-attribute
instance-attribute
emotional_support_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmotionalSupportAnimalCount'})
The number of additional Emotional Support Animal occupants in this booking.
class-attribute
instance-attribute
end_booking_reason_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'End_BookingReasonID'})
The reason this booking finished.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
entry_invitation_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryInvitationID'})
Identifies the entry invitation that the booking is created for.
class-attribute
instance-attribute
entry_status_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryStatusEnum'})
The status of the booking.
class-attribute
instance-attribute
Date and time of estimated arrival.
class-attribute
instance-attribute
Date and time of estimated departure.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Amount of excess.
class-attribute
instance-attribute
group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupID'})
Pointer to the group record.
class-attribute
instance-attribute
housekeeping_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HousekeepingID'})
The housekeeping rules that should be applied to this booking.
class-attribute
instance-attribute
number_of_children: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildren'})
The number of children in the booking.
class-attribute
instance-attribute
number_of_children_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfChildrenFree'})
The number of children that are free to stay.
class-attribute
instance-attribute
number_of_guests: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuests'})
The number of guests in the booking.
class-attribute
instance-attribute
number_of_guests_free: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfGuestsFree'})
The number of guests that are free to stay.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Date the booking is paid to.
class-attribute
instance-attribute
pet_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PetCount'})
The number of additional pet occupants in this booking.
class-attribute
instance-attribute
resv_charge_to_entry: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResvChargeToEntry'})
Whether reservation charges are charged to the entry or group master account.
class-attribute
instance-attribute
room_location_fixed: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationFixed'})
Indicates if the location was manually selected, and should not be changed by Auto Room Allocations.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Pointer to the room location record.
class-attribute
instance-attribute
room_rate_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateAmount'})
Actual dollar amount of room rate.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Selected room rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_type_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomTypeID'})
Pointer to the room type record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
service_animal_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ServiceAnimalCount'})
The number of additional Service Animal occupants in this booking.
class-attribute
instance-attribute
special_requirement: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SpecialRequirement'})
Special requirements for this booking.
dataclass
SelectRoomSpaceInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
allocate_exclude: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateExclude'})
Room Allocation - Do not include room in allocations.
class-attribute
instance-attribute
allocate_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateSortOrder'})
Room Allocation - Allows allocating nicer rooms first.
class-attribute
instance-attribute
bathrooms: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Bathrooms'})
The number of bathrooms available.
class-attribute
instance-attribute
bed_capacity: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BedCapacity'})
The number of beds available.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Room space comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
The actual room name.
class-attribute
instance-attribute
extension_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtensionID'})
Link to extension table. 0 means no phone in the room.
class-attribute
instance-attribute
Space is held for any reason. Will warn the user when allocating this space.
class-attribute
instance-attribute
networked: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Networked'})
Indicates if the room space is networked.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
room_base_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomBaseID'})
Pointer to the room base record.
class-attribute
instance-attribute
room_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomID'})
Pointer to the room record.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Default tariff rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Unique ID for this room space record.
class-attribute
instance-attribute
room_space_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceTypeEnum'})
Room space type.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SortOrder'})
Use to control where the room space is shown when part of a list.
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
class-attribute
instance-attribute
street2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street2'})
Street
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
class-attribute
instance-attribute
allocate_exclude: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateExclude'})
Room Allocation - Do not include room in allocations.
class-attribute
instance-attribute
allocate_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateSortOrder'})
Room Allocation - Allows allocating nicer rooms first.
class-attribute
instance-attribute
bathrooms: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Bathrooms'})
The number of bathrooms available.
class-attribute
instance-attribute
bed_capacity: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BedCapacity'})
The number of beds available.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Room space comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
The actual room name.
class-attribute
instance-attribute
extension_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtensionID'})
Link to extension table. 0 means no phone in the room.
class-attribute
instance-attribute
Space is held for any reason. Will warn the user when allocating this space.
class-attribute
instance-attribute
networked: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Networked'})
Indicates if the room space is networked.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
room_base_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomBaseID'})
Pointer to the room base record.
class-attribute
instance-attribute
room_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomID'})
Pointer to the room record.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Default tariff rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Unique ID for this room space record.
class-attribute
instance-attribute
room_space_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceTypeEnum'})
Room space type.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SortOrder'})
Use to control where the room space is shown when part of a list.
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
class-attribute
instance-attribute
street2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street2'})
Street
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
class-attribute
instance-attribute
allocate_exclude: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateExclude'})
Room Allocation - Do not include room in allocations.
class-attribute
instance-attribute
allocate_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateSortOrder'})
Room Allocation - allows allocating nicer rooms first.
class-attribute
instance-attribute
bathrooms: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Bathrooms'})
The number of bathrooms available.
class-attribute
instance-attribute
bed_capacity: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BedCapacity'})
The number of beds available.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Room space comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
The actual room name.
class-attribute
instance-attribute
extension_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExtensionID'})
Link to extension table. 0 means no phone in the room.
class-attribute
instance-attribute
Space is held for any reason. Will warn the user when allocating this space.
class-attribute
instance-attribute
networked: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Networked'})
Indicates if the room space is networked.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
room_base_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomBaseID'})
Pointer to the room base record.
class-attribute
instance-attribute
room_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomID'})
Pointer to the room record.
class-attribute
instance-attribute
room_rate_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomRateID'})
Default tariff rate.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Unique ID for this room space record.
class-attribute
instance-attribute
room_space_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceTypeEnum'})
Room space type.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SortOrder'})
Use to control where the room space is shown when part of a list.
class-attribute
instance-attribute
street: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street'})
Street
class-attribute
instance-attribute
street2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Street2'})
Street
dataclass
SelectRoomLocationInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
allocate_sort_order: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AllocateSortOrder'})
Allocate sort order.
class-attribute
instance-attribute
category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CategoryID'})
Pointer to the category record.
class-attribute
instance-attribute
City
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Room location comments.
class-attribute
instance-attribute
country_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CountryID'})
Pointer to the country record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom boolean field value.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom boolean field value.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string field value.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string field value.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string field value.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string field value.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string field value.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string field value.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Room location description.
class-attribute
instance-attribute
gender_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GenderTypeEnum'})
Gender type suitability.
class-attribute
instance-attribute
lease: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Lease'})
Indicates if the room location is leased.
class-attribute
instance-attribute
managed_externally: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ManagedExternally'})
Indicates if the room location is managed externally.
class-attribute
instance-attribute
non_residential: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NonResidential'})
Indicates if the room location is non residential.
class-attribute
instance-attribute
record_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecordTypeEnum'})
Record type.
class-attribute
instance-attribute
room_location_area_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationAreaID'})
Pointer to the room location area record.
class-attribute
instance-attribute
room_location_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomLocationID'})
Unique ID for this room location record.
class-attribute
instance-attribute
state_province: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StateProvince'})
State/Province
class-attribute
instance-attribute
view_on_web: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ViewOnWeb'})
Indicates if the room space is viewable on the web.
class-attribute
instance-attribute
web_comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebComments'})
Comments to display if visible on the web.
class-attribute
instance-attribute
web_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebDescription'})
Description to display if visible on the web.
class-attribute
instance-attribute
web_image_alt_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebImageAltText'})
Alternate text to display for the image when displayed on the web.
dataclass
SelectTransactionInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Amount'})
The total amount for this transaction (including tax).
class-attribute
instance-attribute
call_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CallTypeEnum'})
Call type.
class-attribute
instance-attribute
charge_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeGroupID'})
Pointer to the charge group record.
class-attribute
instance-attribute
charge_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeItemID'})
Pointer to the charge item record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Transaction comments.
class-attribute
instance-attribute
created_by_security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedBy_SecurityUserID'})
Pointer to the created by security user record.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Transaction description.
class-attribute
instance-attribute
duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Duration'})
Phone call duration in seconds.
class-attribute
instance-attribute
end_of_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndOfSessionID'})
Pointer to the end of session record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Excess amount.
class-attribute
instance-attribute
extension: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Extension'})
Extension qty.
class-attribute
instance-attribute
external_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalID'})
Stores the (unique) ID from an external system - for imported transactions.
class-attribute
instance-attribute
external_receipt_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalReceiptID'})
Pointer to the external receipt record.
class-attribute
instance-attribute
invoice_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InvoiceID'})
Pointer to the invoice record.
class-attribute
instance-attribute
payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaymentID'})
Pointer to the payment record.
class-attribute
instance-attribute
reference_booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference_BookingID'})
The booking (if any) that this transaction relates to.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
table_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableID'})
Link to a referencing record (e.g. a BookingID for pro-rating).
class-attribute
instance-attribute
table_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableName'})
Reference link table.
class-attribute
instance-attribute
Transaction tag.
class-attribute
instance-attribute
tag_finance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TagFinance'})
Finance tag.
class-attribute
instance-attribute
tax_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount'})
Tax amount
class-attribute
instance-attribute
tax_amount2: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount2'})
Tax amount
class-attribute
instance-attribute
tax_amount3: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount3'})
Tax amount
class-attribute
instance-attribute
term_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermSessionID'})
Pointer to the term session record.
dataclass
CreateTransactionInput(amount: float, charge_group_id: int, *, call_type_enum: Optional[str] = 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
class-attribute
instance-attribute
The total amount for this transaction (including tax).
class-attribute
instance-attribute
call_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CallTypeEnum'})
Call type.
class-attribute
instance-attribute
Pointer to the charge group record.
class-attribute
instance-attribute
charge_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeItemID'})
This is only required for Adjustments and Charges.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Transaction comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Transaction description.
class-attribute
instance-attribute
due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DueDate'})
Due date.
class-attribute
instance-attribute
duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Duration'})
Phone call duration in seconds.
class-attribute
instance-attribute
end_of_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndOfSessionID'})
Pointer to the end of session record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Excess amount.
class-attribute
instance-attribute
extension: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Extension'})
Extension qty.
class-attribute
instance-attribute
external_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalID'})
Stores the (unique) ID from an external system - for imported transactions.
class-attribute
instance-attribute
external_receipt_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalReceiptID'})
Pointer to the external receipt record.
class-attribute
instance-attribute
invoice_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InvoiceID'})
Pointer to the invoice record.
class-attribute
instance-attribute
paid_from: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidFrom'})
Paid from date.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Paid to date.
class-attribute
instance-attribute
payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaymentID'})
Pointer to the payment record.
class-attribute
instance-attribute
processed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProcessedDate'})
Date transaction was processed.
class-attribute
instance-attribute
reference_booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference_BookingID'})
The booking (if any) that this transaction relates to.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
table_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableID'})
Link to a referencing record (e.g. a BookingID for pro-rating).
class-attribute
instance-attribute
table_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableName'})
Reference link table.
class-attribute
instance-attribute
Transaction tag.
class-attribute
instance-attribute
tag_finance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TagFinance'})
Finance tag.
class-attribute
instance-attribute
tax_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount'})
Tax amount
class-attribute
instance-attribute
tax_amount2: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount2'})
Tax amount
class-attribute
instance-attribute
tax_amount3: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount3'})
Tax amount
class-attribute
instance-attribute
term_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermSessionID'})
Pointer to the term session record.
class-attribute
instance-attribute
transaction_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TransactionDate'})
Date of the transaction.
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
class-attribute
instance-attribute
amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Amount'})
The total amount for this transaction (including tax).
class-attribute
instance-attribute
call_type_enum: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CallTypeEnum'})
Call type.
class-attribute
instance-attribute
charge_group_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeGroupID'})
Pointer to the charge group record.
class-attribute
instance-attribute
charge_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeItemID'})
Pointer to the charge item record.
class-attribute
instance-attribute
comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})
Transaction comments.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Transaction description.
class-attribute
instance-attribute
due_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DueDate'})
Due date.
class-attribute
instance-attribute
duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Duration'})
Phone call duration in seconds.
class-attribute
instance-attribute
end_of_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndOfSessionID'})
Pointer to the end of session record.
class-attribute
instance-attribute
entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EntryID'})
Pointer to the entry record.
class-attribute
instance-attribute
excess: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Excess'})
Excess amount.
class-attribute
instance-attribute
extension: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Extension'})
Extension qty.
class-attribute
instance-attribute
external_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalID'})
Stores the (unique) ID from an external system - for imported transactions.
class-attribute
instance-attribute
external_receipt_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExternalReceiptID'})
Pointer to the external receipt record.
class-attribute
instance-attribute
invoice_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InvoiceID'})
Pointer to the invoice record.
class-attribute
instance-attribute
paid_from: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidFrom'})
Paid from date.
class-attribute
instance-attribute
paid_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaidTo'})
Paid to date.
class-attribute
instance-attribute
payment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PaymentID'})
Pointer to the payment record.
class-attribute
instance-attribute
processed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProcessedDate'})
Date transaction was processed.
class-attribute
instance-attribute
reference_booking_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reference_BookingID'})
The booking (if any) that this transaction relates to.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
table_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableID'})
Link to a referencing record (e.g. a BookingID for pro-rating).
class-attribute
instance-attribute
table_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableName'})
Reference link table.
class-attribute
instance-attribute
Transaction tag.
class-attribute
instance-attribute
tag_finance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TagFinance'})
Finance tag.
class-attribute
instance-attribute
tax_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount'})
Tax amount
class-attribute
instance-attribute
tax_amount2: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount2'})
Tax amount
class-attribute
instance-attribute
tax_amount3: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaxAmount3'})
Tax amount
class-attribute
instance-attribute
term_session_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TermSessionID'})
Pointer to the term session record.
class-attribute
instance-attribute
transaction_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TransactionDate'})
Date of the transaction.
dataclass
SelectRoomSpaceMaintenanceInput(page_size: int, page_index: int, *, return_empty_array_on_no_result: Optional[bool] = 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
class-attribute
instance-attribute
return_empty_array_on_no_result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_returnEmptyArrayOnNoResult'})
Determines whether an empty array should be returned when there is no result.
class-attribute
instance-attribute
Maximum number of records to return.
class-attribute
instance-attribute
Index of the first record to return.
class-attribute
instance-attribute
orderby: Optional[str] = dataclass_field(default=None, kw_only=True, 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).
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
Cause.
class-attribute
instance-attribute
charge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge'})
Indicates if a charge should be applied.
class-attribute
instance-attribute
charge_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge_EntryID'})
Pointer to the charge entry record.
class-attribute
instance-attribute
charge_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeAmount'})
Charge amount.
class-attribute
instance-attribute
charge_invoiced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiced'})
Indicates if the charge has been invoiced.
class-attribute
instance-attribute
charge_invoice_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiceNumber'})
Charge invoice number.
class-attribute
instance-attribute
charge_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeType'})
Charge type.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
contractor_cost: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCost'})
Contractor cost.
class-attribute
instance-attribute
contractor_cost_estimate: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCostEstimate'})
Contractor cost estimate.
class-attribute
instance-attribute
contractor_e_t_a: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorETA'})
Contractor ETA.
class-attribute
instance-attribute
contractor_order_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorOrderNumber'})
Contractor order number.
class-attribute
instance-attribute
created_by_security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedBy_SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom bit 1.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom bit 2.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string 1.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string 2.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string 3.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string 4.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string 5.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string 6.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Description.
class-attribute
instance-attribute
job_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobSent'})
Indicates if a job has been sent.
class-attribute
instance-attribute
job_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobStatus'})
Job status.
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location.
class-attribute
instance-attribute
occupant_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupant_EntryID'})
Pointer to the occupant entry record.
class-attribute
instance-attribute
occupant_entry_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantEntryName'})
Occupant entry name.
class-attribute
instance-attribute
occupant_present: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresent'})
Indicates if an occupant is present.
class-attribute
instance-attribute
occupant_present_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresentReason'})
Occupant present reason.
class-attribute
instance-attribute
other_service_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OtherServiceNumber'})
Other service number.
class-attribute
instance-attribute
priority_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PriorityID'})
Pointer to the priority record.
class-attribute
instance-attribute
repair_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RepairDescription'})
Repair description.
class-attribute
instance-attribute
reported_by_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByName'})
Reported by name.
class-attribute
instance-attribute
reported_by_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByPhone'})
Reported by phone.
class-attribute
instance-attribute
room_space_closed_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceClosedID'})
Pointer to the room space closed record.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_space_maintenance_category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})
Pointer to the room space maintenance category record.
class-attribute
instance-attribute
room_space_maintenance_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceID'})
Unique ID for this room space maintenance record.
class-attribute
instance-attribute
room_space_maintenance_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})
Pointer to the room space maintenance item record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})
Status.
dataclass
CreateRoomSpaceMaintenanceInput(room_space_id: int, *, 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_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
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
Cause.
class-attribute
instance-attribute
charge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge'})
Indicates if a charge should be applied.
class-attribute
instance-attribute
charge_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge_EntryID'})
Pointer to the charge entry record.
class-attribute
instance-attribute
charge_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeAmount'})
Charge amount.
class-attribute
instance-attribute
charge_invoiced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiced'})
Indicates if the charge has been invoiced.
class-attribute
instance-attribute
charge_invoice_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiceNumber'})
Charge invoice number.
class-attribute
instance-attribute
charge_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeType'})
Charge type.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Complete date.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
contract_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDate'})
Contract date.
class-attribute
instance-attribute
contractor_cost: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCost'})
Contractor cost.
class-attribute
instance-attribute
contractor_cost_estimate: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCostEstimate'})
Contractor cost estimate.
class-attribute
instance-attribute
contractor_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorDate'})
Contractor date.
class-attribute
instance-attribute
contractor_e_t_a: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorETA'})
Contractor ETA.
class-attribute
instance-attribute
contractor_order_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorOrderNumber'})
Contractor order number.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom bit 1.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom bit 2.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date 1.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date 2.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string 1.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string 2.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string 3.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string 4.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string 5.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string 6.
class-attribute
instance-attribute
date_due: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateDue'})
Date due.
class-attribute
instance-attribute
date_reported: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateReported'})
Date reported.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Description.
class-attribute
instance-attribute
job_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobSent'})
Indicates if a job has been sent.
class-attribute
instance-attribute
job_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobStatus'})
Job status.
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location.
class-attribute
instance-attribute
occupant_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupant_EntryID'})
Pointer to the occupant entry record.
class-attribute
instance-attribute
occupant_entry_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantEntryName'})
Occupant entry name.
class-attribute
instance-attribute
occupant_present: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresent'})
Indicates if an occupant is present.
class-attribute
instance-attribute
occupant_present_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresentReason'})
Occupant present reason.
class-attribute
instance-attribute
other_service_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OtherServiceNumber'})
Other service number.
class-attribute
instance-attribute
priority_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PriorityID'})
Pointer to the priority record.
class-attribute
instance-attribute
repair_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RepairDescription'})
Repair description.
class-attribute
instance-attribute
reported_by_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByName'})
Reported by name.
class-attribute
instance-attribute
reported_by_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByPhone'})
Reported by phone.
class-attribute
instance-attribute
room_space_closed_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceClosedID'})
Pointer to the room space closed record.
class-attribute
instance-attribute
Pointer to the room space record.
class-attribute
instance-attribute
room_space_maintenance_category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})
Pointer to the room space maintenance category record.
class-attribute
instance-attribute
room_space_maintenance_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceID'})
Unique ID for this room space maintenance record.
class-attribute
instance-attribute
room_space_maintenance_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})
Pointer to the room space maintenance item record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDate'})
Start date.
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})
Status.
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
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
Cause.
class-attribute
instance-attribute
charge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge'})
Indicates if a charge should be applied.
class-attribute
instance-attribute
charge_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge_EntryID'})
Pointer to the charge entry record.
class-attribute
instance-attribute
charge_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeAmount'})
Charge amount.
class-attribute
instance-attribute
charge_invoiced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiced'})
Indicates if the charge has been invoiced.
class-attribute
instance-attribute
charge_invoice_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiceNumber'})
Charge invoice number.
class-attribute
instance-attribute
charge_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeType'})
Charge type.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Complete date.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
contract_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDate'})
Contract date.
class-attribute
instance-attribute
contractor_cost: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCost'})
Contractor cost.
class-attribute
instance-attribute
contractor_cost_estimate: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCostEstimate'})
Contractor cost estimate.
class-attribute
instance-attribute
contractor_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorDate'})
Contractor date.
class-attribute
instance-attribute
contractor_e_t_a: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorETA'})
Contractor ETA.
class-attribute
instance-attribute
contractor_order_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorOrderNumber'})
Contractor order number.
class-attribute
instance-attribute
created_by_security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedBy_SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom bit 1.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom bit 2.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date 1.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date 2.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string 1.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string 2.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string 3.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string 4.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string 5.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string 6.
class-attribute
instance-attribute
date_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateCreated'})
Date created.
class-attribute
instance-attribute
date_due: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateDue'})
Date due.
class-attribute
instance-attribute
date_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModified'})
Date modified.
class-attribute
instance-attribute
date_reported: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateReported'})
Date reported.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Description.
class-attribute
instance-attribute
job_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobSent'})
Indicates if a job has been sent.
class-attribute
instance-attribute
job_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobStatus'})
Job status.
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location.
class-attribute
instance-attribute
occupant_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupant_EntryID'})
Pointer to the occupant entry record.
class-attribute
instance-attribute
occupant_entry_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantEntryName'})
Occupant entry name.
class-attribute
instance-attribute
occupant_present: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresent'})
Indicates if an occupant is present.
class-attribute
instance-attribute
occupant_present_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresentReason'})
Occupant present reason.
class-attribute
instance-attribute
other_service_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OtherServiceNumber'})
Other service number.
class-attribute
instance-attribute
priority_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PriorityID'})
Pointer to the priority record.
class-attribute
instance-attribute
repair_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RepairDescription'})
Repair description.
class-attribute
instance-attribute
reported_by_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByName'})
Reported by name.
class-attribute
instance-attribute
reported_by_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByPhone'})
Reported by phone.
class-attribute
instance-attribute
room_space_closed_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceClosedID'})
Pointer to the room space closed record.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_space_maintenance_category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})
Pointer to the room space maintenance category record.
class-attribute
instance-attribute
room_space_maintenance_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceID'})
Unique ID for this room space maintenance record.
class-attribute
instance-attribute
room_space_maintenance_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})
Pointer to the room space maintenance item record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDate'})
Start date.
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})
Status.
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
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
Cause.
class-attribute
instance-attribute
charge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge'})
Indicates if a charge should be applied.
class-attribute
instance-attribute
charge_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge_EntryID'})
Pointer to the charge entry record.
class-attribute
instance-attribute
charge_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeAmount'})
Charge amount.
class-attribute
instance-attribute
charge_invoiced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiced'})
Indicates if the charge has been invoiced.
class-attribute
instance-attribute
charge_invoice_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiceNumber'})
Charge invoice number.
class-attribute
instance-attribute
charge_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeType'})
Charge type.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Complete date.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
contract_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDate'})
Contract date.
class-attribute
instance-attribute
contractor_cost: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCost'})
Contractor cost.
class-attribute
instance-attribute
contractor_cost_estimate: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCostEstimate'})
Contractor cost estimate.
class-attribute
instance-attribute
contractor_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorDate'})
Contractor date.
class-attribute
instance-attribute
contractor_e_t_a: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorETA'})
Contractor ETA.
class-attribute
instance-attribute
contractor_order_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorOrderNumber'})
Contractor order number.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom bit 1.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom bit 2.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date 1.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date 2.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string 1.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string 2.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string 3.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string 4.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string 5.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string 6.
class-attribute
instance-attribute
date_due: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateDue'})
Date due.
class-attribute
instance-attribute
date_reported: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateReported'})
Date reported.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Description.
class-attribute
instance-attribute
job_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobSent'})
Indicates if a job has been sent.
class-attribute
instance-attribute
job_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobStatus'})
Job status.
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location.
class-attribute
instance-attribute
occupant_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupant_EntryID'})
Pointer to the occupant entry record.
class-attribute
instance-attribute
occupant_entry_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantEntryName'})
Occupant entry name.
class-attribute
instance-attribute
occupant_present: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresent'})
Indicates if an occupant is present.
class-attribute
instance-attribute
occupant_present_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresentReason'})
Occupant present reason.
class-attribute
instance-attribute
other_service_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OtherServiceNumber'})
Other service number.
class-attribute
instance-attribute
priority_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PriorityID'})
Pointer to the priority record.
class-attribute
instance-attribute
repair_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RepairDescription'})
Repair description.
class-attribute
instance-attribute
reported_by_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByName'})
Reported by name.
class-attribute
instance-attribute
reported_by_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByPhone'})
Reported by phone.
class-attribute
instance-attribute
room_space_closed_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceClosedID'})
Pointer to the room space closed record.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_space_maintenance_category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})
Pointer to the room space maintenance category record.
class-attribute
instance-attribute
room_space_maintenance_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceID'})
Unique ID for this room space maintenance record.
class-attribute
instance-attribute
room_space_maintenance_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})
Pointer to the room space maintenance item record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDate'})
Start date.
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})
Status.
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
class-attribute
instance-attribute
account_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountCode'})
Account code.
class-attribute
instance-attribute
Cause.
class-attribute
instance-attribute
charge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge'})
Indicates if a charge should be applied.
class-attribute
instance-attribute
charge_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Charge_EntryID'})
Pointer to the charge entry record.
class-attribute
instance-attribute
charge_amount: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeAmount'})
Charge amount.
class-attribute
instance-attribute
charge_invoiced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiced'})
Indicates if the charge has been invoiced.
class-attribute
instance-attribute
charge_invoice_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeInvoiceNumber'})
Charge invoice number.
class-attribute
instance-attribute
charge_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChargeType'})
Charge type.
class-attribute
instance-attribute
complete_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompleteDate'})
Complete date.
class-attribute
instance-attribute
contact_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContactID'})
Pointer to the contact record.
class-attribute
instance-attribute
contract_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractDate'})
Contract date.
class-attribute
instance-attribute
contractor_cost: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCost'})
Contractor cost.
class-attribute
instance-attribute
contractor_cost_estimate: Optional[float] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorCostEstimate'})
Contractor cost estimate.
class-attribute
instance-attribute
contractor_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorDate'})
Contractor date.
class-attribute
instance-attribute
contractor_e_t_a: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorETA'})
Contractor ETA.
class-attribute
instance-attribute
contractor_order_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContractorOrderNumber'})
Contractor order number.
class-attribute
instance-attribute
created_by_security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedBy_SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
custom_bit1: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit1'})
Custom bit 1.
class-attribute
instance-attribute
custom_bit2: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomBit2'})
Custom bit 2.
class-attribute
instance-attribute
custom_date1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate1'})
Custom date 1.
class-attribute
instance-attribute
custom_date2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomDate2'})
Custom date 2.
class-attribute
instance-attribute
custom_string1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString1'})
Custom string 1.
class-attribute
instance-attribute
custom_string2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString2'})
Custom string 2.
class-attribute
instance-attribute
custom_string3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString3'})
Custom string 3.
class-attribute
instance-attribute
custom_string4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString4'})
Custom string 4.
class-attribute
instance-attribute
custom_string5: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString5'})
Custom string 5.
class-attribute
instance-attribute
custom_string6: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CustomString6'})
Custom string 6.
class-attribute
instance-attribute
date_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateCreated'})
Date created.
class-attribute
instance-attribute
date_due: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateDue'})
Date due.
class-attribute
instance-attribute
date_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateModified'})
Date modified.
class-attribute
instance-attribute
date_reported: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateReported'})
Date reported.
class-attribute
instance-attribute
description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})
Description.
class-attribute
instance-attribute
job_sent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobSent'})
Indicates if a job has been sent.
class-attribute
instance-attribute
job_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobStatus'})
Job status.
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location.
class-attribute
instance-attribute
occupant_entry_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Occupant_EntryID'})
Pointer to the occupant entry record.
class-attribute
instance-attribute
occupant_entry_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantEntryName'})
Occupant entry name.
class-attribute
instance-attribute
occupant_present: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresent'})
Indicates if an occupant is present.
class-attribute
instance-attribute
occupant_present_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OccupantPresentReason'})
Occupant present reason.
class-attribute
instance-attribute
other_service_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OtherServiceNumber'})
Other service number.
class-attribute
instance-attribute
priority_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PriorityID'})
Pointer to the priority record.
class-attribute
instance-attribute
repair_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RepairDescription'})
Repair description.
class-attribute
instance-attribute
reported_by_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByName'})
Reported by name.
class-attribute
instance-attribute
reported_by_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReportedByPhone'})
Reported by phone.
class-attribute
instance-attribute
room_space_closed_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceClosedID'})
Pointer to the room space closed record.
class-attribute
instance-attribute
room_space_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceID'})
Pointer to the room space record.
class-attribute
instance-attribute
room_space_maintenance_category_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceCategoryID'})
Pointer to the room space maintenance category record.
class-attribute
instance-attribute
room_space_maintenance_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceID'})
Unique ID for this room space maintenance record.
class-attribute
instance-attribute
room_space_maintenance_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RoomSpaceMaintenanceItemID'})
Pointer to the room space maintenance item record.
class-attribute
instance-attribute
security_user_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SecurityUserID'})
Pointer to the security user record.
class-attribute
instance-attribute
start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDate'})
Start date.
class-attribute
instance-attribute
status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})
Status.
Starrezrestv1Client(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_select_entry(input: SelectEntryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry
Retrieves one or more records from the Entry table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_entry(input: CreateEntryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Entry
Creates a new record in the Entry table.
Swagger operation ID: CreateEntry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateEntryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry(input: UpdateEntryInput | Mapping[str, Any], entry_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry
Updates an existing record in the Entry table.
Swagger operation ID: UpdateEntry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_id
|
int
|
The ID of the Entry record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
delete(table_name: str, row_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete
Deletes a record from the specified table.
Swagger operation ID: Delete.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table_name
|
str
|
Name of the table to delete record from. |
required |
row_id
|
int
|
Row ID. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_entry_custom_field(input: SelectEntryCustomFieldInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry Custom Field
Retrieves one or more records from the Entry Custom Field table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntryCustomField.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryCustomFieldInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry_custom_field(input: UpdateEntryCustomFieldInput | Mapping[str, Any], entry_custom_field_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry Custom Field
Updates an existing record in the Entry Custom Field table.
Swagger operation ID: UpdateEntryCustomField.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryCustomFieldInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_custom_field_id
|
int
|
The ID of the Entry Custom Field record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_term(input: SelectTermInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Term
Retrieves one or more records from the Term table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectTerm.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectTermInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_entry_address(input: SelectEntryAddressInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry Address
Retrieves one or more records from the Entry Address table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntryAddress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryAddressInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry_address(input: UpdateEntryAddressInput | Mapping[str, Any], entry_address_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry Address
Updates an existing record in the Entry Address table.
Swagger operation ID: UpdateEntryAddress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryAddressInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_address_id
|
int
|
The ID of the Entry Address record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_entry_application(input: SelectEntryApplicationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry Application
Retrieves one or more records from the Entry Application table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntryApplication.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryApplicationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_entry_application(input: CreateEntryApplicationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Entry Application
Creates a new record in the Entry Application table.
Swagger operation ID: CreateEntryApplication.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateEntryApplicationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry_application(input: UpdateEntryApplicationInput | Mapping[str, Any], entry_application_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry Application
Updates an existing record in the Entry Application table.
Swagger operation ID: UpdateEntryApplication.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryApplicationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_application_id
|
int
|
The ID of the Entry Application record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_term_session(input: SelectTermSessionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Term Session
Retrieves one or more records from the Term Session table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectTermSession.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectTermSessionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_entry_detail(input: SelectEntryDetailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry Detail
Retrieves one or more records from the Entry Detail table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntryDetail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryDetailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry_detail(input: UpdateEntryDetailInput | Mapping[str, Any], entry_detail_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry Detail
Updates an existing record in the Entry Detail table.
Swagger operation ID: UpdateEntryDetail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryDetailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_detail_id
|
int
|
The ID of the Entry Detail record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_entry_enrollment(input: SelectEntryEnrollmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Entry Enrollment
Retrieves one or more records from the Entry Enrollment table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectEntryEnrollment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectEntryEnrollmentInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_entry_enrollment(input: CreateEntryEnrollmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Entry Enrollment
Creates a new record in the Entry Enrollment table.
Swagger operation ID: CreateEntryEnrollment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateEntryEnrollmentInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_entry_enrollment(input: UpdateEntryEnrollmentInput | Mapping[str, Any], entry_enrollment_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Entry Enrollment
Updates an existing record in the Entry Enrollment table.
Swagger operation ID: UpdateEntryEnrollment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEntryEnrollmentInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
entry_enrollment_id
|
int
|
The ID of the Entry Enrollment record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_booking(input: SelectBookingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Booking
Retrieves one or more records from the Booking table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectBooking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectBookingInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_booking(input: CreateBookingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Booking
Creates a new record in the Booking table.
Swagger operation ID: CreateBooking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateBookingInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_booking(input: UpdateBookingInput | Mapping[str, Any], booking_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Booking
Updates an existing record in the Booking table.
Swagger operation ID: UpdateBooking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateBookingInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
booking_id
|
int
|
The ID of the Booking record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_room_space(input: SelectRoomSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Room Space
Retrieves one or more records from the Room Space table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectRoomSpace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectRoomSpaceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_room_space(input: CreateRoomSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Room Space
Creates a new record in the Room Space table.
Swagger operation ID: CreateRoomSpace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRoomSpaceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_room_location(input: SelectRoomLocationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Room Location
Retrieves one or more records from the Room Location table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectRoomLocation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectRoomLocationInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_transaction(input: SelectTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Transaction
Retrieves one or more records from the Transaction table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectTransaction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectTransactionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_transaction(input: CreateTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Transaction
Creates a new record in the Transaction table.
Swagger operation ID: CreateTransaction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTransactionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_select_room_space_maintenance(input: SelectRoomSpaceMaintenanceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Room Space Maintenance
Retrieves one or more records from the Room Space Maintenance table.
Returns a single-page Azure Core async collection.
Swagger operation ID: SelectRoomSpaceMaintenance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SelectRoomSpaceMaintenanceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_room_space_maintenance(input: CreateRoomSpaceMaintenanceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Room Space Maintenance
Creates a new record in the Room Space Maintenance table.
Swagger operation ID: CreateRoomSpaceMaintenance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRoomSpaceMaintenanceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_room_space_maintenance(input: UpdateRoomSpaceMaintenanceInput | Mapping[str, Any], room_space_maintenance_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Room Space Maintenance
Updates an existing record in the Room Space Maintenance table.
Swagger operation ID: UpdateRoomSpaceMaintenance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateRoomSpaceMaintenanceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
room_space_maintenance_id
|
int
|
The ID of the Room Space Maintenance record to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |