Note List [GET]

Operation

Information of the ReservationRoomStay Notes.

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/note

Request

Property	Type	Required	Type parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
propertyId	Integere	false	request parameter		id of the Property
reservationId	Integer	false	request parameter		Id of the Reservation
reservationRoomStayId	Integer	false	request parameter		Id of the Stay
archived	Boolean	false	request parameter		true/false to get the list with/without archived notes.
offset	Integer	false	request parameter	0	Offset of the array of results.
limit	Integer	false	request parameter	10	Limit of results.
sort	string	false	request parameter	id	Property of the entity to sort by.
sortMode	string	false	request parameter	Asc	Mode of sorting.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/note?reservationRoomStayId=7

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	Integer	false	Id of the Note
chainId	Integer	true	Id of the Chain
propertyId	Integer	false	Id of the Property
reservationId	Integer	false	Id of the Reservation
reservationRoomStayId	Integer	false	Id of the Stay
note	String	true	Content of the Note
priorityType	PriorityType	true	priority of the Note
archiveDate	LocalDateTime	false	date of the note archive

Example response

{
    "count": 3,
    "offset": 0,
    "limit": 10,
    "list": [
        {
            "id": 4,
            "chainId": 1,
            "propertyId": 2,
            "reservationId": null,
            "reservationRoomStayId": 7,
            "note": "This is a note",
            "priorityType": {
                "id": 3,
                "code": "MEDIUM",
                "name": "Medium",
                "nameI18nId": null,
                "nameI18n": null,
                "colorCode": "#546E7A",
                "order": 2
            },
            "archiveDate": null,
            "archiveByUser": null,
            "userName": "Administrator"
        }...