ProgramParticipationsIndex (Method)

Description

This method provides an array of CoreOne Program Participations for a specified entity.

Request (ProgramParticipationsIndex)

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

Request Body Parameters

Name

Description

Data 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

entity_type

This is the type of entity the Program Participation is associated with. For example 0- Premises, 1- Herd etc...

xml:int

entity_id

This is an internal CoreOne id used to uniquely identify the specified record.

These can be obtained through using the respective entity_type Index (Methods)

xml:int

Response (ProgramParticipationsIndex_response)

This will return a list of CoreOne Program Participations along with a summary of each Program Participation's details.

To get more comprehensive details on a specific CoreOne Program Participation use the ProgramParticipationShow (Method).

Response Body Parameters

Name	Description	Data Type
value	This is an array which shows the details for each CoreOne Program Participation returned.	ws_program_participation

Remarks