Property Listing

Retrieves the list of Properties created by PMS.

This GET method designed to retrieve all the important details of the properties that are present in the database.

Endpoint

GET

https://connect-sandbox.su-api.com/SUAPI/jservice/pmsproperty

---

Sample Request

To get a list of properties that have already been created, the Property Management System (PMS) needs to send a GET request. This request must include the Authorization (API) Key.

Here's what you need to do:

1. Send a GET Request: The PMS will send a GET request to the specified endpoint.

2. Include the API Key: You must include your unique API Authorization Key in the request header. The body of the request should be empty.

3. Parameters: The request should have an element named "request" and an attribute named "Authorization" in the header.

---

Response

Success

If the authorization gets pass successfully, you retrieve the list of properties with all the details such as property id, property name, and the current status of the property. properties object returns all the listed properties.

properties array

properties array contains all the listed properties as an object with all the details.

property object

propertyid string

Unique id of the property.

---

propertyname string

Name of the property.

---

status string

Current status of the property.

---

roomcount string

Room count in the property.

Sample Success Response

{
  "properties": [
    {
      "propertyid": "11122010",
      "propertyname": "The Rosehotel Motel",
      "status": "Active",
      "roomcount": "13"
    },
    {
      "propertyid": "11122011",
      "propertyname": "Malin House",
      "status": "Active",
      "roomcount": "20"
    },
    {
      "propertyid": "101010",
      "propertyname": "Fake Hotel",
      "status": "Active",
      "roomcount": "15"
    },
    {
      "propertyid": "P103",
      "propertyname": "The Grand Bhagawati",
      "status": "Active",
      "roomcount": "25"
    }
  ]
}

---

Error

You may receive HTTP code 401 Unauthorized Error, if allocated with incorrect API Authorization Key.

Sample Error Response (497)

{
  "Status": "Fail",
  "Errors": {
    "Code": "497",
    "ShortText": "Authorization Required"
  }
}