Chain Users

Chain users are typically individuals who have the authority to oversee and manage multiple properties or locations within a hotel chain or hospitality group. Chain users typically hold administrative or managerial positions and are responsible for supervising operations, reservations, and other aspects across multiple properties within the same chain or group.

1. Chain ID can be created to link a group of properties together.

2. Chain user associated to a chain ID will automatically have access to all listings linked to the same chain ID.

3. Chain ID can be created or added for property via API or directly via extranet.

4. Chain user must use a different email ID if they are also a Global user.

Endpoint

POST

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

Attributes

Name string (Required)

This field specifies the name of the user.

---

Email email (Required)

This field specifies the email id of the user.

Valid email address required as reset link is triggered to registered email address.

---

Phone array (Required)

This field is an array which has multiple fields such as CountryCode and PhoneNumber.

Phone number of the user which is the combination of the country code and the phone number.

---

CountryCode string (Required)

Country code of the user’s phone number.

Requires a country code.

---

PhoneNumber string (Required)

Phone number of user.

Requires an active phone number (Numeric values only).

---

Status string (Required)

Status of the user whether it’s active or deactive.

This field specifies the user's status. Active status indicates user can access extranet. Inactive remove user's access to Su extranet.

---

Type string (Required)

Type of the user.

This field specifies type of users.There are 2 types of users, Global and Chain.

---

ChainID string (Required)

This field specifies the id of the chain user which cannot be duplicated. It has a unique value.

---

ContactPerson string (Required)

This field specifies the name of the property user to whom the chain user can contact for details if required.

Sample Request

{
  "Name": "Joe Tohma",
  "Email": "[e-mail]",
  "Phone": {
    "CountryCode": "+64",
    "PhoneNumber": "212345678"
  },
  "Status": "Active",
  "Type": "Chain",
  "ChainID": "NZCHAIN001",
  "ContactPerson": "Mark Smith"
}

---

Response

Sample Success Response

{
  "Status": "Success"
}

Error

This error will occur when 'type' of user is not specified in the request.

Sample Error Response (990)

{
  "Status": "Fail",
  "Errors": {
    "Code": "990",
    "ShortText": "User type must be either 'Global' or 'Chain'"
  }
}

Error

This error will occur when valid Email-ID is not passed in the request.

Sample Error Response (989)

{
  "Status": "Fail",
  "Errors": {
    "Code": "989",
    "ShortText": "Enter valid email"
  }
}

Error

This error will occur when valid country code is not passed or if the field is empty in the request.

Sample Error Response (991)

{
  "Status": "Fail",
  "Errors": {
    "Code": "991",
    "ShortText": "Enter valid countrycode"
  }
}

Error

This error will occur when valid phone/contact number is not passed or if the field is empty in the request.

Sample Error Response (988)

{
  "Status": "Fail",
  "Errors": {
    "Code": "988",
    "ShortText": "Enter valid phone number"
  }
}

Error

This error will occur when valid Chain ID is not passed or if the field is empty in the request.

Sample Error Response (995)

{
  "Status": "Fail",
  "Errors": {
    "Code": "995",
    "ShortText": "ChainID should be alpha-numeric and length must be less than 40 characters"
  }
}

Error

This error will occur when valid contact person is not passed or if the field is empty in the request.

Sample Error Response (1008)

{
  "Status": "Fail",
  "Errors": {
    "Code": "1008",
    "ShortText": "Enter ContactPerson"
  }
}