com.factset.sdk.FactSetPeople.api.JobHistoryApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetpeople Show documentation
Show all versions of factsetpeople Show documentation
FactSet SDK for Java - factsetpeople
package com.factset.sdk.FactSetPeople.api;
import com.factset.sdk.FactSetPeople.ApiException;
import com.factset.sdk.FactSetPeople.ApiClient;
import com.factset.sdk.FactSetPeople.ApiResponse;
import com.factset.sdk.FactSetPeople.Configuration;
import com.factset.sdk.FactSetPeople.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetPeople.models.ErrorResponse;
import com.factset.sdk.FactSetPeople.models.PeopleJobsRequest;
import com.factset.sdk.FactSetPeople.models.PeopleJobsResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class JobHistoryApi {
private ApiClient apiClient;
public JobHistoryApi() {
this(Configuration.getDefaultApiClient());
}
public JobHistoryApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getPeopleJobsResponseTypeMap = new HashMap();
static {
getPeopleJobsResponseTypeMap.put(200, new GenericType(){});
getPeopleJobsResponseTypeMap.put(400, new GenericType(){});
getPeopleJobsResponseTypeMap.put(401, new GenericType(){});
getPeopleJobsResponseTypeMap.put(403, new GenericType(){});
getPeopleJobsResponseTypeMap.put(415, new GenericType(){});
getPeopleJobsResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getPeopleJobsForListResponseTypeMap = new HashMap();
static {
getPeopleJobsForListResponseTypeMap.put(200, new GenericType(){});
getPeopleJobsForListResponseTypeMap.put(400, new GenericType(){});
getPeopleJobsForListResponseTypeMap.put(401, new GenericType(){});
getPeopleJobsForListResponseTypeMap.put(403, new GenericType(){});
getPeopleJobsForListResponseTypeMap.put(415, new GenericType(){});
getPeopleJobsForListResponseTypeMap.put(500, new GenericType(){});
}
/**
* Get the API client
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API client
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Returns the Job history of the person.
* Returns the `Job` history of the person referenced by the entityId specified in the request.
* @param ids List of FactSet Person Entity identifier. (required)
* @param status Select only Jobs with a certain status primary, active, or inactive. (optional, default to ALL)
* @param level Select the level of detail only main Jobs or include other Jobs at a company. (optional, default to DETAIL)
* @param type Select only Jobs of a certain type board member or employee. (optional, default to ALL)
* @return PeopleJobsResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Array of Job objects. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public PeopleJobsResponse getPeopleJobs(java.util.List ids, String status, String level, String type) throws ApiException {
return getPeopleJobsWithHttpInfo(ids, status, level, type).getData();
}
/**
* Returns the Job history of the person.
* Returns the `Job` history of the person referenced by the entityId specified in the request.
* @param ids List of FactSet Person Entity identifier. (required)
* @param status Select only Jobs with a certain status primary, active, or inactive. (optional, default to ALL)
* @param level Select the level of detail only main Jobs or include other Jobs at a company. (optional, default to DETAIL)
* @param type Select only Jobs of a certain type board member or employee. (optional, default to ALL)
* @return ApiResponse<PeopleJobsResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Array of Job objects. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public ApiResponse getPeopleJobsWithHttpInfo(java.util.List ids, String status, String level, String type) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ids' is set
if (ids == null) {
throw new ApiException(400, "Missing the required parameter 'ids' when calling getPeopleJobs");
}
// create path and map variables
String localVarPath = "/factset-people/v1/jobs";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "ids", ids));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "level", level));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "type", type));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
PeopleJobsResponse
> apiResponse = apiClient.invokeAPI("JobHistoryApi.getPeopleJobs", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getPeopleJobsResponseTypeMap, false);
return apiResponse;
}
/**
* Returns the Job history for the large list of people.
* Returns the `Job` history of the person referenced by the entityId specified in the request.
* @param peopleJobsRequest (required)
* @return PeopleJobsResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Array of Job objects. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public PeopleJobsResponse getPeopleJobsForList(PeopleJobsRequest peopleJobsRequest) throws ApiException {
return getPeopleJobsForListWithHttpInfo(peopleJobsRequest).getData();
}
/**
* Returns the Job history for the large list of people.
* Returns the `Job` history of the person referenced by the entityId specified in the request.
* @param peopleJobsRequest (required)
* @return ApiResponse<PeopleJobsResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Array of Job objects. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public ApiResponse getPeopleJobsForListWithHttpInfo(PeopleJobsRequest peopleJobsRequest) throws ApiException {
Object localVarPostBody = peopleJobsRequest;
// verify the required parameter 'peopleJobsRequest' is set
if (peopleJobsRequest == null) {
throw new ApiException(400, "Missing the required parameter 'peopleJobsRequest' when calling getPeopleJobsForList");
}
// create path and map variables
String localVarPath = "/factset-people/v1/jobs";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
PeopleJobsResponse
> apiResponse = apiClient.invokeAPI("JobHistoryApi.getPeopleJobsForList", localVarPath, "POST", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getPeopleJobsForListResponseTypeMap, false);
return apiResponse;
}
}