Description
This index method provides an array of CoreOne Animals that match any search criteria provided.
Request (AnimalsIndex)
Below are the search criteria that can be used to specify which Animals will be returned. If no search criteria is provided all Animals are returned.
Request Body Parameters
| Name | Description | Data Type | ||
|---|---|---|---|---|
| token | This is a 40-character hexadecimal string.
| xml:string | ||
| search | This is a space-delimited list of search terms which will be used to filter your search results. If multiple search terms are supplied the search is additive in nature. It is not case sensitive. If omitted, the search defaults to an empty string. | xml:string | ||
| page | Results from this method are paginated; this parameter specifies the page number you wish returned. If omitted, the default page number is 1. | xml:int | ||
| limit | Results from this method are paginated; this parameter specifies the number of items per page that are returned. If omitted, the default limit is 15. This is to prevent mass data extraction. | xml:int |
Response (AnimalsIndex_response)
This will return a list of CoreOne Animals along with a summary of each Animal's details.
 |
To get more comprehensive details on a specific CoreOne Animal use the AnimalsShow (Method). |
Response Body Parameters
| Name | Description | Data Type |
|---|---|---|
| value | This is an array which shows the details for each CoreOne Animal returned. | ws_animal |
Remarks
See Also