Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Structure

FieldTypeRequiredDescription
id
true
documentTypeDocumentTypetrueType of document
documentNumberStringtrueIdentificative number of the document of the guest.
givenNameStringtrueName of the guest.
secondSurNameStringtrueSecond surname of the guest.
surnameStringtrueSurname of the guest.

genderType

GenderTypetrueGender of the guest.

birthDate

LocalDatetrueBirth date of the guest as is on the document.
birthCountryCodeStringtrueBirth country of the guest as is on the document. ISO 3166-1 alpha-2
birthPlaceString
Name of the city/town where the guest was born.
effectiveDateLocalDatetrueDate when the document was created.
expireDateLocalDatetrueDate when the document expires.
streetStringtrueStreet of the residence of the guest as is on the document.
cityStringtrueCity of the guest as is on the document.
stateProvNameStringfalseState or province of the guest as is on the document.
stateProvCodeStringfalseISO 3166-2
countryCodeStringfalseCountry of the guest as is on the document. ISO 3166-1 alpha-2
postalCodeStringfalseCP of the guest as is on the document.
nationalityCountryCodeStringfalseCountry of the nationality of the guest. ISO 3166-1 alpha-2
countryOfIssuanceCodeStringfalseCountry of issuance of the document of the guest. ISO 3166-1 alpha-2
ocrStringfalse
emailStringfalse
phoneNumberStringfalse
allowMarketingBooleantrue
allowThirdPartyBooleantrue
languageLanguagefalse
registrationNumberIntegerfalsePolice 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"
                 }
			}
	]
}
  • No labels