Input communication test
From ePrize Developers Wiki
(Difference between revisions)
| Line 23: | Line 23: | ||
|responsecode=200 OK | |responsecode=200 OK | ||
|response={ | |response={ | ||
| - | "result" : {value} | + | "result" : "{value}" |
} | } | ||
}} | }} | ||
Current revision
API Home Page :: API Debugging
Summary
Basic echo service. POST a value to the resource and it will be returned. This is useful for validating POST body encoding/decoding.
Resource
/v1/{apikey}/test/communication.{extension}
Valid Methods
POST
Resource Arguments
Note: resource arguments are always required.
apikey: Your API Key
extension: optional parameter. Default is assumed to be XML. Other options are JSON and Yaml. Note: non-testing resources do not all accept other media type extensions.
Parameters Required
None
Example: Communication Test (POST), with default XML content-type.
Request
value={value}
Response
HTTP Status Code: 200 OK
<?xml version="1.0" encoding="UTF-8" ?> <result ver="1.1">TESTVALUE</result>
Example: Communication Test (POST), with JSON content-type.
Request
value={value}, add ".json" extension to resource
Response
HTTP Status Code: 200 OK
{
"result" : "{value}"
}
Example: Communication Test (POST), with Yaml content-type.
Request
value={value}, add ".yaml" extension to resource
Response
HTTP Status Code: 200 OK
--- {value}
