|
To get details regarding a specific piece, you need to send the "id" of that particular piece along with the
other mandatory variables to the Vesica API. All the requests must be sent to
http://vesica.ws/api/index.php. The demand for requesting piece lists must be "PIECE_DETAIL".
Following is the sample form for requesting piece details from your account. All the fields in the form
are mandatory and must be filled in with correct values.
<form method="post" action="http://vesica.ws/api/index.php">
<input type="hidden" name="user_api" value="your-user-api-key" />
<input type="hidden" name="account_api" value="your-account-api-key" />
<input type="hidden" name="demand" value="PIECE_DETAIL" />
<input type="hidden" name="id" value="id-of-piece" />
</form>
In addition to the above mentioned mandatory variables, Vesica provides the following optional variable which
can be used by the users to manipulate the results returned by Vesica API.
| Name |
Description |
| imgonly |
Can have only two values i.e. 0 or 1. If set to 1, then Vesica API would
return only the images related with the piece. If not sent or set to 0, the API would send complete
details regarding the piece. |
If the submitted values are correct and imgonly is not sent or set to 0, the Vesica API will return the following XML.
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<piece>
<id></id>
<image>
<name></name>
<description></description>
<url></url>
<default></default>
</image>
<image>
<name></name>
<description></description>
<url></url>
<default></default>
</image>
.........................
<name></name>
<status></status>
<owner></owner>
<description></description>
<symbolism></symbolism>
<country_origin></country_origin>
<area_origin></area_origin>
<length></length>
<width></width>
<height></height>
<history></history>
</piece>
</response>
If the submitted values are correct and imgonly is set to 1, the Vesica API will return the following XML.
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<piece>
<id></id>
<image>
<name></name>
<description></description>
<url></url>
<default></default>
</image>
<image>
<name></name>
<description></description>
<url></url>
<default></default>
</image>
.........................
</piece>
</response>
|
