Operation

Information of the operation

PUT

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationRoomStay/{reservationRoomStayId}/reservationRoomStayGuest/{reservationRoomStayGuestId}

Request

Property	Type	Required	Type parameter	Description
chainId	Integer	true	path parameter
propertyId	Integer		path parameter
reservationRoomStayId	Integer		path parameter
reservationRoomStayGuestId	Integer		path parameter
fieldNamesList	List<String>		request parameter	List of fields that has to be updated. If we don't receive that object, we update all ReservationRoomStayGuest fields.

Example request

PUT https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/1/reservationRoomStayGuest/1

Body

An array of elements of type ReservationRoomStayGuest.

Field	Type	Required	Description
id	Integer	true	ReservationRoomStay Guest.
profileId	Integer	false	Profile Id.
documentType	DocumentType	true	Type of document
documentNumber	String	true	Identificative number of the document of the guest.
documentSupport	String	false	Identificative number of the support 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.
familyRelationShip	FamilyRelationship		Family Relationship 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
email	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.
reservationRoomStayGuestCustomFieldValueSet	List<ReservationRoomStayGuestCustomFieldValue>	false

Example body

{
	"id": 2,
	"documentType": {
		"id": 2,
		"code": "2",
		"name": "Passport"
	},
	"documentNumber": "swgcACUU",
	"givenName": "Marie",
	"secondSurName": "Mélodie",
	"surName": "Hunt",
	"genderType": {
		"id": 1,
		"code": "M",
		"name": "Male"
	},
	"birthDate": "2002-02-13",
	"birthCountryCode": "VU",
	"birthPlace": "Memphis",
	"effectiveDate": "2019-02-13",
	"expireDate": "2019-02-13",
	"street": "2603 Cherokee Drive",
	"city": "Memphis",
	"stateProvName": "Tennessee",
	"stateProvCode": null,
	"countryCode": "VU",
	"postalCode": "38104",
	"nationalityCountryCode": "VU",
	"countryOfIssuanceCode": "Es",
	"ocr": null,
	"email": "bhernandezo@instagram.com",
	"phoneNumber": "1-(901)206-4293",
    "allowMarketing" :true,
    "allowThirdParty" :false,
    "language": {
        "id": 1,
        "code": "ES",
        "name": "Spanish"
    }
}

Response

A success or error message.

Example response

{
  "httpStatus": "201",
  "userMessage": "Success",
  "technicalMessage": "Success ReservationRoomStay guest updated",
  "errorCode": "0",
  "id": 1	
}

Browser not supported