Page last modified 15:59, 1 Feb 2007 by SteveB
Template:Service Description
Table of contents
- 1. Overview
- 2. Data Types
- 3. Features
- 3.1.1. GET:path/
- 3.1.1.1. Query Parameters
- 3.1.1.2. Request Body
- 3.1.1.3. Response
- 3.1.1.4. Version History
- 3.1.1. GET:path/
Assembly: (assembly name)
Class: (class name)
Overview
(provide a short 2-3 sentence description of what the service does)
| Verb:Suffix | Description |
| GET:path1 | (1 sentence description) |
| POST:path2/* | (ditto) |
Data Types
(Describe XML document types by example)
Config
(provide a sample configuration for service which use it)
<config>
<!-- use xml comments to describe entries --!>
...
</config>
Typename
<doc>
<node>
...
</node>
</node>
Features
GET:path/
(Expanded description -or- copy-paste 1 sentence description again; use Feature template to insert more feature descriptions)
Query Parameters
| Name | Type | Description |
| queryarg1 | int | (1 sentence description |
| queryarg2 | text | (1 sentence description |
Request Body
(Description/example of the purpose of the request body)
Response
| Status | Description |
| 200 | (1-3 sentence description of response contents) |
| 203 | (1-3 setnence description of response contents) |
Version History
(OPTIONAL: version history/change log of feature)
- 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