The Telligent Evolution Platform APIs are implemented as RESTful services exposed by a custom-built REST engine. Routing is supported via Microsoft's new System.Web.Routing engine, which shipped with Microsoft's ASP.NET MVC project. Our Web services currently support data in POX (Plain Old XML) and JSON. Depending on customer demand, we may support other formats such as ATOM in the future.
Because PUT/DELETE methods are disabled on some Web servers (such as IIS), you must specify a Rest-Method header with these values and an HTTP Method of POST.
/api.ashx/v2/users/1Http Header contains: Rest-Method: PUTHttp Method: POST
/api.ashx/v2/users/1Http Header contains: Rest-Method: DELETEHttp Method: POST
By default, all data types are sent and received as XML. You can also use JSON instead of XML by specifying JSON in your URL: /api.ashx/v2/users/1.json [GET]. This request returns the User resource matching the ID in JSON format. When POSTing with JSON, the POST and the response are in the same format.
The standard date format for REST v2 requests and responses is the ISO format of: yyyy-MM-ddTHH:mm:ss. When using .NET's DateTime.ToString() method there is a shortcut for this format: dateTime.ToString("o").
Currently, the dates in JSON responses are formatted by default using the following: "\/Date(1273255122713-0400)\/" . Beginning with the 5.5.2 release, there is an option on all requests to format dates in the ISO format using the parameter of UseIsoDateFormat. Setting it to true will use the ISO date format. Setting it to false or not setting it will use the older style format. These defaults will remain in place through the 6.0 release. Following the 6.0 release, the default will be changed to use the ISO date format. This will align the standard date formats across Telligent Evolution platform REST v2 Web services.
The Telligent Evolution platform REST v2 Web services framework will parse any valid DateTime input format that the .NET framework DateTime.Parse() method recognizes (if sending data as XML then it has to be a format the XML Serializer recognizes as well). However, we recommend using the ISO date format standard of yyyy-mm-ddThh:mm:ss for consistency across requests and responses.
The following endpoints (resources) are available in the Telligent Evolution platform API:
(n.b. additional endpoints are available through the V1 API)
Only available with Telligent Evolution 5.5
Access to custom profile fields via the ProfileFields node is available only with Telligent Evolution 5.5
Powered by Zimbra