Herds Web Service
MethodHerdsIndex
Description
This index method provides an array of CoreOne Herds that match any search criteria provided.
Request (HerdsIndex)

Below are the search criteria that can be used to specify which Herds will be returned. If no search criteria is provided all Herds are returned.

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
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
holding_id

This is an internal CoreOne Holding id. This can be used to display a list of Herds that belong to a specified Premises. This is not a required parameter.

These can be retrieved through using the HoldingsIndex (Method).
xml:int
Response (HerdsIndex_response)

This will return a list of CoreOne Herds along with a summary of each Herd's details.

To get more comprehensive details on a specific CoreOne Herd use the HerdsShow (Method).

Response Body Parameters

NameDescriptionData Type
valueThis is an array which shows the details for each CoreOne Herd returned.ws_herd
Remarks

See Also
All Operations Resource GroupHerds Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.