Input URL communication test

From ePrize Developers Wiki

API Home Page :: API Debugging

Summary

Basic echo service. PUT an empty message to the resource and the URL {value} will be returned. This is useful for validating URL encoding/decoding and if PUT can be used.

Resource

/v1/{apikey}/test/communication/{value}.{extension}

Valid Methods

PUT

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key

value: value to echo. This will be echoed into the response body.

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 (PUT), with default XML content-type.

Request

Request representation: empty, {value} is passed via resource.

Response

HTTP Status Code: 200 OK

<?xml version="1.0" encoding="UTF-8" ?>
<result ver="1.1">{value}</result>

Example: Communication Test (PUT), with JSON content-type.

Request

Request representation: empty, {value} is passed via resource, add ".json" extension.

Response

HTTP Status Code: 200 OK

{
  "result" : "{value}"
}

Example: Communication Test (PUT), with YAML content-type.

Request

Request representation: empty, {value} is passed via resource, add ".yaml" extension.

Response

HTTP Status Code: 200 OK

--- {value}