WARNING: The TrackAbout MetaWiki has been deprecated and is no longer being updated.
Please visit our new TrackAbout Knowledge Base at https://supportkb.trackabout.com for the most-up-to-date documentation on TrackAbout and TrackAbout Mobile.
Difference between revisions of "Template:Service Standard Params RESTful"
Jump to navigation
Jump to search
Lsilverman (talk | contribs) |
Lsilverman (talk | contribs) |
||
| Line 14: | Line 14: | ||
| Use Encryption | | Use Encryption | ||
| e | | e | ||
| − | | The presence of this parameter enables request and response payload encryption using public/private X.509 certificates. Certificates must be exchanged and configured in advance of using this parameter. This encryption is separate from standard HTTPS/SSL encryption. | + | | The presence of this parameter enables request and response payload encryption using public/private X.509 certificates. Certificates must be exchanged and configured in advance of using this parameter. This encryption is separate from standard HTTPS/SSL encryption. Both can be used together. |
|- | |- | ||
| Use Specific Version | | Use Specific Version | ||
Latest revision as of 16:05, 4 March 2010
Standard Service Parameters
The following standard web service parameters are available for this RESTful web service. These parameters are optionally provided via the querystring of the URL used to access the service.
| Friendly Name | Query String Name | Description |
|---|---|---|
| Retrieve Metadata | meta | When this parameter is provided, the service will return its WADL document instead of doing the normal processing. |
| Use Encryption | e | The presence of this parameter enables request and response payload encryption using public/private X.509 certificates. Certificates must be exchanged and configured in advance of using this parameter. This encryption is separate from standard HTTPS/SSL encryption. Both can be used together. |
| Use Specific Version | vX.X.X | Specifies the version of the service being called. For example, the parameter value 'v2.2.5' specifies that Version 2.2.5 should be used. |
| Use Gzip Compression | gz | Indicates that gzip compression should be used for the response. |
| Use Zip Compression | zip | Indicates that zip compression should be used for the response. |
| Use Bz2 Compression | bz2 | Indicates that bz2 compression should be used for the response. |