Last modified on December 30, 2013 at 4:19 pm
Overview
Retrieves a specific userfield category with the specified id. The result of this GET request will be a JSON-encoded representation of a userfield category object. The object definition is provided below.
JSON Object Definition
The following is a full definition of all possible properties on the JSON object representing userfield categories. For a more detailed look at this object and its properties, see the Userfield Category Object Reference.
{
"id": "",
"type": "",
"name": "",
"orderIndex": 0,
"createdDate": ""
}
Examples
This example shows the retrieval of a public userfield category. Because it has an orderIndex value of 1, it appears as the second category in the set of public userfield categories.
Request
GET /dc/api/v5/userfieldcategories/b322881a721f0feaedcbc12876a4510e HTTP/1.1 Host: api.digitalchalk.com Accept: application/json
Response
HTTP/1.1 200 OK Content-type: application/json Content-length: 456 { "id": "b322881a721f0feaedcbc12876a4510e", "name": "Biographical Information", "type": "public", "orderIndex": 1, "createdDate": "2009-07-03T23:20:17Z" }