|
To get a list of pieces in your account, you need to send at least three variables (user_api, account_api, demand) with correct values using the POST method. All the requests must be sent to https://vesica.ws/api/index.php. The demand for requesting piece lists must be "PIECE_LIST".
Following is the sample form for requesting a list of pieces from your account. All the fields in the form are mandatory and must be filled in with correct values.
In addition to the above mandatory variables, the Vesica API provides the following optional variables which can be used to manipulate / filter the results returned by the API.
| Name |
Description |
| keyword |
To display pieces having this value in name or description. |
| refno |
To display pieces having this value in reference number. |
| type |
To display only certain types of pieces. |
| technique |
To display pieces incorporating specific techniques. |
| material |
To display pieces incorporating specific materials. |
| color |
To display pieces incorporating specific colours. |
| artist |
To display pieces related to specified artists. |
| country |
To display pieces related to specified countries. |
| region |
To display pieces related to specified regions. |
| date_created |
To get pieces added on a particular date. Must be in 'Y-m-d' format. For example 2011-12-31. |
| date_last_updated |
To get pieces last updated on a particular date. Must be in 'Y-m-d' format. For example 2011-12-31. |
| origin_year |
To get pieces having a particular origin year. |
| auction_date |
To get pieces with particular auction date. Must be in 'Y-m-d' format. For example 2011-12-31. |
| start |
To specify starting item after which results would be displayed. For example, to skip the first 20 results in your list, you would set this to 20. |
| limit |
To specify number of pieces to display. Can't be greater than 1000. |
If the submitted values are correct, the Vesica API will return the following XML.
.........................
The image returned above will be the thumbnail of the default image associated with the piece(s) returned.
|
Browse Documenation
Introduction to the API
Requesting Piece Lists
Requesting Piece Details
Adding a Piece
Requesting Collections
Requesting Collection Details
Download Sample Templates
|
