com.factset.sdk.OpenFactSetPartnersDocuments.api.LinkUpApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openfactsetpartnersdocuments Show documentation
Show all versions of openfactsetpartnersdocuments Show documentation
FactSet SDK for Java - openfactsetpartnersdocuments
package com.factset.sdk.OpenFactSetPartnersDocuments.api;
import com.factset.sdk.OpenFactSetPartnersDocuments.ApiException;
import com.factset.sdk.OpenFactSetPartnersDocuments.ApiClient;
import com.factset.sdk.OpenFactSetPartnersDocuments.ApiResponse;
import com.factset.sdk.OpenFactSetPartnersDocuments.Configuration;
import com.factset.sdk.OpenFactSetPartnersDocuments.Pair;
import javax.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.OpenFactSetPartnersDocuments.models.AuthStatus;
import com.factset.sdk.OpenFactSetPartnersDocuments.models.LinkUpResponse;
import java.time.LocalDate;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class LinkUpApi {
private ApiClient apiClient;
public LinkUpApi() {
this(Configuration.getDefaultApiClient());
}
public LinkUpApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getLinkUpJobListingsResponseTypeMap = new HashMap();
static {
getLinkUpJobListingsResponseTypeMap.put(200, new GenericType(){});
getLinkUpJobListingsResponseTypeMap.put(400, new GenericType(){});
getLinkUpJobListingsResponseTypeMap.put(401, new GenericType(){});
getLinkUpJobListingsResponseTypeMap.put(403, new GenericType(){});
getLinkUpJobListingsResponseTypeMap.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 daily files from Open:FactSet Partner - LinkUp. The LinkUp API provides access to job listings dataset that is sourced directly from employer webistes globally delivered daily.
* Returns the daily files from Open:FactSet Partner - LinkUp. The LinkUp API provides access to job listings dataset that is sourced directly from employer webistes globally delivered daily. **This API is no longer being sold for new clients.**
* @param sort Enables to get the data in ascending or descending order based on startTime. Results are in reverse chronological order if this parameter is not used. (optional, default to -startDate)
* @param paginationLimit Specifies the maximum number of results to return per result. (optional, default to 20)
* @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results. Using this parameter can fetch maximum of first 10000 records. (optional, default to 0)
* @param startDate The earliest date of the LinkUp file the API should fetching for based on fileTimestamp. (optional)
* @param endDate The latest date of the LinkUp file the API should fetching for based on fileTimestamp. (optional)
* @param type Used to provide the full job descriptions when value \"full\" is used for this parameter. (optional, default to delta)
* @return LinkUpResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Download link & metadata for LinkUp data. - 400 Bad request. - 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. - 500 Internal Server Error -
*/
public LinkUpResponse getLinkUpJobListings(String sort, Integer paginationLimit, Integer paginationOffset, LocalDate startDate, LocalDate endDate, String type) throws ApiException {
return getLinkUpJobListingsWithHttpInfo(sort, paginationLimit, paginationOffset, startDate, endDate, type).getData();
}
/**
* Returns the daily files from Open:FactSet Partner - LinkUp. The LinkUp API provides access to job listings dataset that is sourced directly from employer webistes globally delivered daily.
* Returns the daily files from Open:FactSet Partner - LinkUp. The LinkUp API provides access to job listings dataset that is sourced directly from employer webistes globally delivered daily. **This API is no longer being sold for new clients.**
* @param sort Enables to get the data in ascending or descending order based on startTime. Results are in reverse chronological order if this parameter is not used. (optional, default to -startDate)
* @param paginationLimit Specifies the maximum number of results to return per result. (optional, default to 20)
* @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results. Using this parameter can fetch maximum of first 10000 records. (optional, default to 0)
* @param startDate The earliest date of the LinkUp file the API should fetching for based on fileTimestamp. (optional)
* @param endDate The latest date of the LinkUp file the API should fetching for based on fileTimestamp. (optional)
* @param type Used to provide the full job descriptions when value \"full\" is used for this parameter. (optional, default to delta)
* @return ApiResponse<LinkUpResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Download link & metadata for LinkUp data. - 400 Bad request. - 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. - 500 Internal Server Error -
*/
public ApiResponse getLinkUpJobListingsWithHttpInfo(String sort, Integer paginationLimit, Integer paginationOffset, LocalDate startDate, LocalDate endDate, String type) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/linkup/job-listings";
// 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("", "_sort", sort));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationLimit", paginationLimit));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationOffset", paginationOffset));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "startDate", startDate));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "endDate", endDate));
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<
LinkUpResponse
> apiResponse = apiClient.invokeAPI("LinkUpApi.getLinkUpJobListings", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getLinkUpJobListingsResponseTypeMap, false);
return apiResponse;
}
}