PMS REST API
Online documentation
GetProfileRequest
Inheritance: HotelRequestBase
Request for to get profile list by searching criteria
| Property Name | Type | Description |
| ProfileID | long? |
hotel profile id If this value is set then HotelCode should also be set |
| UserID | Guid? |
chain-wide global user id If this value is set then no need a hotelcode and profileID |
| string | Email address of profile | |
| OnlyMembers | bool? | if true, only registered members will be returned |
| FirstName | string | Profile First Name |
| MiddleName | string | Profile Middle Name |
| LastName | string | Profile Last Name |
| NationalityCode | string | Nationality of Profile |
| Gender | Gender ? | Gender of Profile |
| BirthDate | DateRange | Date of Profile's birth |
| MembershipID | string |
Unique id of Profile Not related to parameters MemberShipValue and MemberShipTypeCode |
| LanguageCodes | List<string> | List of languages to filter profiles. |
| Attributes | List< AttributeLink > | List of profile attributes to filter profiles. |
| ReservationCriteria | ProfileByReservationCriteria | Reservation criteria for search profile |
| FillUserID | bool? * [Deprecated] No need to use this property, this is always true now | If false not necessary to fill the user ID |
| PageNumber | int? | Used to page returning record count. This optional property indicates which page to return, default value is 1. |
| PageSize | int? | Used to page returning record count. This optional property indicates the record count of a page, default value is 100, max value is 100000. |
| MemberShipTypeCode | string | Short description of membership types, use with parameter: MemberShipValue |
| MemberShipValue | string | Membership value, use with parameter: MemberShipTypeCode |
| DocumentTypeCode | string |
Short description of Document types, use with parameter: DocumentTypeValue Only for Suite8 |
| DocumentTypeValue | string |
DocumentType value, use with parameter: DocumentTypeCode Only for Suite8 |
| SearchInENG | bool | search in English. its convert turkish char to english |
| SearchAsLike | bool | ? |
| IncludePassiveProfiles | bool |
Only for Suite8 Default = false |
| ExtraNoteCategories | List<string> |
Use to get Notes other then the Notes with Default_Profile_Note_Category only for Suite8 |
| OnlyGuestVisibleNotes | bool? |
if null or true then only guest visible notes returned else all notes returned |
| ModifiedOn | DateRange | Date of Modify |
| ProfileCategory | ProfileCategory ? |
Profile Type (Category) of this profile (eg: Company, Travel agent, Individual). Only for Suite8 |
| PhoneNumber | string | PhoneNumber of profile |
| HotelCode | string | Destination hotel id or code. |
| Language | string | If specified, response will be translated based on the language code. |
| AuthData | AuthData | Request authentication info. If Http header authentication data is specified, this data is overridden |
