Page last modified 21:06, 26 Jul 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > GET:site/services
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Retrieve list of services.
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| limit | string? | Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100) |
| offset | int? | Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0) |
| sortby | {description, type, init, sid, uri}? | Sort field. Prefix value with '-' to sort descending. default: No sorting |
| type | {auth, ext}? | Return only these types of services. Default: Return all |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | MindTouch API key or Administrator access is required. |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<services count="{int}" href="{uri}">
<service id="{int}" href="{uri}">
<sid>{sid}</sid>
<uri>{uri}</uri>
<type>{auth|ext}</type>
<description>{text}</description>
<date.modified>{date}</date.modified>
<status>{enabled|disabled}</status>
<init>{local/remote}</init>
<lasterror>{text}</lasterror>
<config>
<value key="{text}">{text}</value>
...
</config>
<preferences>
<value key="{text}">{text}</value>
...
</preferences>
</service>
</services>
Implementation Notes
Refer here for more information about Dream services.
Refer to the feature POST:site/services for details about the message contents.
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by