Get People Directory configuration
Get People Directory configuration
OVERVIEW
Overview
Get the configuration options set for a People Directory.
Since v4.7
HTTP Request
GET /api/2/people/<ID>/config
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the people directory to retrieve (Currently must be set to "1" - This allows for future scope of having multiple people directories) |
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response
If no parameter is set, JSON is the default response given. |
"application/xml" |
HTTP Response
Success
HTTP response 200 with People Directory Configuration object
(Example below)
Error
Example HTTP Request & Response
GET http://example.com/context/api/2/people/1/config
JSON Response
{
"title": "Our People",
"permalink": "https://example.com/context/people",
"showuserfields": {
"jobtitle": true,
"department": true,
"organisation": true,
"organisationimage": true,
"street": true,
"city": true,
"country": true,
"specialities": true,
"email": true,
"officephone": true,
"mobilephone": false
},
"filteroption": {
"id": 2,
"name": "Left multi-select"
},
"showfilters": {
"alphabetselector": true,
"jobtitle": true,
"department": true,
"organisation": true,
"location": true,
"specialities": true
},
"layout": {
"id": 3,
"name": "Cards"
},
"defaultordering": {
"id": 1,
"name": "Alphabetically by last name"
},
"noofitemstodisplay": "10",
"totalnoofitems": "100",
"summary": "Welcome to the HighQ People Directory",
"showsummary": true,
"userlangcode": "en_GB",
"defaultlangcode": "en_GB"
}
Thank you
Your review has been submitted.
Comments
0 Comments