Structure
Field | Type | Required | Description |
---|---|---|---|
id | true | ||
documentType | DocumentType | true | Type of document |
documentNumber | String | true | Identificative number of the document of the guest. |
givenName | String | true | Name of the guest. |
secondSurName | String | true | Second surname of the guest. |
surname | String | true | Surname of the guest. |
genderType | GenderType | true | Gender of the guest. |
birthDate | LocalDate | true | Birth date of the guest as is on the document. |
birthCountryCode | String | true | Birth country of the guest as is on the document. ISO 3166-1 alpha-2 |
birthPlace | String | Name of the city/town where the guest was born. | |
effectiveDate | LocalDate | true | Date when the document was created. |
expireDate | LocalDate | true | Date when the document expires. |
street | String | true | Street of the residence of the guest as is on the document. |
city | String | true | City of the guest as is on the document. |
stateProvName | String | false | State or province of the guest as is on the document. |
stateProvCode | String | false | ISO 3166-2 |
countryCode | String | false | Country of the guest as is on the document. ISO 3166-1 alpha-2 |
postalCode | String | false | CP of the guest as is on the document. |
nationalityCountryCode | String | false | Country of the nationality of the guest. ISO 3166-1 alpha-2 |
countryOfIssuanceCode | String | false | Country of issuance of the document of the guest. ISO 3166-1 alpha-2 |
ocr | String | false | |
String | false | ||
phoneNumber | String | false | |
allowMarketing | Boolean | true | |
allowThirdParty | Boolean | true | |
language | Language | false | |
registrationNumber | Integer | false | Police registration number. If zero, not have register. |
JSON representation
{ "id": 1, "documentType": { "id": 2, "code": "2", "name": "Passport" }, "documentNumber": "MNZLDtSw", "givenName": "Jeremy", "secondSurName": "Stéphanie", "surName": "Gardner", "genderType": { "id": 2, "code": "F", "name": "Female" }, "birthDate": "2018-04-12T18:13:50.710Z", "birthCountryCode": "ES", "birthPlace": "Waterbury", "effectiveDate": "2018-04-12T18:13:50.710Z", "expireDate": "2018-04-12T18:13:50.710Z", "street": "03 Rusk Park", "city": "Waterbury", "stateProvName": "Barcelona", "stateProvCode": "ES-B", "countryCode": "ES", "postalCode": "6726", "nationalityCountryCode": "ES", "countryOfIssuanceCode": "ES", "ocr": null, "email": "phill8m@usnews.com", "phoneNumber": "1-(203)205-9014", "allowMarketing" :true, "allowThirdParty" :false, "registrationNumber" : 0, "language": { "id": 1, "code": "ES", "name": "Spanish" }, "reservationRoomStayGuestCustomFieldValueSet":[ { "id": null, "code": "SMOKER", "booleanValue": true, "dateValue": null, "name": "Smoker", "numberValue": null, "stringValue": null, "customField": { "id": 1, "code": "SMOKER", "name": "Smoker", "label": "Smoker", "labelI18n": "Smoker", "customFieldType": { "id": 1, "code": "BOOLEAN", "name": "Boolean Values" } } ] }