Membership Company Settings - Huddle/huddle-apis GitHub Wiki

Summary

The Company Settings API allows company managers to enable or disable company settings for the company

Operations

Retrieve the settings

As a company manager, I can get the settings of my company.

XML Example

In this example we are asking for the settings from the company with id 123

Request

GET /people/companies/123/settings HTTP/1.1
Accept: application/vnd.huddle.data+xml
Authorization: OAuth2 frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<companysettings>
  <link rel="self" href="..." />
  <link rel="parent" href="..." />
  <link rel="edit" href="..." />  
  <settings>
    <setting>
      <name>MobilePin</name>
      <enabled>true</enabled>
    </setting>
   </settings>
</companysettings>

JSON Example

In this example we are asking for a company's mobile pin setting whilst specifying json in the accept header.

Request

GET /people/companies/123/settings HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: OAuth2 frootymcnooty/vonbootycherooty

Response

{
  "links" : [
    { "rel": "self", "href": "..."},
    { "rel": "parent", "href": "..."},
    { "rel": "edit", "href": "..."}
  ],
  "settings" : [
    {
      "name" : "MobilePin",
      "enabled" : "true"
    }
}

Link relations

Name Description Methods
self The current URI of this company's settings GET
parent The URI of the company GET
edit The URI to update the settings for the company PUT

Other Responses

Case Response
401 Unauthorized Invalid authorization token
404 Not Found Not a company manager
404 Not Found Company does not exist
⚠️ **GitHub.com Fallback** ⚠️