Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.factset.sdk.FactSetRBICS.api;
import com.factset.sdk.FactSetRBICS.ApiException;
import com.factset.sdk.FactSetRBICS.ApiClient;
import com.factset.sdk.FactSetRBICS.ApiResponse;
import com.factset.sdk.FactSetRBICS.Configuration;
import com.factset.sdk.FactSetRBICS.Pair;
import javax.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetRBICS.models.ErrorResponse;
import com.factset.sdk.FactSetRBICS.models.StructureRequest;
import com.factset.sdk.FactSetRBICS.models.StructureResponse;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class StructureApi {
private ApiClient apiClient;
public StructureApi() {
this(Configuration.getDefaultApiClient());
}
public StructureApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getRbicsStructureResponseTypeMap = new HashMap();
static {
getRbicsStructureResponseTypeMap.put(200, new GenericType(){});
getRbicsStructureResponseTypeMap.put(400, new GenericType(){});
getRbicsStructureResponseTypeMap.put(401, new GenericType(){});
getRbicsStructureResponseTypeMap.put(403, new GenericType(){});
getRbicsStructureResponseTypeMap.put(415, new GenericType(){});
getRbicsStructureResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getRbicsStructureForListResponseTypeMap = new HashMap();
static {
getRbicsStructureForListResponseTypeMap.put(200, new GenericType(){});
getRbicsStructureForListResponseTypeMap.put(400, new GenericType(){});
getRbicsStructureForListResponseTypeMap.put(401, new GenericType(){});
getRbicsStructureForListResponseTypeMap.put(403, new GenericType(){});
getRbicsStructureForListResponseTypeMap.put(415, new GenericType(){});
getRbicsStructureForListResponseTypeMap.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;
}
/**
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.
* Understand the full RBICS Taxonomy Structure through time to help organize your analysis or facilitate the use of RBICS in application development. Designed to overcome disparate and non-standardized company disclosures, the RBICS taxonomy is a normalized global industry classification consisting of a fourteen-by-six matrix. There are twelve economies with two specialty sectors, each with six incremental detailed layers, resulting in over 1,600 sector groups. The top-levels' market-defined approach groups companies based on their behavioral similarities and stock price co-movement, while the patented product-based approach used in the lower levels enables the necessary precision to capture the specialty sectors of global markets.
* @param rbicsIds RBICS Taxonomy Id Filter. Use to lookup the structure details for the Id requested. (optional)
* @param level RBICS industry levels to include in the response. All levels from 1-N will be returned. For example, '3' returns all levels 1,2 and 3. To request all levels, request level=6. Level 1 is returned by default. |Level|Description|Number of Groups| |---|---|---| |1|Economomy|14| |2|Sector|37 |3|Sub-Sector|109| |4|Industry Group|366| |5|Inudstry|901| |6|Sub-Industry|1629| (optional)
* @param includeNames Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. (optional, default to true)
* @param date Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity. (optional)
* @return StructureResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Successful Response producing an array of Entity Focus 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 StructureResponse getRbicsStructure(java.util.List rbicsIds, Integer level, Boolean includeNames, String date) throws ApiException {
return getRbicsStructureWithHttpInfo(rbicsIds, level, includeNames, date).getData();
}
/**
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.
* Understand the full RBICS Taxonomy Structure through time to help organize your analysis or facilitate the use of RBICS in application development. Designed to overcome disparate and non-standardized company disclosures, the RBICS taxonomy is a normalized global industry classification consisting of a fourteen-by-six matrix. There are twelve economies with two specialty sectors, each with six incremental detailed layers, resulting in over 1,600 sector groups. The top-levels' market-defined approach groups companies based on their behavioral similarities and stock price co-movement, while the patented product-based approach used in the lower levels enables the necessary precision to capture the specialty sectors of global markets.
* @param rbicsIds RBICS Taxonomy Id Filter. Use to lookup the structure details for the Id requested. (optional)
* @param level RBICS industry levels to include in the response. All levels from 1-N will be returned. For example, '3' returns all levels 1,2 and 3. To request all levels, request level=6. Level 1 is returned by default. |Level|Description|Number of Groups| |---|---|---| |1|Economomy|14| |2|Sector|37 |3|Sub-Sector|109| |4|Industry Group|366| |5|Inudstry|901| |6|Sub-Industry|1629| (optional)
* @param includeNames Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. (optional, default to true)
* @param date Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity. (optional)
* @return ApiResponse<StructureResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Successful Response producing an array of Entity Focus 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 getRbicsStructureWithHttpInfo(java.util.List rbicsIds, Integer level, Boolean includeNames, String date) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/factset-rbics/v1/structure";
// 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", "rbicsIds", rbicsIds));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "level", level));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "includeNames", includeNames));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "date", date));
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<
StructureResponse
> apiResponse = apiClient.invokeAPI("StructureApi.getRbicsStructure", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getRbicsStructureResponseTypeMap, false);
return apiResponse;
}
/**
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods. POST method is optimal for requesting large lists of `rbicsIds`.
* @param structureRequest Request Body to request a list of RBICS Structure objects. (required)
* @return StructureResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Successful Response producing an array of RBICS Structure 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 StructureResponse getRbicsStructureForList(StructureRequest structureRequest) throws ApiException {
return getRbicsStructureForListWithHttpInfo(structureRequest).getData();
}
/**
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.
* Get the full RBICS Taxonomy Structure Ids, Names, and effective periods. POST method is optimal for requesting large lists of `rbicsIds`.
* @param structureRequest Request Body to request a list of RBICS Structure objects. (required)
* @return ApiResponse<StructureResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Successful Response producing an array of RBICS Structure 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 getRbicsStructureForListWithHttpInfo(StructureRequest structureRequest) throws ApiException {
Object localVarPostBody = structureRequest;
// verify the required parameter 'structureRequest' is set
if (structureRequest == null) {
throw new ApiException(400, "Missing the required parameter 'structureRequest' when calling getRbicsStructureForList");
}
// create path and map variables
String localVarPath = "/factset-rbics/v1/structure";
// 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<
StructureResponse
> apiResponse = apiClient.invokeAPI("StructureApi.getRbicsStructureForList", localVarPath, "POST", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getRbicsStructureForListResponseTypeMap, false);
return apiResponse;
}
}
