/api/domains/:id

Modifies the domain specified by ID.

This resource is available only for Global admin or Domain admin.

Resource Information

Resource URL

https://service.belladati.com/api/domains/:id

HTTP Method

POST

Request Parameters

Parameter

Detail

Example
idID of the domain to update.123

data

Form contents to submit in following JSON format:

ParameterDetail
descriptionDomain description
dateFormatDomain date format - default: "M/d/yyyy"
timeFormatDomain time format - default: "h:mm:ss a"
timeZone(Optional) Domain time zone
localeDomain locale - code of supported language
parameters

(Optional) Array containing all additional parameters.

NameDescription

parameter-name

Parameter name

nonAdminUserVisible

(Optional) Boolean flag indicating if the non-admin users are able to view the flag. Default is false


{
  "description": "This is my domain description",
  "dateFormat": "yyyy-MM-dd",
  "timeFormat": "hh:mm:ss",
  "timeZone": "Asia/Hong_Kong",
  "locale": "zh",
  "parameters": [
    {
      "myKey1": "myValue1"
    },
    {
      "myKey2": null
    }
  ]
}

Sample Request / Response

Using curl:

curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" -d "data={\"description\":\"New description\",\"dateFormat\":\"yyyy-MM-dd\"\"timeFormat\":\"hh:mm:ss\"\"locale\":\"cs\"}" https://service.belladati.com/api/domains/123

When the form has been submitted successfully, the server replies with an HTTP status code of 200 and an empty body.


  • No labels