/
List of Properties [GET]

List of Properties [GET]

Owned by Jordi Artal
Last updated: Nov 23, 2020

Operation

This endpoint will give as a result a list of Propierties a user has access.

GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/user


Request


PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter0Unique identificator of the chain.
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter0Limit of results.
sortstringfalserequest parameter0Property of the entity to sort by.
sortModestringfalserequest parameter0Mode of sorting.
searchstringfalserequest parameter0search parameter

Example request

GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/user


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId
codestringtrueCode
namestringtrueName
remarkstringtrue
colorCodestringtrue
activebooleantrue
inactiveReasonstringtrue
propertyClassTypeRatingPropertyClassTypeRatingfalse
propertyAddressPropertyAdressfalse
propertyPhonePropertyPhonefalse
propertyEmailPropertyEmailfalse
chainPropertyGroupListChainPropertyGroupfalse

Example response

{
  "count": 2,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 1,
      "code": "EMP",
      "name": "Empty Property",
      "remark": null,
      "colorCode": null,
      "active": true,
      "inactiveReason": null,
      "propertyClassTypeRating": null,
      "propertyAddress": null,
      "propertyPhone": null,
      "propertyEmail": null
    },
    {
      "id": 2,
      "code": "ALI",
      "name": "Hotel Alicante",
      "remark": null,
      "colorCode": "#7CB342",
      "active": true,
      "inactiveReason": null,
      "propertyClassTypeRating": {
        "id": 6,
        "code": "13S",
        "name": "3 *** S",
        "nameI18n": "3 *** S",
        "propertyClassType": {
          "id": 1,
          "code": "1",
          "name": "Hotel",
          "nameI18n": "Hotel"
        }
      },
      "propertyAddress": {
        "id": 1,
        "primary": false,
        "street": "0 Thierer Road",
        "city": "Saint Louis",
        "stateProvName": "Cáceres",
        "postalCode": "63169",
        "country": {
          "id": 199,
          "code": "ESP",
          "name": "SPAIN",
          "nameI18n": "SPAIN"
        },
        "remark": null
      },
      "propertyPhone": {
        "id": 1,
        "primary": false,
        "countryAccessCode": "+34",
        "areaCityCode": "B",
        "phoneNumber": "1-(314)251-2150",
        "extension": "1",
        "remark": null
      },
      "propertyEmail": {
        "id": 1,
        "primary": false,
        "email": "cweaverip@usgs.gov",
        "remark": null
      }
    },
  ...
  ]
}

Related content