People Web Service
MethodPeopleIndexByJob
Description
This index method provides an array of CoreOne People that match any specified job.
Request (PeopleIndexByJob)

Below are the required parameters to successfully return an array of CoreOne People. If any parameter is omitted an error message will be displayed alerting the user.

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
job_id

This is an internal CoreOne Job id. Only people with the same job_id will be returned.

These can be retrieved through using the JobsIndex (Method).
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 (PeopleIndexByJob_response)

This will return a list of CoreOne People along with a summary of each Person's details.

To get more comprehensive details on a specific CoreOne Person use the PeopleShow (Method) or if you wish to obtain a list of People without a specified job_id use the PeopleIndex (Method).

Response Body Parameters

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

See Also
All Operations Resource GroupPeople Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.