{
"openapi": "3.0.0",
"info": {
"title": "IIR Industrial Database API",
"version": "2.0",
"description": "# Introduction \nThe information below will help you start using IIR API endpoints, which provide users direct\nmachine-to-machine access to your IIR API data subscription. This document will explain how to \ngenerate a JWT authentication token, which is required to access the API endpoints and the requirements\nfor each API endpoint. Each API endpoint is restricted by the user's subscription coverage and returns\ndata in the JSON format, as defined by the schema associated with each endpoint.\n\n\nWe recommend having an understanding of APIs before attempting to use these endpoints. IIR\ndoes not offer any applications, tools, or programs for using these endpoints. Please feel free to\ncontact us at api@industrialinfo.com if you have any questions.\n",
"termsOfService": "https://www.industrialinfo.com/legaltc.jsp",
"contact": {
"name": "API Support",
"url": "https://www.industrialinfo.com",
"email": "api@industrialinfo.com"
},
"x-logo": {
"url": "iir_logo.png",
"backgroundColor": "#FAFCFA",
"href": "https://www.industrialinfo.com"
}
},
"servers": [
{
"url": "/idb/v2.0",
"description": "IIR Industrial Database API"
}
],
"paths": {
"/token": {
"summary": "Generate Token",
"post": {
"tags": [
"User"
],
"parameters": [
{
"name": "username",
"description": "Enter your login username.",
"schema": {
"type": "string",
"example": "user1"
},
"in": "query",
"required": true
},
{
"name": "password",
"description": "Enter your login password.",
"schema": {
"format": "password",
"type": "string",
"example": "password1"
},
"in": "query",
"required": true
},
{
"name": "tokenLifeTime",
"description": "Enter the number of days for the token life time. By default, it will expire after 1 day. Maximum is 30 days.",
"schema": {
"type": "integer",
"example": 30
},
"in": "query",
"required": false
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"message": "Token Created successfully."
}
}
}
}
},
"description": "Check the Response Headers: for the actual token."
}
},
"operationId": "getToken",
"summary": "Generate Access Token",
"description": "Using the endpoint & parameters below, you can create an API request that can be used in a number of different ways to generate your authentication token. Most importantly, this method is useful for setting up an automated token renewal process. Your token will be supplied via the Authorization header using the Bearer Token schema. For security reasons, tokens are only valid for a limited period. Use the tokenLifeTime parameter to indicate the desired life time of your token (By default, token will expire after 1 day. Maximum is 30 days).\r\n\r\n\r\n\r\nThese are the supported parameters:\r\n"
}
},
"/equipmentTypes": {
"summary": "Equipment Types Reference",
"description": "Equipment Types List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all Equipment Types.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "equipmentTypeId",
"description": "Equipment Type ID. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3
}
},
"in": "query",
"required": false
},
{
"name": "equipmentTypeDesc",
"description": "Equipment Type description. Searching by Equipment Type description can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Heat Exchangers"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of equipment type results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned equipment type results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/equipmentTypesResponse"
},
"examples": {
"equipmentTypesResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"equipmentTypes": [
{
"equipmentTypeId": 2,
"equipmentTypeDesc": "Heaters"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getEquipmentTypes",
"summary": "List of Equipment Types"
}
},
"/hsProducts": {
"summary": "HS Product Reference",
"description": "HS Products List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all HS Products.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "hsProductId",
"description": "HS Product ID. To search by multiple Product IDs, use the same parameter multiple times with different values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 1678
}
},
"in": "query",
"required": false
},
{
"name": "hsProductDesc",
"description": "HS Product description. Searching by the Product description can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Condensate"
}
},
"in": "query",
"required": false
},
{
"name": "sicCode",
"description": "Searching by SIC Code can be done by entering the four-digit SIC code. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 1321
}
},
"in": "query",
"required": false
},
{
"name": "sicCodeDesc",
"description": "Searching by SIC code description can be done using one or multiple keywords. This parameter supports wildcard search.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gas"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of HS Product results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned HS Product results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hsProductResponse"
},
"examples": {
"hsProductsResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"hsProducts": [
{
"hsProductId": "000003",
"hsProductDesc": "Asses, Mules And Hinnies, Live",
"uom": "NO",
"sicCode": "0272",
"sicCodeDesc": "Horses & Other Equine Farms"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getHsProducts",
"summary": "List of HS Products"
}
},
"/pecZones": {
"summary": "PEC Zones Reference",
"description": "PEC Zones List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all PEC Zones.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "pecZoneId",
"description": "Searching by PEC Zone ID can be done by typing in the particular Zone code using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*01"
}
},
"in": "query",
"required": false
},
{
"name": "pecZoneName",
"description": "Searching by PEC Zone name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Abilene"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of PEC Zone results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned PEC Zone results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pecZoneResponse"
},
"examples": {
"pecZonesResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"pecZones": [
{
"pecZoneId": "AH*01",
"pecZoneName": "Tirana"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getPecZones",
"summary": "List of PEC Zones"
}
},
"/sicCodes": {
"summary": "SIC Codes Reference",
"description": "SIC Codes List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all SIC Codes.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "sicCode",
"description": "Searching by SIC Code can be done by entering the four-digit SIC code. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 1321
}
},
"in": "query",
"required": false
},
{
"name": "sicCodeDesc",
"description": "Searching by SIC code description can be done using one or multiple keywords. This parameter supports wildcard search.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gas"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Search for SIC codes associated to a specific industry by simply entering the two-digit industry code. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of SIC code results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned SIC code results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sicCodeResponse"
},
"examples": {
"sicCodeResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"sicCodes": [
{
"sicCode": "4931",
"sicCodeDesc": "Electricity/Steam [IPP]",
"industryCode": "01",
"industryDesc": "Power"
}
]
}
}
}
}
},
"description": ""
}
},
"operationId": "getSicCodes",
"summary": "List of SIC Codes",
"description": ""
}
},
"/sicProducts": {
"summary": "SIC Products Reference",
"description": "SIC Products List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all SIC Products.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "sicProductId",
"description": "Searching by SIC Product ID can be done by entering one or multiple SIC Product IDs. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1311*0008"
}
},
"in": "query",
"required": false
},
{
"name": "sicProductDesc",
"description": "Searching by SIC code description can be done using one or multiple keywords. This parameter supports wildcard search.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural gas"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Search for SIC Products associated to a specific industry by simply entering the two-digit industry code. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of SIC Product results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned SIC Product results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sicProductResponse"
},
"examples": {
"sicProductResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"sicProducts": [
{
"sicProductId": "0273*0003",
"sicProductDesc": "Finfish farms",
"industryCode": "10",
"industryDesc": "Food & Beverage"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getSicProducts",
"summary": "List of SIC Products"
}
},
"/unitTypes": {
"summary": "Unit Types Reference",
"description": "Unit Types List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all Unit Types.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "unitTypeId",
"description": "The Unit Type ID. Each unit is identified by a specific unit type. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 126
}
},
"in": "query",
"required": false
},
{
"name": "unitTypeName",
"description": "The Unit Type description. Searching by Unit Type name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Search for Unit Types associated to a specific industry by simply entering the two-digit industry code. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "05"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of Unit Type results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned Unit Type results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unitTypesResponse"
},
"examples": {
"unitTypesResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"unitTypes": [
{
"unitTypeId": "00005",
"unitTypeName": "Thermal Cracker",
"industryCode": "06",
"industryDesc": "Petroleum Refining (HPI)"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getUnitTypes",
"summary": "List of Unit Types"
}
},
"/projectdurations": {
"summary": "Find Labor Project Duration details by ID",
"description": "Returns Labor Project Duration Details",
"post": {
"tags": [
"Labor Project Duration Search "
],
"parameters": [
{
"name": "projectId",
"description": "The ID of the project. The Project ID is a unique eight-digit number used by IIR that is assigned to an individual project. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"in": "query",
"required": false
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of project duration results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned project duration results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectDurationResponse"
},
"examples": {
"projectDuration": {
"value": {
"limit": 2,
"offset": 0,
"resultCount": 2,
"totalCount": 2,
"projectDuration": [
{
"projectId": 1001549,
"yearMonth": "201403",
"boilermakerHours": "1480.00",
"carpenterHours": "3255.00",
"electricianHours": "5040.00",
"instrumentationHours": "560.00",
"insulatorsHours": "495.00",
"ironworkerHours": "1265.00",
"millwrightHours": "950.00",
"operatorHours": "2440.00",
"paintingHours": "245.00",
"pipefitterHours": "4685.00",
"plumberHours": "585.00",
"rentalHours": "242430.00",
"scaffoldingHours": "2905.00",
"tivUsd": "5000000.00",
"welderHours": "3385.00",
"laborerHours": "5260.00",
"teamstersHours": "695.00"
},
{
"projectId": 1001549,
"yearMonth": "201402",
"boilermakerHours": "1480.00",
"carpenterHours": "3255.00",
"electricianHours": "5040.00",
"instrumentationHours": "560.00",
"insulatorsHours": "495.00",
"ironworkerHours": "1265.00",
"millwrightHours": "950.00",
"operatorHours": "2440.00",
"paintingHours": "245.00",
"pipefitterHours": "4685.00",
"plumberHours": "585.00",
"rentalHours": "242430.00",
"scaffoldingHours": "2905.00",
"tivUsd": "5000000.00",
"welderHours": "3385.00",
"laborerHours": "5260.00",
"teamstersHours": "695.00"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getLaborProjectDurationDetail",
"summary": "Return Labor Project Duration Details",
"description": "Returns up to 100 labor project duration records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n projectdurations?projectId=1001549&fields=yearMonth&fields=electricianHours&fields=boilermakerHours\n\nThese are the supported parameters:"
}
},
"/controlAreas": {
"summary": "Control Area Reference",
"description": "Control Area List",
"post": {
"tags": [
"References"
],
"parameters": [
{
"name": "listAll",
"description": "Returns all Balancing Authorities/Control Areas.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "controlAreaId",
"description": "Balancing Authority/Control Area ID. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query"
},
{
"name": "controlAreaName",
"description": "Balancing Authority/Control Area name. Searching by the Control Area name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of Balancing Authority/Control Area results to return. By default, it will return 500 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned Balancing Authority/Control Area results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/controlAreaResponse"
},
"examples": {
"controlAreasResponse": {
"value": {
"limit": 500,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"controlAreas": [
{
"controlAreaId": "BCA",
"controlAreaName": "Virginia Electric & Power - Batesville"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getControlAreas",
"summary": "List of Balancing Authorities/Control Areas",
"description": ""
}
},
"/plants/summary": {
"summary": "Find Plant Summary",
"description": "Returns Plant Summary.",
"post": {
"tags": [
"Plant Search"
],
"parameters": [
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values. \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Salamina Manso Hydro"
}
},
"in": "query"
},
{
"name": "confirmationStatus",
"description": "The Confirmation Status of the plant. Search by confirmation status using the following options: \"Confirmed” or “Unconfirmed”.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Confirmed"
}
},
"in": "query",
"required": false
},
{
"name": "plantStatusId",
"description": "Status ID of the plant. The plant status allows to search for plants in various classifications. This parameter supports multiple values.\n \n\nList of supported values:
\n\n K - Cancelled\n C - Closed\n E - Engineered\n M - Mothballed\n H - On Hold\n O - Operational\n P - Planned\n R - Removed\n S - Shuttered \n UC - Under Construction\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "O"
}
},
"in": "query"
},
{
"name": "plantStatusDesc",
"description": "Status description of the plant. The plant status allows to search for plants in various classifications. This parameter supports multiple values.\n \nList of supported values:
\n\n Cancelled\n Closed\n Engineered\n Mothballed\n On Hold\n Operational\n Planned\n Removed\n Shuttered \n Under Construction\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "recordStatus",
"description": "Record Status of the plant record. \n\nList of supported values:
\n\n Actively Tracking\n Pending Re-Verification\n Update Upon Request\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Actively Tracking"
}
},
"in": "query",
"required": false
},
{
"name": "plantProbability",
"description": "Plant Probability. Plant Probability is IIR's research team's assessment for a new plant in the planning, engineering, or under construction phase to move forward to completion and start up. This parameter supports multiple values. \r\n\r\n\r\nList of supported values:
\r\n\r\n Low \r\n Medium\r\n High\r\n Completed\r\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Medium"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by operator name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "plantOwnerCountryName",
"description": "Country Name of the plant owner. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "plantOwnerStateName",
"description": "State name of the plant owner. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "plantOwnerCity",
"description": "City of the plant owner. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Dallas"
}
},
"in": "query"
},
{
"name": "plantOwnerPostalCode",
"description": "Postal Code of the plant owner. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query",
"required": false
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 4
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Europe"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of plant’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "The City name of the plant's physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "mailingAddressCountryName",
"description": "Country name of the plant’s mailing address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "mailingAddressStateName",
"description": "State name of the plant’s mailing address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "mailingAddressCity",
"description": "City name of the plant’s mailing address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "mailingAddressPostalCode",
"description": "Postal Code of the plant’s mailing address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "offshoreBlockV1",
"description": "Offshore Quadrant/Block V1. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 360
}
},
"in": "query"
},
{
"name": "offshoreBlockV2",
"description": "Offshore Quadrant/Block V2. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 782
}
},
"in": "query"
},
{
"name": "offshorePlatformType",
"description": "Offshore Platform Type ID. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - Fixed Steel Jacket Platform\n 2 - Compliant Tower Platform\n 3 - Semi-Submersible Platform\n 4 - SPAR Platform\n 5 - Tension Leg Platform\n 6 - Mini-Tension Leg Platform\n 7 - Gravity Based Platform\n 8 - FPSO (Floating Production Storage and Offloading)\n 9 - FSO (Floating Storage and Offloading)\n 10 - Manmade Island\n 11 - Wind Turbine\n 12 - Tidal Turbine\n 13 - Wave Turbine\n 14 - To Be Determined\n 15 - FLNG (Floating Liquefied Natural Gas)\n 16 - Cassion\n 17 - Subsea\n 18 - Wellhead Platform\n 19 - FPU (Floating Production Unit)\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 16
}
},
"in": "query"
},
{
"name": "offshorePlatformTypeDesc",
"description": "Offshore Platform Type name. Searching by Offshore Platform Type name can be done using one or multiple keywords. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Fixed Steel Jacket Platform\n Compliant Tower Platform\n Semi-Submersible Platform\n SPAR Platform\n Tension Leg Platform\n Mini-Tension Leg Platform\n Gravity Based Platform\n FPSO (Floating Production Storage and Offloading)\n FSO (Floating Storage and Offloading)\n Manmade Island\n Wind Turbine\n Tidal Turbine\n Wave Turbine\n To Be Determined\n FLNG (Floating Liquefied Natural Gas)\n Cassion\n Subsea\n Wellhead Platform\n FPU (Floating Production Unit)\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Cassion"
}
},
"in": "query"
},
{
"name": "waterDepthMeterMin",
"description": "To search by Water Depth in meters enter whole numbers only. The minimum Water Depth (Meter) searches for plants equal to or greater than the value given. The minimum Water Depth (Meter) can be used in conjunction with the maximum Water Depth (Meter) to select a water depth range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "waterDepthMeterMax",
"description": "To search by Water Depth in meters enter whole numbers only. The maximum Water Depth (Meter) searches for plants equal to or less than the value given. The maximum Water Depth (Meter) can be used in conjunction with the minimum Water Depth (Meter) to select a water depth range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "waterDepthFeetMin",
"description": "To search by Water Depth in feet enter whole numbers only. The minimum Water Depth (Feet) searches for plants equal to or greater than the value given. The minimum Water Depth (Feet) can be used in conjunction with the maximum Water Depth (Feet) to select a water depth range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "waterDepthFeetMax",
"description": "To search by Water Depth in feet enter whole numbers only. The maximum Water Depth (Feet) searches for plants equal to or less than the value given. The maximum Water Depth (Feet) can be used in conjunction with the minimum Water Depth (Feet) to select a water depth range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 150
},
"in": "query"
},
{
"name": "distanceFromShoreMiMin",
"description": "To search by Distance from Shore enter whole numbers only. The minimum Distance From Shore (Miles) searches for plants equal to or greater than the value given. The minimum Distance from Shore (Miles) can be used in conjunction with the maximum Distance from Shore (Miles) to select a range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 25
},
"in": "query"
},
{
"name": "distanceFromShoreMiMax",
"description": "To search by Distance from Shore enter whole numbers only. The maximum Distance From Shore (Miles) searches for plants equal to or less than the value given. The maximum Distance from Shore (Miles) can be used in conjunction with the minimum Distance from Shore (Miles) to select a range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "distanceFromShoreKmMin",
"description": "To search by Distance from Shore enter whole numbers only. The minimum Distance From Shore (Kilometers) searches for plants equal to or greater than the value given. The minimum Distance from Shore (Kilometers) can be used in conjunction with the maximum Distance from Shore (Kilometers) to select a range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 5
},
"in": "query"
},
{
"name": "distanceFromShoreKmMax",
"description": "To search by Distance from Shore enter whole numbers only. The maximum Distance From Shore (Kilometers) searches for plants equal to or less than the value given. The maximum Distance from Shore (Kilometers) can be used in conjunction with the minimum Distance from Shore (Kilometers) to select a range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "nercRegion",
"description": "NERC Region of the plant. This parameter supports multiple values.\n\n\nList of supported values:
\n\n ASCC\n ERCOT\n SPP \n RFC ECAR \n RFC MAAC\n NPCC \n SERC \n WECC \n FRCC\n RFC MAIN \n MRO\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ASCC"
}
},
"in": "query",
"required": false
},
{
"name": "isoRtoRegion",
"description": "ISO/RTO Region of the plant. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AESO\n CAL-ISO\n ERCOT \n ISO-NE \n MISO \n NYISO \n ON-IMO \n PJM\n SPP \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AESO"
}
},
"in": "query"
},
{
"name": "electricalConnectionName",
"description": "Electrical Utility Connection of the plant. Searching by the electrical utility connection company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alabama Power Company"
}
},
"in": "query"
},
{
"name": "controlAreaName",
"description": "Balancing Authority/Control Area name. Searching by the Balancing Authority/Control Area name can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alliant East (MISO)"
}
},
"in": "query"
},
{
"name": "tradingRegionId",
"description": "Trading Region ID. Searching by Trading Region ID will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - PADD I\n 2 - PADD II\n 3 - PADD III\n 4 - PADD IV\n 5 - PADD V\n 6 - Western Canada\n 7 - Eastern Canada\n 8 - Central Canada\n 9 - Caribbean\n 10 - Mexico\n 11 - South America\n 13 - Central America\n 14 - Africa\n 15 - Central Asia\n 16 - Australia\n 17 - Mediterranean\n 18 - Eastern Europe\n 19 - Northwest Europe\n 20 - Middle East \n 21 - South Asia\n 22 - Southeast Asia\n 23 - North Asia\n 24 - Russia\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "tradingRegionName",
"description": "Trading Region name. Searching by Trading Region name will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n PADDs: \n I\n II\n III\n IV\n V\n Other Regions:\n Western Canada\n Eastern Canada\n Central Canada\n Caribbean\n Mexico\n South America\n Central America\n Africa\n Central Asia\n Australia\n Mediterranean\n Eastern Europe\n Northwest Europe\n Middle East \n South Asia\n Southeast Asia\n North Asia\n Russia\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "I"
}
},
"in": "query"
},
{
"name": "primarySicId",
"description": "Primary SIC ID. Searching by Primary SIC ID can be done by entering the four-digit SIC ID. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "primarySicDesc",
"description": "Primary SIC description. Searching by Primary SIC description can be done by using one or multiple keywords. To search by multiple SIC descriptions, use the same parameter multiple times with different values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Transmission"
}
},
"in": "query"
},
{
"name": "secondarySicId",
"description": "Secondary SIC ID. Searching by the Secondary SIC ID can be done by entering the four-digit SIC ID. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "secondarySicDesc",
"description": "Secondary SIC description. Searching by Secondary SIC description can be done by using one or multiple keywords. To search by multiple SIC descriptions, use the same parameter multiple times with different values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Electricity"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code of the plant. IIR assigns each plant to one of twelve industries. Search for plants using the two digit Industry code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description of the plant. Search for plants using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "sicProductId",
"description": "Plant SIC Product ID. Searching by Plant SIC Product ID can be done by entering one or multiple SIC Product IDs. This parameter supports multiple values. To get the list of supported SIC Products, please refer to the [/sicProduts](#post-/sicProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1311*0008"
}
},
"in": "query"
},
{
"name": "sicProductDesc",
"description": "Plant SIC Product description. Searching by Plant SIC Product description can be done by entering one or multiple SIC Product descriptions. This parameter supports multiple values. To get the list of supported SIC Products, please refer to the [/sicProduts](#post-/sicProducts) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Pipelines"
}
},
"in": "query"
},
{
"name": "capacityProductId",
"description": "Product/Capacity of the plant. To search by multiple Product IDs, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 1678
}
},
"in": "query"
},
{
"name": "capacityProductDesc",
"description": "Product/Capacity description of the plant. Searching by the product description can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Condensate"
}
},
"in": "query"
},
{
"name": "designCapacityMin",
"description": "The minimum Design Capacity searches for plants equal to or greater than the value given. The minimum Design Capacity can be used in conjunction with the maximum Design Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 1000
},
"in": "query"
},
{
"name": "designCapacityMax",
"description": "The maximum Design Capacity searches for plants equal to or less than the value given. The maximum Design Capacity can be used in conjunction with the minimum Design Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 1500
},
"in": "query"
},
{
"name": "actualCapacityMin",
"description": "The minimum Actual Capacity searches for plants equal to or greater than the value given. The minimum Actual Capacity can be used in conjunction with the maximum Actual Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 1000
},
"in": "query"
},
{
"name": "actualCapacityMax",
"description": "The maximum Actual Capacity searches for plants equal to or less than the value given. The maximum Actual Capacity can be used in conjunction with the minimum Actual Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 1500
},
"in": "query"
},
{
"name": "contactFirstName",
"description": "Contact First Name of the plant. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Jim"
}
},
"in": "query"
},
{
"name": "contactLastName",
"description": "Contact Last Name of the plant. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boyd"
}
},
"in": "query"
},
{
"name": "contactTitleDesc",
"description": "Contact Functional/Actual Title description of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Reliability Manager"
}
},
"in": "query"
},
{
"name": "contactEmailAddress",
"description": "Contact Email address of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "test"
}
},
"in": "query"
},
{
"name": "contactPhoneNumber",
"description": "Contact Phone Number of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 7132224545
}
},
"in": "query"
},
{
"name": "startupDateMin",
"description": "The date that the plant actually began production. To search by minimum Startup date simply enter the date using the correct format (YYYY-MM-DD). The minimum Startup date can be used in conjunction with the maximum Startup date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-02-06"
},
"in": "query"
},
{
"name": "startupDateMax",
"description": "The date that the plant actually began production. To search by maximum Startup date simply enter the date using the correct format (YYYY-MM-DD). The maximum Startup date can be used in conjunction with the minimum Startup date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2021-02-13"
},
"in": "query"
},
{
"name": "closingDateMin",
"description": "The closing date of the plant. To search by minimum Closing date simply enter the date using the correct format (YYYY-MM-DD). The minimum closing date can be used in conjunction with the maximum closing date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-10-04"
},
"in": "query"
},
{
"name": "closingDateMax",
"description": "The closing date of the plant. To search by maximum Closing date simply enter the date using the correct format (YYYY-MM-DD). The maximum closing date can be used in conjunction with the minimum closing date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-10-31"
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for plant records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The plant minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for plant records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The plant maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new plant records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The plant minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new plant records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The plant maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "plantDetails",
"description": "Additional comments detailing potential delays due to unforeseen events. Search for keywords in the plant details. This parameter supports multiple values and wildcard keyword search.",
"schema": {
"type": "string"
},
"in": "query"
},
{
"name": "existingSqFtMin",
"description": "To search by Existing Sq. Ft. enter whole numbers only. The minimum Existing Sq. Ft. searches for plants equal to or greater than the value given. The minimum Existing Sq. Ft. can be used in conjunction with the maximum Existing Sq. Ft. to query on existing Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "existingSqFtMax",
"description": "To search by Existing Sq. Ft. enter whole numbers only. The maximum Existing Sq. Ft. searches for plants equal to or less than the value given. The maximum Existing Sq. Ft. can be used in conjunction with the minimum Existing Sq. Ft. to query on existing Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 5000
},
"in": "query"
},
{
"name": "employeeCountMin",
"description": "Employment Count of the plant. The minimum Employee count searches for plants equal to or greater than the value given. The minimum Employee count can be used in conjunction with the maximum employee count to select an employment count range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 15
},
"in": "query"
},
{
"name": "employeeCountMax",
"description": "Employment Count of the plant. The maximum Employee count searches for plants equal to or less than the value given. The maximum Employee count can be used in conjunction with the minimum employee count to select an employment count range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 250
},
"in": "query"
},
{
"name": "operationsLaborPreference",
"description": "Search by Operations Labor Preference: Non-Union (0) or Union (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel of the plant. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel of the plant. To search by multiple values, use the same parameter multiple times with different values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "transportationHighway",
"description": "Truck/Highway transportation mode.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "transportationPipe",
"description": "Pipeline transportation mode.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "transportationRail",
"description": "Rail transportation mode.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "transportationAir",
"description": "Air transportation mode. ",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "transportationDock",
"description": "Dock/Port transportation mode.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "coalUsageMetallurgical",
"description": "Metallurgical coal usage.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "coalUsageThermal",
"description": "Thermal/Steam coal usage.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningPlacer",
"description": "Placer mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningOpenPit",
"description": "Open Pit mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningQuarry",
"description": "Quarry mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningStrip",
"description": "Strip (Open Cast & Mountain Top) mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningAuger",
"description": "Auger mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningHydraulic",
"description": "Hydraulic mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningBorehole",
"description": "Borehole mining method. ",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningDredging",
"description": "Dredging mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningDrift",
"description": "Drift mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningShaft",
"description": "Shaft mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningSlope",
"description": "Slope mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningLongwall",
"description": "Longwall mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningRoomPillar",
"description": "Room & Pillar mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningCutFill",
"description": "Cut and Fill mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningCaving",
"description": "Caving (Long Hole & Sub-Level) mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningStoping",
"description": "Stoping mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningInSituSolution",
"description": "In-Situ – Solution & Leaching mining method. ",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "ltsaId",
"description": "The ID of the Plant LTSA (Long Term Service Agreement). To search by multiple Plant LTSA IDs use the same parameter multiple times with different values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 6199
}
},
"in": "query"
},
{
"name": "ltsaStatusId",
"description": "The Status of the plant LTSA. The LTSA status allows to search for plant LTSAs in various classifications. This parameter supports multiple values.\n\nList of supported values:
\n\n 1 - Active\n 2 - Cancelled\n 3 – Completed\n 4 – Future\n 6 – Pending Renewal\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "ltsaStatusDesc",
"description": "The Status description of the plant LTSA. The LTSA status allows to search for plant LTSAs in various classifications. This parameter supports multiple values.\n \nList of supported values:
\n\n Active\n Cancelled\n Completed\n Future\n Pending Renewal\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Active"
}
},
"in": "query"
},
{
"name": "ltsaContractorName",
"description": "The name of the LTSA Contractor. Searching by the Contractor Name will return results for all LTSA's associated with the given Company name. Searching for plant LTSAs by Contractor Name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "CCC Group, Mundy Companies"
}
},
"in": "query"
},
{
"name": "ltsaContractLengthMin",
"description": "The LTSA contract length minimum number of years. Enter values 1-10 or 99 for Evergreen. The LTSA Contract Length minimum number of years searches for plants equal to or greater than the value given. The minimum LTSA Contract Length can be used in conjunction with the maximum LTSA Contract Length to select a contract length range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 1
},
"in": "query"
},
{
"name": "ltsaContractLengthMax",
"description": "The LTSA contract length maximum number of years. Enter values 1-10 or 99 for Evergreen. The LTSA Contract Length maximum number of years searches for plants equal to or less than the value given. The maximum LTSA Contract Length can be used in conjunction with the minimum LTSA Contract Length to select a contract length range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "ltsaContractExpMin",
"description": "The LTSA expiration date. This is the date the LTSA ends. To search by minimum Contract Expiration date simply enter the date using the correct format (YYYY-MM-DD). The minimum Contract Expiration date can be used in conjunction with the maximum Contract Expiration date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "ltsaContractExpMax",
"description": "The LTSA expiration date. This is the date the LTSA ends. To search by maximum Contract Expiration date simply enter the date using the correct format (YYYY-MM-DD). The maximum Contract Expiration date can be used in conjunction with the minimum Contract Expiration date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-01"
},
"in": "query"
},
{
"name": "ltsaPreferredContractor",
"description": "LTSA Preferred Contractor.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "ltsaPersonnelCountMin",
"description": "Search for plant LTSA records using personnel count range. The minimum Personnel count searches for plant LTSAs equal to or greater than the value given. The minimum Personnel count can be used in conjunction with the maximum personnel count to select a personnel count range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 20
},
"in": "query"
},
{
"name": "ltsaPersonnelCountMax",
"description": "Search for plant LTSA records using personnel count range. The maximum Personnel count searches for plant LTSAs equal to or less than the value given. The maximum Personnel count can be used in conjunction with the minimum personnel count to select a personnel count range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "limit",
"description": "Number of plant results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned plant results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/plantSummaryResponse"
},
"examples": {
"plantSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"plants": [
{
"plantId": 3019313,
"plantName": "Central hidroelectrica Venda Nova III",
"plantStatusDesc": "Under Construction",
"releaseDate": "2012-01-12T03:34:44Z[UTC]",
"industryCode": "01",
"industryCodeDesc": "Power",
"primarySicId": "4911",
"primarySicDesc": "Electric Services [Public Utilities]",
"physicalAddress": {
"city": "Vieira do Minho",
"stateName": "Braga",
"countryName": "Portugal"
}
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getPlantSummary",
"summary": "Return Plant(s) Summary",
"description": "Returns up to 100 plant records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Plant ID returned here and refer to the [/plants/detail](#post-/plants/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n plantId=1003456&plantId=1000006\n \nSearching by wildcard keyword:\n\n plantName=Test\n \n Example of returned plants:\n \"plantName\": \"Des Moines Genetically Analytical Testing Lab\"\n \"plantName\": \"Georgetown Specialty Chemicals Test\"\n\nThese are the supported parameters:"
}
},
"/plants/detail": {
"summary": "Find Plant Detail by ID",
"description": "Returns Plant Details.",
"post": {
"tags": [
"Plant Search"
],
"parameters": [
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values. \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of plant results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned plant results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/plantDetailResponse"
},
"examples": {
"plantDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"plants": [
{
"plantId": 1018077,
"plantName": "Geismar Chemicals",
"plantStatusDesc": "Planned",
"noEmployees": 100,
"startupDate": "1968-01-01T06:00:00Z[UTC]",
"liveDate": "1993-05-08T05:00:00Z[UTC]",
"releaseDate": "2019-11-06T14:56:48Z[UTC]",
"operationsLaborPreference": 0,
"fuel": {
"primaryFuel": "Natural Gas",
"secondaryFuel": "Combined Cycle Waste Heat"
},
"industryCode": "07",
"industryCodeDesc": "Chemical Processing (CPI)",
"primarySicId": "2869",
"primarySicDesc": "Industrial Organic Chemical",
"pecZone": "LA*02",
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"confirmationStatus": "Confirmed",
"nercRegion": "SERC",
"nercSubRegionName": "Delta",
"electricalConnectionName": "Entergy Gulf States Incorporated",
"tradingRegionId": 3,
"tradingRegionName": "III",
"cogenChp": 1,
"coalUsage": {
"metallurgical": 0,
"thermal": 0
},
"miningMethods": {
"placer": 0,
"openPit": 0,
"quarry": 0,
"strip": 0,
"auger": 0,
"dredging": 0,
"drift": 0,
"shaft": 0,
"slope": 0,
"longwall": 0,
"roomPillar": 0,
"cutFill": 0,
"caving": 0,
"stoping": 0,
"inSituSolution": 0
},
"longitude": -91.011944,
"latitude": 30.209444,
"worldRegionId": 1,
"worldRegionName": "North America",
"offshore": 0,
"mailingAddress": {
"addressLine1": "P O Box 228",
"city": "Geismar",
"stateName": "Louisiana",
"postalCode": "70734",
"countryName": "U.S.A."
},
"physicalAddress": {
"addressLine1": "36045 Highway 30",
"city": "Geismar",
"stateName": "Louisiana",
"postalCode": "70734",
"countryName": "U.S.A.",
"countyName": "Ascension"
},
"phone": {
"cc": 1,
"number": "2256736121"
},
"parent": {
"companyId": 1007443,
"companyName": "Westlake Chemical Corporation",
"website": "www.westlake.com"
},
"operator": {
"companyId": 1097082,
"companyName": "Westlake Vinyls Company LP"
},
"owner": [
{
"companyId": 1097082,
"companyName": "Westlake Vinyls Company LP",
"classification": "S",
"ownerPercent": 100,
"address": {
"addressLine1": "36045 Highway 30",
"city": "Geismar",
"stateName": "Louisiana",
"countryName": "U.S.A.",
"postalCode": "70734"
}
}
],
"sicProduct": [
{
"sicProductId": "2813*0007",
"sicProductDesc": "Hydrogen-mfg"
},
{
"sicProductId": "2813*0011",
"sicProductDesc": "Oxygen, compressed and liquefied-mfg"
},
{
"sicProductId": "2869*0109",
"sicProductDesc": "Methanol, synthetic (methyl alcohol)-mfg"
},
{
"sicProductId": "4931*0005",
"sicProductDesc": "Nonutility Owned Cogeneration"
},
{
"sicProductId": "2821*0059",
"sicProductDesc": "Polyvinyl chloride resins-mfg"
},
{
"sicProductId": "2819*0068",
"sicProductDesc": "Hydrochloric acid-mfg"
}
],
"secondarySic": [
{
"sicId": "4931",
"sicDesc": "Electricity/Steam [IPP]"
},
{
"sicId": "2821",
"sicDesc": "Plastics Materials, Nonvulcanizable Elastomers & Synthetic Resins"
},
{
"sicId": "2813",
"sicDesc": "Industrial Gases"
}
],
"ltsa": [
{
"ltsaId": 2707,
"statusId": 1,
"statusDesc": "Active",
"contractorName": "Turner Industries Group LLC",
"qcDate": "2012-03-06T06:00:00Z[UTC]"
},
{
"ltsaId": 343,
"statusId": 1,
"statusDesc": "Active",
"contractorName": "Turner Industries Group LLC",
"contractLength": 5,
"contractExpiration": "2013-01-31T06:00:00Z[UTC]",
"personnelCount": 20,
"qcDate": "2012-03-06T06:00:00Z[UTC]"
}
],
"capacity": [
{
"productDesc": "Steam",
"type": "Output",
"actualCapacity": 1200000,
"designCapacity": 1200000,
"uom": "Ton/hr"
},
{
"productDesc": "Electricity",
"type": "Output",
"actualCapacity": 63.8,
"designCapacity": 104,
"uom": "MW"
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getPlantDetail",
"summary": "Return Plant(s) Detail",
"description": "Returns up to 5 plant records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n plants/detail?plantId=1018109&fields=plantId&fields=plantName&fields=plantStatusDesc&fields=physicalAddress.countryName\n\nThese are the supported parameters:"
}
},
"/units/summary": {
"summary": "Find Unit Summary",
"description": "Return Unit summary. ",
"post": {
"tags": [
"Unit Search"
],
"parameters": [
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "DU-2"
}
},
"in": "query"
},
{
"name": "unitStatusDesc",
"description": "Status of the unit. The unit status allows to search for units in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Planned\n On Hold\n Engineered\n Cancelled\n Under Construction\n Operational\n Mothballed\n Closed\n Shuttered\n Removed\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "plantOwnerId",
"description": "Owner ID of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1049516
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by owner Name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Deer Park Refining LP"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by the operator name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the Parent company can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Salamina Manso Hydro"
}
},
"in": "query"
},
{
"name": "unitTypeId",
"description": "Unit Type ID. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 126
}
},
"in": "query"
},
{
"name": "unitTypeDesc",
"description": "Unit Type description. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "unitTypeGroup",
"description": "Unit Type Group. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Crude\n Coking\n Cat Cracker\n Hydrocracking\n Reforming\n Storage\n Distillate Hydrotreater\n Mid Distillate Hydrotreater\n FCCU Gasoline Hydrotreater\n VGO\n Alkylation\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Crude"
}
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "powerUsageDesc",
"description": "Power Usage of the unit. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Base Load\n Intermediate Load\n Peak Load\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Base Load"
}
},
"in": "query"
},
{
"name": "unitClassification",
"description": "Unit Ownership Classification. This parameter supports multiple values.",
"schema": {
"enum": [
"Utility",
"Non-Utility"
],
"type": "string",
"example": "Utility"
},
"in": "query"
},
{
"name": "cogenChp",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "technology",
"description": "Search by technology using one or multiple keywords. Technology is a key word search field that allows you to query generators underdevelopment by technology information available which can include Turbine, Boiler Information, and Environmental Control equipment types.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Tech info"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. IIR assigns each unit to one of twelve industries. Search for units using the two digit Industry code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Search for units using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone of the plant. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*01"
}
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "nercRegion",
"description": "NERC Region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n ASCC\n ERCOT\n SPP \n RFC ECAR \n RFC MAAC\n NPCC \n SERC \n WECC \n FRCC\n RFC MAIN \n MRO\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ASCC"
}
},
"in": "query"
},
{
"name": "isoRtoRegion",
"description": "ISO/RTO Region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AESO\n CAL-ISO\n ERCOT \n ISO-NE \n MISO \n NYISO \n ON-IMO \n PJM\n SPP \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AESO"
}
},
"in": "query"
},
{
"name": "controlAreaId",
"description": "Balancing Authority/Control Area ID. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AEC"
}
},
"in": "query"
},
{
"name": "controlAreaName",
"description": "Balancing Authority/Control Area name. Searching by the Balancing Authority/Control Area name can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alliant East (MISO)"
}
},
"in": "query"
},
{
"name": "electricalConnectionName",
"description": "Electrical Utility Connection. Searching by the electrical utility connection company can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alabama Power Company"
}
},
"in": "query"
},
{
"name": "tradingRegionId",
"description": "Trading Region ID. Searching by Trading Region ID will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - PADD I\n 2 - PADD II\n 3 - PADD III\n 4 - PADD IV\n 5 - PADD V\n 6 - Western Canada\n 7 - Eastern Canada\n 8 - Central Canada\n 9 - Caribbean\n 10 - Mexico\n 11 - South America\n 13 - Central America\n 14 - Africa\n 15 - Central Asia\n 16 - Australia\n 17 - Mediterranean\n 18 - Eastern Europe\n 19 - Northwest Europe\n 20 - Middle East \n 21 - South Asia\n 22 - Southeast Asia\n 23 - North Asia\n 24 - Russia\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "tradingRegionName",
"description": "Trading Region name. Searching by Trading Region name will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n PADDs: \n I\n II\n III\n IV\n V\n Other Regions:\n Western Canada\n Eastern Canada\n Central Canada\n Caribbean\n Mexico\n South America\n Central America\n Africa\n Central Asia\n Australia\n Mediterranean\n Eastern Europe\n Northwest Europe\n Middle East \n South Asia\n Southeast Asia\n North Asia\n Russia\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "I"
}
},
"in": "query"
},
{
"name": "unitStatusGroup",
"description": "Unit Status Group. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Pre-Commissioned\n Commissioned\n Decommissioned\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Commissioned"
}
},
"in": "query"
},
{
"name": "unitDetails",
"description": "Additional comments detailing potential delays due to unforeseen events. Search for keywords in the unit details. This parameter supports multiple values and wildcard keyword search.",
"schema": {
"type": "string"
},
"in": "query"
},
{
"name": "unitKickoffDateMin",
"description": "Unit Construction Kickoff Date. To search by minimum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Construction Kickoff date can be used in conjunction with the maximum Unit Kickoff date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitKickoffDateMax",
"description": "Unit Construction Kickoff Date. To search by maximum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Construction Kickoff date can be used in conjunction with the minimum Unit Kickoff date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMin",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by minimum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Start-Up date can be used in conjunction with the maximum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMax",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by maximum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Start-Up date can be used in conjunction with the minimum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMin",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by minimum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Shutdown date can be used in conjunction with the maximum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMax",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by maximum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Shutdown date can be used in conjunction with the minimum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "unitProductId",
"description": "Product/Capacity ID of the unit. To search by multiple Product IDs, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 9981
}
},
"in": "query"
},
{
"name": "unitProductDesc",
"description": "Product/Capacity description of the unit. To search by multiple Product descriptions, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Electricity"
}
},
"in": "query"
},
{
"name": "currentCapacityMin",
"description": "The minimum Current Capacity searches for units equal to or greater than the value given. The minimum Current Capacity can be used in conjunction with the maximum Current Capacity to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 500
},
"in": "query"
},
{
"name": "currentCapacityMax",
"description": "The maximum Current Capacity searches for units equal to or less than the value given. The maximum Current Capacity can be used in conjunction with the minimum Current Capacity to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 1500
},
"in": "query"
},
{
"name": "futureCapacityMin",
"description": "The minimum Future Capacity searches for units equal to or greater than the value given. The minimum Future Capacity can be used in conjunction with the maximum Future Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 750
},
"in": "query"
},
{
"name": "futureCapacityMax",
"description": "The maximum Future Capacity searches for units equal to or less than the value given. The maximum Future Capacity can be used in conjunction with the minimum Future Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 2000
},
"in": "query"
},
{
"name": "futureCapacityStatus",
"description": "Future Capacity Status of the unit. This parameter supports multiple values.\n \nList of supported values:
\n\n Cancelled\n Completed\n Engineered\n On Hold\n Planned\n Under Construction\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Planned"
}
},
"in": "query"
},
{
"name": "futureCompletionDateMin",
"description": "Future Completion/Online Date. To search by minimum Future Online date simply enter the date using the correct format (YYYY-MM-DD). The minimum Future Online date searches for units equal to or greater than the value given. The minimum Future Online date can be used in conjunction with the maximum Future Online date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "futureCompletionDateMax",
"description": "Future Completion/Online Date. To search by maximum Future Online date simply enter the date using the correct format (YYYY-MM-DD). The maximum Future Online date searches for units equal to or less than the value given. The maximum Future Online date can be used in conjunction with the minimum Future Online date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "1990-05-05"
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for unit records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The unit minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for unit records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The unit maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new unit records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The unit minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new unit records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The unit maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "contactFirstName",
"description": "Contact First Name of the unit. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Jim"
}
},
"in": "query"
},
{
"name": "contactLastName",
"description": "Contact Last Name of the unit. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boyd"
}
},
"in": "query"
},
{
"name": "contactTitleDesc",
"description": "Contact Title description of the unit. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Reliability Manager"
}
},
"in": "query"
},
{
"name": "contactEmailAddress",
"description": "Contact Email address of the unit. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "test@test.com"
}
},
"in": "query"
},
{
"name": "contactPhone",
"description": "Contact Phone number of the unit. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 7132224545
}
},
"in": "query"
},
{
"name": "ltsaId",
"description": "Unit LTSA ID (Long Term Service Agreement). To search by multiple Unit LTSA IDs use the same parameter multiple times with different values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 11415
}
},
"in": "query"
},
{
"name": "ltsaType",
"description": "Type/Subtype of the Unit LTSA. Searching for units by LTSA Type description can be done using one or multiple keywords. This parameter supports multiple values.\n\n \nList of supported values:
\n\n Turbine - Parts\n Turbine - Labor\n Turbine - Parts and Labor\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Turbine-Parts"
}
},
"in": "query"
},
{
"name": "ltsaStatusDesc",
"description": "Status description of the Unit LTSA. The LTSA status allows to search for unit LTSAs in various classifications. This parameter supports multiple values.\n \nList of supported values:
\n\n Active\n Future\n Pending Renewal\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Active"
}
},
"in": "query"
},
{
"name": "ltsaCompanyName",
"description": "LTSA Contractor name. Searching by the Contractor Name will return results for all LTSA's associated with the given Company name. Searching for Unit LTSAs by Contractor Name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "CCC Group, Mundy Companies"
}
},
"in": "query"
},
{
"name": "ltsaContractLengthMin",
"description": "LTSA contract length minimum number of years. Enter values 1-10 or 99 for Evergreen. The minimum LTSA Contract Length searches for units equal to or greater than the value given. The minimum LTSA Contract Length can be used in conjunction with the maximum LTSA Contract Length to select a contract length range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 1
},
"in": "query"
},
{
"name": "ltsaContractLengthMax",
"description": "LTSA contract length maximum number of years. Enter values 1-10 or 99 for Evergreen. The maximum LTSA Contract Length searches for units equal to or less than the value given. The maximum LTSA Contract Length can be used in conjunction with the minimum LTSA Contract Length to select a contract length range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "ltsaContractExpYearMonthMin",
"description": "LTSA contract expiration date. This is the date the LTSA ends. To search by minimum Contract Expiration date simply enter the date using the correct format (YYYYMM). The minimum Contract Expiration date searches for units equal to or greater than the value given. The minimum Contract Expiration date can be used in conjunction with the maximum Contract Expiration date to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 201201
},
"in": "query"
},
{
"name": "ltsaContractExpYearMonthMax",
"description": "LTSA contract expiration date. This is the date the LTSA ends. To search by maximum Contract Expiration date simply enter the date using the correct format (YYYYMM). The maximum Contract Expiration date searches for units equal to or less than the value given. The maximum Contract Expiration date can be used in conjunction with the minimum Contract Expiration date to select a date range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 202001
},
"in": "query"
},
{
"name": "ltsaPreferredContractor",
"description": "LTSA Preferred Contractor.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "ltsaComments",
"description": "LTSA Comments. Searching for units by LTSA Comments can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "New"
}
},
"in": "query"
},
{
"name": "limit",
"description": "Number of unit results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned unit results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unitSummaryResponse"
},
"examples": {
"unitSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"units": [
{
"unitId": 2079565,
"unitName": "Bauang 01",
"plantId": 3020532,
"plantName": "Bauang Power Plant",
"plantPhysicalAddress": {
"city": "Bauang",
"stateName": "La Union",
"countryName": "Philippines"
},
"unitStatusDesc": "Operational",
"powerUsageDesc": "Base Load",
"unitStartupDate": "1995-07-24T05:00:00Z[UTC]",
"unitTypeDesc": "Internal Combustion",
"capacity": 11,
"capacityUom": "MW"
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getUnitSummary",
"summary": "Return Unit(s) Summary",
"description": "Returns up to 100 unit records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Unit ID returned here and refer to the [/units/detail](#post-/units/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values:\n\n unitId=1000002&unitId=300085254\n\nSearching by wildcard keyword:\n\n unitName=Joao\n \n Example of returned units:\n \"unitName\": \"Sao Joao ST 01\"\n \"unitName\": \"Joao Pinheiro 03\"\n\nThese are the supported parameters:"
}
},
"/units/detail": {
"summary": "Find Unit Detail by ID",
"description": "Return unit details. ",
"post": {
"tags": [
"Unit Search"
],
"parameters": [
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of unit results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned unit results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unitDetailResponse"
},
"examples": {
"unitDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"units": [
{
"unitId": 1000002,
"unitName": "DU-2 (Distilling Unit 2)",
"plantId": 1000052,
"plantName": "Deer Park Refinery",
"plantStatusDesc": "Operational",
"plantPhysicalAddress": {
"addressLine1": "5900 Highway 225",
"city": "Deer Park",
"stateName": "Texas",
"postalCode": "77536",
"countryName": "U.S.A.",
"countyName": "Harris"
},
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"worldRegionId": 1,
"worldRegionName": "North America",
"nercRegion": "ERCOT",
"isoRtoRegion": "ERCOT",
"tradingRegionId": 3,
"tradingRegionName": "III",
"unitStatusDesc": "Operational",
"unitStatusGroup": "Commissioned",
"controlAreaId": "ERCO",
"controlAreaName": "Electric Reliability Council of Texas, Inc.",
"electricalConnectionName": "CenterPoint Energy Incorporated",
"unitClassification": "2911",
"unitTypeId": "00001",
"unitTypeDesc": "Atmospheric Distillation",
"unitTypeGroup": "Crude",
"capacityProductId": "001645",
"capacity": 270000,
"capacityUom": "BBL/d",
"primarySicId": "2911",
"primarySicDesc": "Petroleum Refining",
"areaId": 1000199,
"areaName": "West Operations",
"plantLatitude": 29.714974,
"plantLongitude": -95.13334,
"offshore": 0,
"industryCode": "06",
"industryCodeDesc": "Petroleum Refining (HPI)",
"renewable": 0,
"cogenChp": 0,
"releaseDate": "2010-01-14T17:31:32Z[UTC]",
"liveDate": "1995-08-04T05:00:00Z[UTC]",
"plantOperatorName": "Deer Park Refining LP",
"plantOwnerName": "Deer Park Refining LP",
"plantParentName": "Royal Dutch Shell Plc",
"unitCapacity": [
{
"type": "FEED",
"productId": "001645",
"productDesc": "Crude Petroleum",
"actualCapacity": 270000,
"uom": "BBL/d"
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getUnitDetail",
"summary": "Return Unit(s) Detail",
"description": "Returns up to 5 unit records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n units/detail?unitId=1044377&fields=unitId&fields=unitName&fields=capacity&fields=capacityUom\n\nThese are the supported parameters:"
}
},
"/offlineevents/summary": {
"summary": "Find Offline Event Summary",
"description": "Offline Event Summary.",
"post": {
"tags": [
"Offline Event Search"
],
"parameters": [
{
"name": "eventId",
"description": "The ID of the event. Each Event report is identified by an ID number. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 197653
}
},
"in": "query"
},
{
"name": "eventKind",
"description": "Event Kind. There are three different kinds of events: Power Outages, Refinery Turnarounds, and Oil & Gas Shutdowns. This parameter supports multiple values.\n\n\nList of supported values:
\n\n O – Power Outages \n T – Refinery Turnarounds\n S – Oil & Gas Shutdowns\n\n \n\n\n\n\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "T"
}
},
"in": "query"
},
{
"name": "eventType",
"description": "Type of event. Each event is identified by a specific event type. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Planned \n Unplanned\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Planned"
}
},
"in": "query"
},
{
"name": "eventCause",
"description": "Event Cause. All offline events can be either electrical, mechanical, weather related, or due to economic conditions. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Economic\n Mechanical\n Weather\n Electrical\n \n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Economic"
}
},
"in": "query"
},
{
"name": "eventStatusDesc",
"description": "Status of the event. The event status allows to search for events in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Ongoing \n Future\n Past\n Cancelled\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Ongoing"
}
},
"in": "query"
},
{
"name": "eventStartDateMin",
"description": "Event Start Date. To search by minimum Event Start date simply enter the date using the correct format (YYYY-MM-DD). The minimum Event Start date can be used in conjunction with the maximum Event Start date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "eventStartDateMax",
"description": "Event Start Date. To search by maximum Event Start date simply enter the date using the correct format (YYYY-MM-DD). The maximum Event Start date can be used in conjunction with the minimum Event Start date to select a date range. Also, the maximum Event Start date (today) used in conjunction with minimum Event End date (today) will return the Current Offline Events.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "eventEndDateMin",
"description": "Event End Date. To search by minimum Event End date simply enter the date using the correct format (YYYY-MM-DD). The minimum Event End date can be used in conjunction with the maximum Event End date to select a date range. Also, the minimum Event End date (today) used in conjunction with maximum Event Start date (today) will return the Current Offline Events.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "eventEndDateMax",
"description": "Event End Date. To search by maximum Event End date simply enter the date using the correct format (YYYY-MM-DD). The maximum Event End date can be used in conjunction with the minimum Event End date to select a date range. ",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "eventDurationDaysMin",
"description": "Event Duration minimum number of days. To search by the minimum Event Duration simply enter the number of days. The minimum Event Duration can be used in conjunction with the maximum Event Duration to select a duration period.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 3
},
"in": "query"
},
{
"name": "eventDurationDaysMax",
"description": "Event Duration maximum number of days. To search by the maximum Event Duration simply enter the number of days. The maximum Event Duration can be used in conjunction with the minimum Event Duration to select a duration period.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 15
},
"in": "query"
},
{
"name": "associatedEntityStartDateMin",
"description": "Event Start Date of the Associated Entity (Plant, Unit, Pipeline or Transmission Line). To search by minimum Associated Entity Start date simply enter the date using the correct format (YYYY-MM-DD). The minimum Associated Entity Start date can be used in conjunction with the maximum Associated Entity Start date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "associatedEntityStartDateMax",
"description": "Event Start Date of the Associated Entity (Plant, Unit, Pipeline or Transmission Line). To search by maximum Associated Entity Start date simply enter the date using the correct format (YYYY-MM-DD). The maximum Associated Entity Start date can be used in conjunction with the minimum Associated Entity Start date to select a date range. Also, the maximum Associated Entity Start date (today) used in conjunction with minimum Associated Entity End date (today) will return the Current Offline Events.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "associatedEntityEndDateMin",
"description": "Event End Date of the Associated Entity (Plant, Unit, Pipeline or Transmission Line). To search by minimum Associated Entity End date simply enter the date using the correct format (YYYY-MM-DD). The minimum Associated Entity End date can be used in conjunction with the maximum Associated Entity End date to select a date range. Also, the minimum Associated Entity End date (today) used in conjunction with maximum Associated Entity Start date (today) will return the Current Offline Events.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "associatedEntityEndDateMax",
"description": "Event End Date of the Associated Entity (Plant, Unit, Pipeline or Transmission Line). To search by maximum Associated Entity End date simply enter the date using the correct format (YYYY-MM-DD). The maximum Associated Entity End date can be used in conjunction with the minimum Associated Entity End date to select a date range. ",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "associatedEntityType",
"description": "Associated Entity Type. Each offline event is associated to an entity type (PLANT, UNIT or ASSET). This parameter supports multiple values. \n\nList of supported values:
\n\n PLANT \n UNIT \n ASSET \n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "UNIT"
}
},
"in": "query"
},
{
"name": "firstUnit",
"description": "Returns Unit offline events only data identical to pre-v2.0.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string"
},
"in": "query"
},
{
"name": "derate",
"description": "The Derate/Rate Cut/Reduced Flows of the capacity offline. Search by derate to restrict your query to only those events that have a capacity offline value of less than 100%. This means there will be some capacity available.\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "tivMin",
"description": "Estimated Total Investment Value of the Offline Event in U.S.Dollars. The minimum TIV (Total Investment Value) searches for offline events equal to or greater than the value given. The minimum TIV can be used in conjunction with the maximum TIV amount to select a TIV range.\n",
"schema": {
"format": "int64",
"type": "integer"
},
"in": "query"
},
{
"name": "tivMax",
"description": "Estimated Total Investment Value of the Offline Event in U.S.Dollars. The maximum TIV (Total Investment Value) searches for offline events equal to or less than the value given. The maximum TIV can be used in conjunction with the minimum TIV amount to select a TIV range.\n",
"schema": {
"format": "int64",
"type": "integer"
},
"in": "query"
},
{
"name": "eventComments",
"description": "Event comments. Each offline event report includes a comments section specifying reasons for the time down. Searching by Event comments can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Hurricane"
}
},
"in": "query"
},
{
"name": "eventConfirmationStatus",
"description": "Event Confirmation Status. Search by confirmation status using the following options: \"Confirmed” or “Unconfirmed”.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Confirmed"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone of the plant. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*01"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "nercRegion",
"description": "NERC Region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n ASCC\n ERCOT\n SPP \n RFC ECAR \n RFC MAAC\n NPCC \n SERC \n WECC \n FRCC\n RFC MAIN \n MRO\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ASCC"
}
},
"in": "query"
},
{
"name": "isoRtoRegion",
"description": "ISO/RTO Region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AESO\n CAL-ISO\n ERCOT \n ISO-NE \n MISO \n NYISO \n ON-IMO \n PJM\n SPP \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AESO"
}
},
"in": "query"
},
{
"name": "controlAreaId",
"description": "Balancing Authority/Control Area ID. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AEC"
}
},
"in": "query"
},
{
"name": "controlAreaName",
"description": "Balancing Authority/Control Area name. Searching by the Balancing Authority/Control Area name can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alliant East (MISO)"
}
},
"in": "query"
},
{
"name": "tradingRegionId",
"description": "Trading Region ID. Searching by Trading Region ID will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - PADD I\n 2 - PADD II\n 3 - PADD III\n 4 - PADD IV\n 5 - PADD V\n 6 - Western Canada\n 7 - Eastern Canada\n 8 - Central Canada\n 9 - Caribbean\n 10 - Mexico\n 11 - South America\n 13 - Central America\n 14 - Africa\n 15 - Central Asia\n 16 - Australia\n 17 - Mediterranean\n 18 - Eastern Europe\n 19 - Northwest Europe\n 20 - Middle East \n 21 - South Asia\n 22 - Southeast Asia\n 23 - North Asia\n 24 - Russia\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "tradingRegionName",
"description": "Trading Region name. Searching by Trading Region name will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n PADDs: \n I\n II\n III\n IV\n V\n Other Regions:\n Western Canada\n Eastern Canada\n Central Canada\n Caribbean\n Mexico\n South America\n Central America\n Africa\n Central Asia\n Australia\n Mediterranean\n Eastern Europe\n Northwest Europe\n Middle East \n South Asia\n Southeast Asia\n North Asia\n Russia\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "I"
}
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1016392
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Apache Power Station"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Arizona Electric Power Cooperative"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by the operator name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Arizona Electric Power Cooperative"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by owner Name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Arizona Electric Power Cooperative"
}
},
"in": "query"
},
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1006000
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Apache 02"
}
},
"in": "query"
},
{
"name": "unitTypeId",
"description": "Unit Type ID. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 126
}
},
"in": "query"
},
{
"name": "unitTypeDesc",
"description": "Unit Type description. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "unitTypeGroup",
"description": "Unit Type Group. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Crude\n Coking\n Cat Cracker\n Hydrocracking\n Reforming\n Storage\n Distillate Hydrotreater\n Mid Distillate Hydrotreater\n FCCU Gasoline Hydrotreater\n VGO\n Alkylation\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Crude"
}
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "powerUsageDesc",
"description": "Unit Power Usage. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Base Load\n Intermediate Load\n Peak Load\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Base Load"
}
},
"in": "query"
},
{
"name": "unitClassification",
"description": "Unit Ownership Classification. This parameter supports multiple values.\n",
"schema": {
"enum": [
"Utility",
"Non-Utility"
],
"type": "string",
"example": "Utility"
},
"in": "query"
},
{
"name": "cogenChp",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. Search for offline events using the two digit Industry code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Search for offline events using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "unitProductId",
"description": "Unit Product/Capacity ID. To search by multiple Product IDs, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 9981
}
},
"in": "query"
},
{
"name": "unitProductDesc",
"description": "Unit Product/Capacity description. To search by multiple Product description, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Electricity"
}
},
"in": "query"
},
{
"name": "capacityMin",
"description": "The minimum Capacity searches for offline events equal to or greater than the value given. The minimum Capacity can be used in conjunction with the maximum Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 50
},
"in": "query"
},
{
"name": "capacityMax",
"description": "The maximum Capacity searches for offline events equal to or less than the value given. The maximum Capacity can be used in conjunction with the minimum Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 1500
},
"in": "query"
},
{
"name": "pipelineId",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3500089
}
},
"in": "query"
},
{
"name": "pipelineName",
"description": "Name of the pipeline. Pipeline names are based on the owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to. Searching by pipeline name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transcanada"
}
},
"in": "query"
},
{
"name": "pipelineSystemId",
"description": "The ID of the pipeline system. To search by multiple pipeline system IDs, use the same parameter multiple times with different values. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "pipelineSystemName",
"description": "Name of the pipeline system. Searching by Pipeline System name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Atmos Natural Gas"
}
},
"in": "query"
},
{
"name": "tLineId",
"description": "The ID of the transmission line. The Transmission Line ID is a unique seven-digit number used by IIR that is assigned to each transmission line profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3501034
}
},
"in": "query"
},
{
"name": "tLineName",
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name. Searching by transmission line name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transmission line"
}
},
"in": "query"
},
{
"name": "tLineSystemId",
"description": "The ID of the transmission system. To search by multiple pipeline system IDs, use the same parameter multiple times with different values. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "tLineSystemName",
"description": "Name of the transmission system. Searching by Transmission System name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transmission System"
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for offline event records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The offline event minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for offline event records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The offline event maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new offline event records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The offline event minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new offline event records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The offline event maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of offline event results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned offline event results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offlineEventSummaryResponse"
},
"examples": {
"offlineEventSummaryResponse": {
"value": {
"limit": 2,
"offset": 0,
"resultCount": 2,
"totalCount": 2,
"offlineEvents": [
{
"offlineEventKey": "2034608**1021460*",
"eventId": 2034608,
"eventType": "Planned",
"eventStatusDesc": "Future",
"associatedEntityStartDate": "2019-08-14T05:00:00Z[UTC]",
"associatedEntityEndDate": "2019-08-17T05:00:00Z[UTC]",
"associatedEntityType": "UNIT",
"eventStartDate": "2019-08-14T05:00:00Z[UTC]",
"eventEndDate": "2019-08-17T05:00:00Z[UTC]",
"eventDuration": 4,
"unitId": 1021460,
"unitName": "(CGHT) Catalytic Gasoline Hydrotreater",
"plantName": "Deer Park Refinery",
"plantOwnerName": "Deer Park Refining LP",
"plantPhysicalAddress": {
"city": "Deer Park",
"stateName": "Texas",
"countryName": "U.S.A."
},
"tradingRegionName": "III",
"unitTypeDesc": "Propylene, from Methanol",
"eventComments": "Test",
"liveDate": "2019-08-13T17:23:00Z[UTC]",
"releaseDate": "2020-03-31T19:03:38Z[UTC]"
},
{
"offlineEventKey": "2034608*1000052**",
"eventId": 2034608,
"eventType": "Planned",
"eventStatusDesc": "Future",
"associatedEntityStartDate": "2019-08-14T05:00:00Z[UTC]",
"associatedEntityEndDate": "2019-08-17T05:00:00Z[UTC]",
"associatedEntityType": "PLANT",
"eventStartDate": "2019-08-14T05:00:00Z[UTC]",
"eventEndDate": "2019-08-17T05:00:00Z[UTC]",
"eventDuration": 4,
"plantId": 1000052,
"plantName": "Deer Park Refinery",
"plantOwnerName": "Deer Park Refining LP",
"plantPhysicalAddress": {
"city": "Deer Park",
"stateName": "Texas",
"countryName": "U.S.A."
},
"tradingRegionName": "III",
"eventComments": "Test",
"liveDate": "2019-08-13T17:23:00Z[UTC]",
"releaseDate": "2020-03-31T19:03:38Z[UTC]"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getOfflineEventSummary",
"summary": "Return Offline Event(s) Summary",
"description": "Returns up to 100 offline event records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Event ID returned here and refer to the [/offlineevents/detail](#post-/offlineeevents/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n eventId=97&eventId=2034127\n \nSearching by wildcard keyword:\n\n eventComments=offline\n \n Example of returned offline events:\n \"eventComments\": \"Tripped offline this morning\"\n \"eventComments\": \"Turbine overhaul (Unit will go offline 9/27 at 10 pm)\"\n \nThese are the supported parameters:"
}
},
"/offlineevents/detail": {
"summary": "Find Offline Event by ID",
"description": "Offline Event Details.",
"post": {
"tags": [
"Offline Event Search"
],
"parameters": [
{
"name": "eventId",
"description": "The ID of the event. Each Event report is identified by an ID number. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 197653
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of offline event results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned offline event results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offlineEventDetailResponse"
},
"examples": {
"offlineEventDetailResponse": {
"value": {
"limit": 2,
"offset": 0,
"resultCount": 2,
"totalCount": 2,
"offlineEvents": [
{
"offlineEventKey": "2034608**1021460*",
"eventId": 2034608,
"eventKind": "T",
"eventType": "Planned",
"eventCause": "Mechanical",
"eventStatusDesc": "Future",
"associatedEntityStartDate": "2019-08-14T05:00:00Z[UTC]",
"associatedEntityEndDate": "2019-08-17T05:00:00Z[UTC]",
"associatedEntityType": "UNIT",
"eventStartDate": "2019-08-14T05:00:00Z[UTC]",
"eventEndDate": "2019-08-17T05:00:00Z[UTC]",
"eventDuration": 4,
"unitId": 1021460,
"unitName": "(CGHT) Catalytic Gasoline Hydrotreater",
"unitStatusDesc": "Operational",
"unitStartupDate": "2019-05-21T05:00:00Z[UTC]",
"industryCode": "06",
"industryCodeDesc": "Petroleum Refining (HPI)",
"plantName": "Deer Park Refinery",
"plantParentName": "Royal Dutch Shell Plc",
"plantOwnerName": "Deer Park Refining LP",
"plantOperatorName": "Deer Park Refining LP",
"plantPhysicalAddress": {
"addressLine1": "5900 Highway 225",
"city": "Deer Park",
"stateName": "Texas",
"postalCode": "77536",
"countryName": "U.S.A.",
"countyName": "Harris"
},
"plantPhone": "+1 7132464371",
"plantLatitude": 29.714974,
"plantLongitude": -95.13334,
"areaId": 1000202,
"areaName": "CCU (Cat Cracking & Gas)",
"offshore": 0,
"gasRegionId": "SC",
"gasRegionName": "South Central",
"isoRtoRegion": "ERCOT",
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"nercRegion": "ERCOT",
"tradingRegionId": 3,
"tradingRegionName": "III",
"powerTradeRegion": "Southwest",
"worldRegionId": 1,
"worldRegionName": "North America",
"pecZone": "TX*07",
"primarySicId": "2911",
"unitClassification": "2911",
"derate": 100,
"isDerated": 0,
"unitTypeId": "00318",
"unitTypeDesc": "Propylene, from Methanol",
"eventConfirmationStatus": "Confirmed",
"cogenChp": 0,
"controlAreaId": "ERCO",
"controlAreaName": "Electric Reliability Council of Texas, Inc.",
"electricalConnectionName": "CenterPoint Energy Incorporated",
"eventDatePrecision": "DAY",
"kickoffSlippage": 0,
"eventComments": "Test",
"liveDate": "2019-08-13T17:23:00Z[UTC]",
"releaseDate": "2020-03-31T19:03:38Z[UTC]"
},
{
"offlineEventKey": "2034608*1000052**",
"eventId": 2034608,
"eventType": "Planned",
"eventCause": "Mechanical",
"eventStatusDesc": "Future",
"associatedEntityStartDate": "2019-08-14T05:00:00Z[UTC]",
"associatedEntityEndDate": "2019-08-17T05:00:00Z[UTC]",
"associatedEntityType": "PLANT",
"eventStartDate": "2019-08-14T05:00:00Z[UTC]",
"eventEndDate": "2019-08-17T05:00:00Z[UTC]",
"eventDuration": 4,
"industryCode": "06",
"industryCodeDesc": "Petroleum Refining (HPI)",
"plantId": 1000052,
"plantName": "Deer Park Refinery",
"plantParentName": "Royal Dutch Shell Plc",
"plantOwnerName": "Deer Park Refining LP",
"plantOperatorName": "Deer Park Refining LP",
"plantPhysicalAddress": {
"addressLine1": "5900 Highway 225",
"city": "Deer Park",
"stateName": "Texas",
"postalCode": "77536",
"countryName": "U.S.A.",
"countyName": "Harris"
},
"plantPhone": "+1 7132464371",
"plantLatitude": 29.714974,
"plantLongitude": -95.13334,
"offshore": 0,
"gasRegionId": "SC",
"gasRegionName": "South Central",
"isoRtoRegion": "ERCOT",
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"nercRegion": "ERCOT",
"tradingRegionId": 3,
"tradingRegionName": "III",
"powerTradeRegion": "Southwest",
"worldRegionId": 1,
"worldRegionName": "North America",
"pecZone": "TX*07",
"derate": 100,
"isDerated": 0,
"eventConfirmationStatus": "Confirmed",
"cogenChp": 0,
"controlAreaId": "ERCO",
"controlAreaName": "Electric Reliability Council of Texas, Inc.",
"electricalConnectionName": "CenterPoint Energy Incorporated",
"eventDatePrecision": "DAY",
"kickoffSlippage": 0,
"eventComments": "Test",
"liveDate": "2019-08-13T17:23:00Z[UTC]",
"releaseDate": "2020-03-31T19:03:38Z[UTC]"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getOfflineEventDetail",
"summary": "Return Offline Event(s) Detail",
"description": "Returns up to 5 offline event records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n offlineevents/detail?eventId=2032919&fields=eventId&fields=eventType&fields=eventCause&fields=eventStatusDesc\n\nThese are the supported parameters:"
}
},
"/projects/summary": {
"summary": "Find Project Summary",
"description": "Return project summary. ",
"post": {
"tags": [
"Project Search"
],
"parameters": [
{
"name": "projectId",
"description": "The ID of the project. The Project ID is a unique eight-digit number used by IIR that is assigned to an individual project. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 300034328
}
},
"in": "query"
},
{
"name": "projectName",
"description": "Name of the project. Searching by project name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Amarillo Trident II"
}
},
"in": "query"
},
{
"name": "projectStatusDesc",
"description": "Status description of the project. The project status allows to search for projects in various classifications. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Active\n Cancelled\n Complete / Done \n On Hold\n Unconfirmed\n Unable to Confirm\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Active"
}
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1083676
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Chopim Grassroot"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Chopim Energia"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Isagen SA ESP"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City of the plant. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone of the project. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*01"
}
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name of the plant. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name of the plant. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name of the plant. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code of the project. IIR assigns each project to one of twelve industries. Search for projects using the two digit Industry code. This parameter supports multiple values. \n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals\n 03 - Oil & Gas Pipelines\n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI)\n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description of the project. Search for projects using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "scope",
"description": "The scope of the project. Search for keywords in the scope. This parameter supports multiple values and wildcard keyword search.\r\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "grassroot"
}
},
"in": "query"
},
{
"name": "projectDetails",
"description": "Additional details of the project. Search for keywords in the project details. This parameter supports multiple values and wildcard keyword search.\r\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "COVID-19"
}
},
"in": "query"
},
{
"name": "marketTrend",
"description": "Market Trend. This could be an event that impacts plant operations, financial markets, or project spending. Search for keywords in the market trend. This parameter supports multiple values and wildcard keyword search.\r\n\r\n\r\nList of supported values:
\r\n\r\n COVID-19 Supply Chain Disruption\r\n COVID-19 Supply Chain Recovery\r\n Crude Flexibility\r\n ESG - Carbon Capture & Storage (CCS)\r\n ESG - Electric Transportation\r\n ESG - Energy Storage\r\n ESG - Greenhouse Gas Reduction (GHG)\r\n ESG - Other\r\n ESG - Power-to-X\r\n ESG - Renewable Fuels\r\n ESG - Renewable Power\r\n Impacted by COVID-19\r\n Ukraine Conflict\r\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Impacted by COVID-19"
}
},
"in": "query"
},
{
"name": "tivMin",
"description": "The minimum TIV (Total Investment Value) searches for projects equal to or greater than the value given. The minimum TIV can be used in conjunction with the maximum TIV amount to select a TIV range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 10000
},
"in": "query"
},
{
"name": "tivMax",
"description": "The maximum TIV (Total Investment Value) searches for projects equal to or less than the value given. The maximum TIV can be used in conjunction with the minimum TIV amount to select a TIV range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 15000000
},
"in": "query"
},
{
"name": "umbrellaId",
"description": "Umbrella Project ID. To search by multiple umbrella project IDs, use the same parameter multiple times with different values. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 201
}
},
"in": "query"
},
{
"name": "umbrellaName",
"description": "Name of the Umbrella Project. Searching by Umbrella Project name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Algonquin Incremental"
}
},
"in": "query"
},
{
"name": "projectTypeDesc",
"description": "Project Type description of the project. This parameter supports multiple values.\n\n\n\nList of supported values:
\n\n Capital Project Types:\n Automation\n Brownfield\n Closure\n Conversion\n Debottleneck\n Efficiency Program\n Electricity Distribution\n Electricity Transmission\n Environmental Compliance (Process Equipment Compliance)\n Environmental Mandate (Product Compliance Mandate)\n Equipment Addition\n Grassroot\n Life Extension\n Modernization\n Optimization\n Pipeline Addition\n Pipeline Conversion\n Pipeline Reversal\n Plant Expansion\n Rebuild\n Refurbishment\n Renovation\n Replacement\n Repower\n Restart\n Retrofit\n Revamp\n Storage Addition\n Unit Addition\n Unit Expansion\n Upgrade\n Uprate\n \n Maintenance Project Types:\n Maintenance Event (Outages, Turnarounds, Shutdowns)\n Maintenance Program\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Debottleneck"
}
},
"in": "query"
},
{
"name": "projectFuelTypeDesc",
"description": "Fuel Type description used to identify the primary fuel or energy source that will be utilized as part of the project. This parameter supports multiple values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new project records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The project minimum live date can be used in conjunction with the maximum live date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2014-06-01"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new project records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The project maximum live date can be used in conjunction with the minimum live date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2023-02-23"
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for project records that have been updated over a specific period of time. Projects updates are performed daily by IIR's research staff when changes to a project are discovered. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The project minimum release date can be used in conjunction with the maximum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2017-06-01"
},
"in": "query",
"required": false
},
{
"name": "releaseDateMax",
"description": "Search for project records that have been updated over a specific period of time. Projects updates are performed daily by IIR's research staff when changes to a project are discovered. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The project maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2023-02-23"
},
"in": "query",
"required": false
},
{
"name": "productId",
"description": "Product/Capacity of the project. To search by multiple Product IDs, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 10085
}
},
"in": "query"
},
{
"name": "productDesc",
"description": "Product/Capacity description of the project. Searching by the product description can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Liquids (NGL)"
}
},
"in": "query"
},
{
"name": "plannedCapacityMin",
"description": "The minimum Planned Capacity searches for projects equal to or greater than the value given. The minimum Planned Capacity can be used in conjunction with the maximum Planned Capacity to select a capacity range. ",
"schema": {
"format": "double",
"type": "number",
"example": 10000
},
"in": "query"
},
{
"name": "plannedCapacityMax",
"description": "The maximum Planned Capacity searches for projects equal to or less than the value given. The maximum Planned Capacity can be used in conjunction with the minimum Planned Capacity to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 15000
},
"in": "query"
},
{
"name": "installedCapacityMin",
"description": "The minimum Installed Capacity searches for projects equal to or greater than the value given. The minimum Installed Capacity can be used in conjunction with the maximum Installed Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 10000
},
"in": "query"
},
{
"name": "installedCapacityMax",
"description": "The maximum Installed Capacity searches for projects equal to or less than the value given. The maximum Installed Capacity can be used in conjunction with the minimum Installed Capacity to select a capacity range.",
"schema": {
"format": "double",
"type": "number",
"example": 15000
},
"in": "query"
},
{
"name": "newSqFtMin",
"description": "To search by New Sq. Ft. enter whole numbers only. The minimum New Sq. Ft. searches for projects equal to or greater than the value given. The minimum New Sq. Ft. can be used in conjunction with the maximum New Sq. Ft. to query on new Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "newSqFtMax",
"description": "To search by New Sq. Ft. enter whole numbers only. The maximum New Sq. Ft. searches for projects equal to or less than the value given. The maximum New Sq. Ft. can be used in conjunction with the minimum New Sq. Ft. to query on new Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 5000
},
"in": "query"
},
{
"name": "retrofittedSqFtMin",
"description": "To search by Retrofitted/Renovated Sq. Ft. enter whole numbers only. The minimum Retrofitted Sq. Ft. searches for projects equal to or greater than the value given. The minimum Retrofitted Sq. Ft. can be used in conjunction with the maximum Retrofitted Sq. Ft. to query on retrofitted Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "retrofittedSqFtMax",
"description": "To search by Retrofitted/Renovated Sq. Ft. enter whole numbers only. The maximum Retrofitted Sq. Ft. searches for projects equal to or less than the value given. The maximum Retrofitted Sq. Ft. can be used in conjunction with the minimum Retrofitted Sq. Ft. to query on retrofitted Sq. Ft. ranges.",
"schema": {
"format": "int32",
"type": "integer",
"example": 5000
},
"in": "query"
},
{
"name": "pipelineInstallationTypeId",
"description": "Pipeline Installation Type ID of the project. To search by multiple Pipeline Installation Type IDs, use the same parameter multiple times with different values. This parameter supports multiple values. \nList of supported values:
\n\n 1 - Greenfield\n 2 - Market Extension\n 3 - Conversion\n 4 - Replacement\n 5 - Reversal\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "pipelineInstallationTypeDesc",
"description": "Pipeline Installation Type description of the project. To search by multiple Pipeline Installation Types, use the same parameter multiple times with different values. This parameter supports multiple values. \nList of supported values:
\n\n Greenfield\n Market Extension\n Conversion\n Replacement\n Reversal\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Greenfield"
}
},
"in": "query"
},
{
"name": "pipelineLengthMiMin",
"description": "The minimum Pipeline Length (Miles) searches for projects with pipeline installation that have a length equal to or greater than the value given. The minimum Pipeline Length (Miles) can be used in conjunction with the maximum Pipeline Length (Miles) to select a range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 10
},
"in": "query"
},
{
"name": "pipelineLengthMiMax",
"description": "The maximum Pipeline Length (Miles) searches for projects with pipeline installation that have a length equal to or less than the value given. The maximum Pipeline Length (Miles) can be used in conjunction with the minimum Pipeline Length (Miles) to select a range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 100
},
"in": "query"
},
{
"name": "pipelineLengthKmMin",
"description": "The minimum Pipeline Length (Kilometers) searches for projects with pipeline installation that have a length equal to or greater than the value given. The minimum Pipeline Length (Kilometers) can be used in conjunction with the maximum Pipeline Length (Kilometers) to select a range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 10
},
"in": "query"
},
{
"name": "pipelineLengthKmMax",
"description": "The maximum Pipeline Length (Kilometers) searches for projects with pipeline installation that have a length equal to or less than the value given. The maximum Pipeline Length (Kilometers) can be used in conjunction with the minimum Pipeline Length (Kilometers) to select a range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 100
},
"in": "query"
},
{
"name": "pipelineDiameterInchesMin",
"description": "The minimum Pipeline Diameter (Inches) searches for projects with pipeline installation that have a diameter equal to or greater than the value given. The minimum Pipeline Diameter (Inches) can be used in conjunction with the maximum Pipeline Diameter (Inches) to select a range.",
"schema": {
"format": "double",
"type": "number",
"example": 20
},
"in": "query"
},
{
"name": "pipelineDiameterInchesMax",
"description": "The maximum Pipeline Diameter (Inches) searches for projects with pipeline installation that have a diameter equal to or less than the value given. The maximum Pipeline Diameter (Inches) can be used in conjunction with the minimum Pipeline Diameter (Inches) to select a range.",
"schema": {
"format": "double",
"type": "number",
"example": 35
},
"in": "query"
},
{
"name": "pipelineDiameterCmMin",
"description": "The minimum Pipeline Diameter (Centimeters) searches for projects with pipeline installation that have a diameter equal to or greater than the value given. The minimum Pipeline Diameter (Centimeters) can be used in conjunction with the maximum Pipeline Diameter (Centimeters) to select a range.",
"schema": {
"format": "double",
"type": "number",
"example": 10
},
"in": "query"
},
{
"name": "pipelineDiameterCmMax",
"description": "The maximum Pipeline Diameter (Centimeters) searches for projects with pipeline installation that have a diameter equal to or less than the value given. The maximum Pipeline Diameter (Centimeters) can be used in conjunction with the minimum Pipeline Diameter (Centimeters) to select a range.",
"schema": {
"format": "double",
"type": "number",
"example": 35
},
"in": "query"
},
{
"name": "pecTiming",
"description": "PEC Timing of the project. Each PEC Report is identified by one of six timing phases. This parameter supports multiple values. \n\n\nList of supported values:
\n\n To search by Capital Projects use: \n P1 - Planning\n P2 - Planning\n E1 - Engineering\n E2 - Engineering \n C1 - Construction \n\n To search by Maintenance Projects use:\n C2 - Maintenance\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "P1"
}
},
"in": "query"
},
{
"name": "pecActivityDesc",
"description": "PEC Activity of the project. Each PEC Report is identified by one of forty-five activity phases. This parameter supports multiple values. \n\n\nList of supported values:
\n\n P1 - Planning:\n Market Analysis\n Site Study\n Project Scope\n Economic Evaluation\n Energy Analysis\n Equipment Studies\n Preliminary Design\n Site Selection\n Detailed Design\n Technology Comparison\n Fuel Strategy\n Capital Estimating\n Site Characterization\n Dismantling\n Demolition\n Project Justification\n AFE Submittal\n\n P2 - Planning:\n Permitting\n Owner Review of Issue\n\n E1 - Engineering:\n Capital Approval\n\n E2 - Engineering:\n Purchasing\n Preliminary Engineering\n Definitive Estimating\n Cost Analysis\n Planning and Scheduling\n Site Preparation\n Safety Studies\n Unit Simulation\n Unit Strategies\n Unit Control\n Detailed Engineering\n Cost Control\n Expediting\n\n C1 - Construction:\n Structural Erection\n Construction - Union\n Construction - Merit Shop\n Inspection\n Venture Capitalization Report\n Mechanical Completion\n Final Commissioning\n Completion/Start-Up\n\n C2 - Maintenance:\n Maintenance Programs\n Contract Maintenance\n Long-term Maintenance\n Scheduled Maintenance\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Demolition"
}
},
"in": "query"
},
{
"name": "projectProbability",
"description": "Project Probability. Project Probability is IIR's research team's assessment of a project's likelihood of moving forward. This parameter supports multiple values. \r\n\r\n\r\nList of supported values:
\r\n\r\n Low \r\n Medium\r\n High\r\n Completed\r\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Medium"
}
},
"in": "query"
},
{
"name": "constructionLaborPreference",
"description": "Search by Construction Labor Preference: Non-Union (0) or Union (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "operationsLaborPreference",
"description": "Search by Operations Labor Preference: Non-Union (0) or Union (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projectSicId",
"description": "Project SIC ID. Searching by Project SIC ID can be done by entering the four-digit SIC Code. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "plantSicId",
"description": "Plant SIC ID. Searching by Plant SIC ID can be done by entering the four-digit SIC Code. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "sicProductId",
"description": "Project SIC Product Code. This parameter supports multiple values. To get the list of\nsupported SIC Products, please refer to the [/sicProducts](#post-/sicProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1311*0008"
}
},
"in": "query",
"required": false
},
{
"name": "sicProductDesc",
"description": "Project SIC Product description. Searching by Project SIC Product description can be done by entering one or multiple SIC Product descriptions. This parameter supports multiple values. To get the list of supported SIC Products, please refer to the [/sicProducts](#post-/sicProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Pipelines"
}
},
"in": "query"
},
{
"name": "afeYearMonthMin",
"description": "The Authorization for Expenditure minimum Year/Month searches for projects equal to or greater than the date given. To search by minimum AEF Year/Month simply enter the date using the correct format (YYYYMM). The AFE minimum Year/Month can be used in conjunction with the maximum Year/Month to select a date range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 201901
},
"in": "query"
},
{
"name": "afeYearMonthMax",
"description": "The Authorization for Expenditure maximum Year/Month searches for projects equal to or less than the date given. To search by maximum AEF Year/Month simply enter the date using the correct format (YYYYMM). The AFE maximum Year/Month can be used in conjunction with the minimum Year/Month to select a date range.\n\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 201912
},
"in": "query"
},
{
"name": "rfqYearMonthMin",
"description": "The Request for Quotation minimum Year/Month searches for projects equal to or greater than the date given. To search by minimum RFQ Year/Month simply enter the date using the correct format (YYYYMM). The RFQ minimum Year/Month can be used in conjunction with the maximum Year/Month to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 201901
},
"in": "query"
},
{
"name": "rfqYearMonthMax",
"description": "The Request for Quotation maximum Year/Month searches for projects equal to or less than the date given. To search by maximum RFQ Year/Month simply enter the date using the correct format (YYYYMM). The RFQ maximum Year/Month can be used in conjunction with the minimum Year/Month to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 202101
},
"in": "query"
},
{
"name": "bidDocYearMonthMin",
"description": "The Bid Documents minimum Year/Month searches for projects equal to or greater than the date given. To search by minimum Bid Doc Year/Month simply enter the date using the correct format (YYYYMM). The Bid Doc minimum Year/Month can be used in conjunction with the maximum Year/Month to select a date range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 201901
},
"in": "query"
},
{
"name": "bidDocYearMonthMax",
"description": "The Bid Documents maximum Year/Month searches for projects equal to or less than the date given. To search by maximum Bid Doc Year/Month simply enter the date using the correct format (YYYYMM). The Bid Doc maximum Year/Month can be used in conjunction with the minimum Year/Month to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 201912
},
"in": "query"
},
{
"name": "kickoffYearMonthMin",
"description": "The Kickoff minimum Year/Month searches for projects equal to or greater than the date given. To search by minimum Kickoff Year/Month simply enter the date using the correct format (YYYYMM). The Kickoff minimum Year/Month can be used in conjunction with the maximum Year/Month to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 201902
},
"in": "query"
},
{
"name": "kickoffYearMonthMax",
"description": "The Kickoff maximum Year/Month searches for projects equal to or less than the date given. To search by maximum Kickoff Year/Month simply enter the date using the correct format (YYYYMM). The Kickoff maximum Year/Month can be used in conjunction with the minimum Year/Month to select a date range.",
"schema": {
"format": "int32",
"type": "integer",
"example": 202102
},
"in": "query"
},
{
"name": "completionDateMin",
"description": "The minimum completion date searches for projects equal to or greater than the date given. To search by minimum completion date simply enter the date using the correct format (YYYY-MM-DD). The minimum completion date can be used in conjunction with the maximum date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "completionDateMax",
"description": "The maximum completion date searches for projects equal to or greater than the date given. To search by maximum completion date simply enter the date using the correct format (YYYY-MM-DD). The maximum completion date can be used in conjunction with the minimum date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region ID will provide results based on a specific market region. This parameter supports multiple values. \n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region name will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "tradingRegionId",
"description": "Trading Region ID. Searching by Trading Region ID will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values. \n\n\nList of supported values:
\n\n 1 - PADD I\n 2 - PADD II \n 3 - PADD III\n 4 - PADD IV \n 5 - PADD V \n 6 - Western Canada \n 7 - Eastern Canada\n 8 - Central Canada \n 9 - Caribbean\n 10 - Mexico \n 11 - South America \n 13 - Central America\n 14 - Africa\n 15 - Central Asia\n 16 - Australia\n 17 - Mediterranean\n 18 - Eastern Europe\n 19 - Northwest Europe\n 20 - Middle East \n 21 - South Asia\n 22 - Southeast Asia\n 23 - North Asia\n 24 - Russia\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "tradingRegionName",
"description": "Trading Region name. Searching by Trading Region description will provide results based on specific regions. US Regions are defined by industry standards and grouped by PADDs. This parameter supports multiple values.\n\n\nList of supported values:
\n\n PADDs: \n I\n II\n III\n IV\n V\n Other Regions:\n Western Canada\n Eastern Canada\n Central Canada\n Caribbean\n Mexico\n South America\n Central America\n Africa\n Central Asia\n Australia\n Mediterranean\n Eastern Europe\n Northwest Europe\n Middle East \n South Asia\n Southeast Asia\n North Asia\n Russia\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "I"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values. \n\n\nList of supported values:
\n\n 1 - North America \n 2 - Middle America \n 3 - South America \n 4 - Europe\n 5 - Africa \n 6 - Asia \n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 4
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Europe"
}
},
"in": "query"
},
{
"name": "engKeyNeedsCivil",
"description": "Search by Civil engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsElectrical",
"description": "Search by Electrical engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsEnvironmental",
"description": "Search by Environmental engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsHvac",
"description": "Search by HVAC engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsInstrumentation",
"description": "Search by Instrumentation engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsMechanical",
"description": "Search by Mechanical engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsProcess",
"description": "Search by Process engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "engKeyNeedsStructural",
"description": "Search by Structural engineering key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsCivil",
"description": "Search by Civil construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsElectrical",
"description": "Search by Electrical construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsEnvironmental",
"description": "Search by Environmental construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsGeneral",
"description": "Search by General construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsHvac",
"description": "Search by HVAC construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsInstrumentation",
"description": "Search by Instrumentation construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsMechanical",
"description": "Search by Mechanical construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "contrKeyNeedsStructural",
"description": "Search by Structural construction key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsArchitectural",
"description": "Search by Architectural equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsBatchProcess",
"description": "Search by Batch Process equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsCivilSite",
"description": "Search by Civil/Site equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsCommunications",
"description": "Search by Communications equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsContinuousProcess",
"description": "Search by Continuous Process equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsControlRoom",
"description": "Search by Control Room equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsElectrical",
"description": "Search by Electrical equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsEnvironmental",
"description": "Search by Environmental equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsFeedStock",
"description": "Search by Feedstock equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsHeatTransfer",
"description": "Search by Heat Transfer equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsHvac",
"description": "Search by HVAC equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsInstrumentation",
"description": "Search by Instrumentation equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsInsulationCoatings",
"description": "Search by Insulation/Coatings equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsMechanical",
"description": "Search by Mechanical equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsMiningEquip",
"description": "Search by Mining equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsMaterialHandling",
"description": "Search by Material Handling equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsNde",
"description": "Search by NDE equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsPackaging",
"description": "Search by Packaging equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsPipingFittings",
"description": "Search by Piping/Fittings equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsProcessEquip",
"description": "Search by Process Equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsPumps",
"description": "Search by Pumps equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsStructural",
"description": "Search by Structural equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsStorage",
"description": "Search by Storage equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsTransportation",
"description": "Search by Transportation equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsUtilities",
"description": "Search by Utilities equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "projKeyNeedsValves",
"description": "Search by Valves equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsIep",
"description": "Search by IEP equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsBoiler",
"description": "Search by Boiler equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsTurbine",
"description": "Search by Turbine equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsGenerator",
"description": "Search by Generator equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsCogen",
"description": "Search by Cogen equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsIncinerator",
"description": "Search by Incinerator equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsEngine",
"description": "Search by Engine equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsEnergyStorage",
"description": "Search by Energy Storage equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "energyKeyNeedsPowerToX",
"description": "Search by Power-to-X equipment key needs.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "environmentalAir",
"description": "Search for projects requiring Air environmental equipment or services.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "environmentalLand",
"description": "Search for projects requiring Land environmental equipment or services.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "environmentalWater",
"description": "Search for projects requiring Water environmental equipment or services.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "flagBess",
"description": "Battery Energy Storage System Industry Flag.",
"schema": {
"format": "int64",
"type": "integer"
},
"in": "query"
},
{
"name": "sort",
"description": "Results can be sorted by the field specified. ",
"schema": {
"type": "string",
"example": "projectName"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of project results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned project results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectSummaryResponse"
},
"examples": {
"projectSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"projects": [
{
"projectId": 300007092,
"projectName": "ATTAPU GRASSROOT 66MW NAM KONG II HYDRO POWER STATION",
"industryCode": "01",
"industryCodeDesc": "Power",
"pecZone": "LO*01",
"tiv": 135000000,
"releaseDate": "2018-01-25T20:21:00Z[UTC]",
"plantOwnerName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"plantId": 1091071,
"plantName": "Nam Kong II Hydro Power Station",
"plantPhysicalAddress": {
"stateName": "Attapu",
"countryName": "Laos"
}
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getProjectSummary",
"summary": "Return Project(s) Summary",
"description": "Returns up to 100 project records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Project ID returned here and refer to the [/projects/detail](#post-/projects/detail) endpoint.\n\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values:\n\n projectId=300007092&projectId=300085254\n\nSearching by wildcard keyword:\n\n projectName=Joao\n\n Example of returned projects:\n \"projectName\": \"CHOPIM GRASSROOT 60MW SAO JOAO HYDRO POWER STATION\"\n \"projectName\": \"IJUI 77MW GRASSROOT PASSO SAO JOAO HYDRO POWER PLANT\"\n \"projectName\": \"SAO JOAO DA BARRA ACU I 2100MW GRASSROOT COAL POWER STATION\"\n \nThese are the supported parameters:"
}
},
"/companies/summary": {
"summary": "Find Company Summary",
"description": "Returns Company Summary.",
"post": {
"tags": [
"Company Search"
],
"parameters": [
{
"name": "companyId",
"description": "The ID of the company. The Company ID is a unique seven-digit IIR database ID number assigned to each company profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1033002
}
},
"in": "query"
},
{
"name": "companyName",
"description": "Name of the company. Searching by company name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Royal"
}
},
"in": "query"
},
{
"name": "previousName",
"description": "Previous name of the company. Searching by the previous company name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Royal"
}
},
"in": "query"
},
{
"name": "classificationId",
"description": "Classification ID of the company. A company can be classified in various types. Search by classification ID using any of the supported values:\n\n P - Parent\n H - Holding\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "P"
}
},
"in": "query"
},
{
"name": "classificationDesc",
"description": "Classification of the company. A company can be classified in various types. Search by classification using any of the supported values:\n\n Parent\n Holding\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Parent"
}
},
"in": "query"
},
{
"name": "companyStatusId",
"description": "Status ID of the company. The company status allows to search for companies in various classifications. This parameter supports multiple values.\n\n C - Active \n B - Closed\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "C"
}
},
"in": "query"
},
{
"name": "companyStatusDesc",
"description": "Status description of the company. The company status allows to search for companies in various statuses. This parameter supports multiple values.\n\n Active \n Closed\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Active"
}
},
"in": "query"
},
{
"name": "companyType",
"description": "Company Type. Search for companies that are defined by a particular company type. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Manufacturing\n Distribution & Warehousing\n Venture Capital/Financial\n Governmental\n Hospital\n University/Education\n Mining\n Energy & Fuel Production\n Real Estate\n Data Centers\n Power Generation\n Electricity Transmission/Distribution\n Architectural\n Engineering\n Construction\n Environmental, Health & Safety \n Operations\n Demolition\n Training\n Consulting\n Maintenance\n Rentals\n Sales & Marketing\n Distributor & Manufacturers Rep \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Manufacturing"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n \n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 4
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Europe"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the company’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the company’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City name of the company’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the company’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the company’s physical address. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone of the company. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*01"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. Companies are assigned an industry based on the plants that the company owns. Note that not all companies have an industry association. Search for companies using the two digit industry code. This parameter supports multiple values. \n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals\n 03 - Oil & Gas Pipelines\n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI)\n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Companies are assigned an industry based on the plants that the company owns. Note that not all companies have an industry association. Search for companies using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for company records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The company minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for company records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The company maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2023-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new company records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The company minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "1988-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new company records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The company maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2023-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of company results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned company results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/companySummaryResponse"
},
"examples": {
"companySummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"companies": [
{
"companyId": 1029753,
"companyName": "Enbridge Pipelines Incorporated",
"companyStatusDesc": "Active",
"classificationDesc": "Parent",
"physicalAddress": {
"addressLine1": "10201 Jasper Avenue",
"city": "Edmonton",
"stateName": "Alberta",
"postalCode": "T5J3N7",
"countryName": "Canada",
"countyName": "Division No. 11"
},
"companiesOwnedCount": 1,
"plantsParentCount": 1,
"plantsOwnedCount": 40,
"plantsOperatedCount": 40,
"projectsAssociatedCount": 22,
"unitsOwnedCount": 130,
"tLinesOwnedCount": 0,
"pipelinesOwnedCount": 2
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getCompanySummary",
"summary": "Return Company(s) Summary",
"description": "Returns up to 100 company records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Company ID returned here and refer to the [/companies/detail](#post-/companies/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n companyId=3034087&companyId=3076615\n \nSearching by wildcard keyword:\n\n companyName=Royal\n\n Example of returned companies:\n \"companyName\": \"Bernard Royal Dauphine\"\n \"companyName\": \"Canadian Royalties Incorporated\"\n \n \nThese are the supported parameters:"
}
},
"/companies/detail": {
"summary": "Find Company Detail by ID",
"description": "Returns Company Details",
"post": {
"tags": [
"Company Search"
],
"parameters": [
{
"name": "companyId",
"description": "The ID of the company. The Company ID is a unique number assigned to each company. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1033002
}
},
"in": "query",
"required": false
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of company results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned company results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/companyDetailResponse"
},
"examples": {
"companyDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"companies": [
{
"companyId": 1029753,
"companyName": "Enbridge Pipelines Incorporated",
"companyStatusId": "C",
"companyStatusDesc": "Active",
"classificationId": "P",
"classificationDesc": "Parent",
"industryCode": [
{
"industryCode": "02",
"industryCodeDesc": "Terminals"
},
{
"industryCode": "03",
"industryCodeDesc": "Oil & Gas Pipelines"
}
],
"webSite": "http://www.enbridge.com",
"pecZone": "AB*03",
"mailingAddress": {
"addressLine1": "P O Box 398",
"city": "Edmonton",
"stateName": "Alberta",
"postalCode": "T5J2J9",
"countryName": "Canada"
},
"physicalAddress": {
"addressLine1": "10201 Jasper Avenue",
"city": "Edmonton",
"stateName": "Alberta",
"postalCode": "T5J3N7",
"countryName": "Canada",
"countyName": "Division No. 11"
},
"phone": {
"cc": 1,
"number": "7804205210"
},
"owner": [
{
"companyId": 1065664,
"companyName": "Enbridge Incorporated",
"companyWebsite": "http://www.enbridge.com",
"ownerPercent": 100,
"classificationId": "P",
"classificationDesc": "Parent",
"address": {
"addressLine1": "3000 Fifth Avenue Place",
"addressLine2": "425 1st Street Southwest",
"city": "Calgary",
"stateName": "Alberta",
"countryName": "Canada",
"postalCode": "T2P3L8"
}
}
],
"companiesOwnedCount": 1,
"companiesOwned": [
{
"companyId": 1034479
}
],
"plantsParentCount": 1,
"plantsParent": [
{
"plantId": 1052414
}
],
"plantsOwnedCount": 40,
"plantsOwned": [
{
"plantId": 1058824
},
{
"plantId": 1091020
},
{
"plantId": 3009639
},
{
"plantId": 3041292
},
{
"plantId": 3041298
},
{
"plantId": 3009178
},
{
"plantId": 1018596
},
{
"plantId": 1056788
},
{
"plantId": 1056500
},
{
"plantId": 1052414
},
{
"plantId": 3041296
},
{
"plantId": 1065238
},
{
"plantId": 1057304
},
{
"plantId": 1056507
},
{
"plantId": 1057632
},
{
"plantId": 1073998
},
{
"plantId": 1056506
},
{
"plantId": 3041648
},
{
"plantId": 1057308
},
{
"plantId": 3053551
},
{
"plantId": 1056503
},
{
"plantId": 1053630
},
{
"plantId": 1040659
},
{
"plantId": 3052636
},
{
"plantId": 3036697
},
{
"plantId": 1056504
},
{
"plantId": 1061943
},
{
"plantId": 1061944
},
{
"plantId": 1056790
},
{
"plantId": 3041297
},
{
"plantId": 1057303
},
{
"plantId": 1073987
},
{
"plantId": 1073999
},
{
"plantId": 1073997
},
{
"plantId": 1027547
},
{
"plantId": 1056785
},
{
"plantId": 1057521
},
{
"plantId": 1059556
},
{
"plantId": 1059748
},
{
"plantId": 1072339
}
],
"plantsOperatedCount": 40,
"plantsOperated": [
{
"plantId": 1057308
},
{
"plantId": 1056500
},
{
"plantId": 1057632
},
{
"plantId": 1056503
},
{
"plantId": 1056504
},
{
"plantId": 1056506
},
{
"plantId": 1056507
},
{
"plantId": 1058824
},
{
"plantId": 1061943
},
{
"plantId": 1061944
},
{
"plantId": 1065238
},
{
"plantId": 1073997
},
{
"plantId": 1072339
},
{
"plantId": 1073987
},
{
"plantId": 1052414
},
{
"plantId": 1057304
},
{
"plantId": 1057303
},
{
"plantId": 1059748
},
{
"plantId": 1059556
},
{
"plantId": 1056785
},
{
"plantId": 1056790
},
{
"plantId": 1056788
},
{
"plantId": 1057521
},
{
"plantId": 1027547
},
{
"plantId": 1053630
},
{
"plantId": 3009677
},
{
"plantId": 1018596
},
{
"plantId": 3009639
},
{
"plantId": 3052636
},
{
"plantId": 3053551
},
{
"plantId": 3041296
},
{
"plantId": 3041297
},
{
"plantId": 3041298
},
{
"plantId": 3041648
},
{
"plantId": 3036697
},
{
"plantId": 3009178
},
{
"plantId": 1091020
},
{
"plantId": 1040659
},
{
"plantId": 1073998
},
{
"plantId": 1073999
}
],
"projectsAssociatedCount": 7,
"projectsAssociated": [
{
"projectId": 200007635
},
{
"projectId": 300015154
},
{
"projectId": 300020402
},
{
"projectId": 300020634
},
{
"projectId": 300020639
},
{
"projectId": 300020643
},
{
"projectId": 300045682
}
],
"unitsOwnedCount": 130,
"unitsOwned": [
{
"unitId": 2013597
},
{
"unitId": 2013653
},
{
"unitId": 1047695
},
{
"unitId": 1047696
},
{
"unitId": 1047697
},
{
"unitId": 1047698
},
{
"unitId": 1047699
},
{
"unitId": 1047700
},
{
"unitId": 1047701
},
{
"unitId": 1047702
},
{
"unitId": 1044236
},
{
"unitId": 1044394
},
{
"unitId": 2038084
},
{
"unitId": 2076481
},
{
"unitId": 2042043
},
{
"unitId": 2042048
},
{
"unitId": 2042053
},
{
"unitId": 2042047
},
{
"unitId": 2076627
},
{
"unitId": 2013810
},
{
"unitId": 2013813
},
{
"unitId": 2042050
},
{
"unitId": 2053441
},
{
"unitId": 2013594
},
{
"unitId": 2013596
},
{
"unitId": 2013666
},
{
"unitId": 2042056
},
{
"unitId": 2013811
},
{
"unitId": 2013664
},
{
"unitId": 2053451
},
{
"unitId": 2037662
},
{
"unitId": 2013657
},
{
"unitId": 2055266
},
{
"unitId": 2053463
},
{
"unitId": 2042297
},
{
"unitId": 2042298
},
{
"unitId": 2053464
},
{
"unitId": 2013658
},
{
"unitId": 2037890
},
{
"unitId": 2013790
},
{
"unitId": 2013554
},
{
"unitId": 2008918
},
{
"unitId": 2013823
},
{
"unitId": 1047690
},
{
"unitId": 1047689
},
{
"unitId": 2054261
},
{
"unitId": 1044393
},
{
"unitId": 2013663
},
{
"unitId": 2013835
},
{
"unitId": 2037657
},
{
"unitId": 2013829
},
{
"unitId": 2013824
},
{
"unitId": 2013822
},
{
"unitId": 2013655
},
{
"unitId": 2013671
},
{
"unitId": 1063961
},
{
"unitId": 1063892
},
{
"unitId": 1063894
},
{
"unitId": 2013561
},
{
"unitId": 2013586
},
{
"unitId": 2013555
},
{
"unitId": 2013661
},
{
"unitId": 2013654
},
{
"unitId": 2008908
},
{
"unitId": 1044240
},
{
"unitId": 2053462
},
{
"unitId": 1026682
},
{
"unitId": 2077059
},
{
"unitId": 2013667
},
{
"unitId": 2013659
},
{
"unitId": 2013662
},
{
"unitId": 2076480
},
{
"unitId": 2013821
},
{
"unitId": 2037661
},
{
"unitId": 1032666
},
{
"unitId": 1032672
},
{
"unitId": 1031279
},
{
"unitId": 2042044
},
{
"unitId": 2076482
},
{
"unitId": 2042049
},
{
"unitId": 2064556
},
{
"unitId": 2037891
},
{
"unitId": 1030283
},
{
"unitId": 1042681
},
{
"unitId": 1042683
},
{
"unitId": 1042686
},
{
"unitId": 1042689
},
{
"unitId": 1042692
},
{
"unitId": 1042693
},
{
"unitId": 1042694
},
{
"unitId": 1042695
},
{
"unitId": 1042697
},
{
"unitId": 1042698
},
{
"unitId": 1042700
},
{
"unitId": 2053446
},
{
"unitId": 2053442
},
{
"unitId": 2009279
},
{
"unitId": 2009267
},
{
"unitId": 2009238
},
{
"unitId": 2037318
},
{
"unitId": 2077060
},
{
"unitId": 2013805
},
{
"unitId": 2013807
},
{
"unitId": 2013802
},
{
"unitId": 2013832
},
{
"unitId": 2013833
},
{
"unitId": 1044395
},
{
"unitId": 1044396
},
{
"unitId": 2008854
},
{
"unitId": 2008853
},
{
"unitId": 2042299
},
{
"unitId": 2076628
},
{
"unitId": 2013665
},
{
"unitId": 2013579
},
{
"unitId": 1080467
},
{
"unitId": 1080468
},
{
"unitId": 2064525
},
{
"unitId": 2013834
},
{
"unitId": 2013816
},
{
"unitId": 2013801
},
{
"unitId": 2013650
},
{
"unitId": 2013651
},
{
"unitId": 2013593
},
{
"unitId": 2037317
},
{
"unitId": 1047685
},
{
"unitId": 1047686
},
{
"unitId": 1047691
},
{
"unitId": 1047692
},
{
"unitId": 1047693
},
{
"unitId": 1047694
}
],
"tLinesOwnedCount": 0,
"pipelinesOwnedCount": 2,
"pipelinesOwned": [
{
"pipelineId": 3501169
},
{
"pipelineId": 3501168
}
],
"liveDate": "1992-09-30T05:00:00Z[UTC]",
"releaseDate": "2018-01-08T17:31:23Z[UTC]"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getCompanyDetail",
"summary": "Return Company(s) Detail",
"description": "Returns up to 5 company records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage. \n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample: \n\n companies/detail?companyId=3034087&fields=companyId&fields=companyName&fields=companyStatusDesc&fields=physicalAddress.stateName\n\nThese are the supported parameters:"
}
},
"/projects/detail": {
"summary": "Find Project Detail by ID",
"description": "Return project details. ",
"post": {
"tags": [
"Project Search"
],
"parameters": [
{
"name": "projectId",
"description": "The ID of the project. The Project ID is a unique eight-digit number used by IIR that is assigned to an individual project. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 300034328
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of project results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned project results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/projectDetailResponse"
},
"examples": {
"projectDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"projects": [
{
"projectId": 300007092,
"projectName": "ATTAPU GRASSROOT 66MW NAM KONG II HYDRO POWER STATION",
"industryCode": "01",
"industryCodeDesc": "Power",
"pecZone": "LO*01",
"tiv": 135000000,
"currency": "USD",
"offshore": 0,
"releaseDate": "2018-01-25T20:21:00Z[UTC]",
"projectStatusId": "A",
"projectStatusDesc": "Active",
"projectSicId": "4931",
"projectSicDesc": "Electricity/Steam [IPP]",
"projectTypeId": 1,
"projectTypeDesc": "Grassroot",
"projectOwnerId": 1113989,
"projectOwnerName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"sicProductId": "4931*0003",
"sicProductDesc": "Nonutility Owned Power Generation",
"liveDate": "2010-02-09T16:18:05Z[UTC]",
"constructionLaborPreference": 0,
"plantId": 1091071,
"plantName": "Nam Kong II Hydro Power Station",
"plantStatusDesc": "Under Construction",
"plantSicId": "4931",
"plantSicDesc": "Electricity/Steam [IPP]",
"plantOwnerId": 1113989,
"plantOwnerName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"plantParentId": 1113985,
"plantParentName": "Hoang Anh Gia Lai Group",
"plantLongitude": 107.060429,
"plantLatitude": 14.561557,
"flagBoiler": 0,
"flagIncinerator": 0,
"unitName": "Nam Cong II 01 Nam Cong II 02 Nam Cong II 03",
"plantPhysicalAddress": {
"addressLine1": "Phu Vong Distrcit",
"addressLine2": "Attapeu province",
"stateName": "Attapu",
"postalCode": "00000",
"countryName": "Laos"
},
"plantPhone": "+84 592222257",
"tradingRegionId": 22,
"tradingRegionName": "Southeast Asia",
"marketRegionId": "SA",
"marketRegionName": "Southeast Asia",
"worldRegionId": 6,
"worldRegionName": "Asia",
"pecTiming": "C1",
"pecActivityId": "36",
"pecActivityDesc": "Construction - Merit Shop",
"projectProbability": "High (81-99%)",
"scope": "Hoang Anh Gia Lai Hydropower Join Stock Company (Owner) and Nam Bo Dong Service Construction (Contractor) continues with Construction of a Grassroot 66MW Hydro Power Station. DETAILS: Construct 66MW Hydroelectric Power Plant utlizing (3) 22MW Francis Hydro Turbine/Generator Sets and associated equipment to generate renewable energy. REQUIRES: Powerhouse, Transmission Line, Dam, Headrace Tunnel, Tailrace Tunnel, Gates, Penstocks, Switchgear, Hydro Turbine/Generators, Transformers, Breakers, Lube Oil System, Rotors, Nozzles, Fans, I&C System, Draft Tubes, Operator Consoles. ENVIRONMENTAL: (L) Dredging, Excavation, Flood Control, Spill Containment; (W) Fish and Wildlife Protection.\r\r",
"schedule": "Hoang Anh Gia Lai Hydropower Join Stock Company and Nam Bo Dong Service Construction continues with construction through 1Q14 (Jan). Hoang Anh Gia Lai Hydropower Join Stock Company and Nam Bo Dong Service Construction releases remaining Equipment RFQs and Construction Subcontractor Bid Documents 3Q11 (Aug) - 3Q13. Construction Kick-Off is scheduled for 1Q11 (Mar). Project Completion is Expected 1Q14 (Jan).",
"afeYearMonth": 201001,
"bidDocYearMonth": 201001,
"completionDate": "2014-01-15T06:00:00Z[UTC]",
"completionDatePrecision": "MONTH",
"longLeadYearMonth": 201001,
"rfqYearMonth": 201001,
"kickoffYearMonth": 201001,
"kickoffSlippage": -9,
"constructionDuration": 49,
"environmental": {
"air": 0,
"land": 1,
"water": 1
},
"engineeringKeyNeeds": {
"civil": 0,
"electrical": 0,
"environmental": 0,
"hvac": 0,
"instrumentation": 0,
"mechanical": 0,
"process": 0,
"structural": 0
},
"constructionKeyNeeds": {
"civil": 1,
"electrical": 1,
"environmental": 1,
"hvac": 1,
"instrumentation": 1,
"mechanical": 1,
"structural": 1,
"general": 1
},
"projectKeyNeeds": {
"architectural": 0,
"batchProcess": 0,
"civilSite": 0,
"communications": 1,
"continuousProcess": 0,
"controlRoom": 0,
"electrical": 0,
"environmental": 0,
"feedstock": 0,
"heatTransfer": 0,
"hvac": 0,
"instrumentation": 0,
"insulationCoatings": 0,
"mechanical": 0,
"miningEquip": 0,
"materialHandling": 0,
"nde": 0,
"packaging": 0,
"pipingFittings": 0,
"processEquip": 0,
"pumps": 1,
"structural": 0,
"storage": 0,
"transportation": 1,
"utilities": 1,
"valves": 1
},
"matterPhase": {
"gas": 0,
"liquid": 1,
"plasma": 0,
"solid": 0,
"vapor": 0
},
"energyProcessKeyNeeds": {
"iep": 0,
"boiler": 0,
"turbine": 1,
"generator": 1,
"cogen": 0,
"incinerator": 0,
"engine": 0
},
"buy": {
"electricity": 0,
"fuel": 0,
"steam": 0
},
"sell": {
"electricity": 1,
"fuel": 0,
"steam": 0
},
"projectFuelTypeCode": "05",
"projectFuelTypeDesc": "Hydro",
"projectCapacity": [
{
"productId": 80,
"productDesc": "Chickens, Young (Broilers, Fryers, Roasters And Capons), Not Cut In Pieces, Frozen",
"plannedCapacity": 50000,
"uom": "KG"
},
{
"productId": "000220",
"productDesc": "Sea Bass (Dicentrarchus Labrax, Dicentrarchus Punctatus), Excluding Fillets, Livers And Roes, Frozen",
"installedCapacity": 500000,
"plannedCapacity": 50000,
"uom": "KG"
},
{
"productId": 4278,
"productDesc": "Ramie And Other Vegetable Textile Fibers,Raw Or Processed But Not Spun; Tow, Noils And Waste Of These Fibers (Including Yarn Waste A",
"installedCapacity": 40,
"plannedCapacity": 20,
"uom": "KG"
},
{
"productId": "000521",
"productDesc": "Broad Beans (Vicia Faba Var. Major) And Horse Beans (Vicia Faba Var. Equina And Vicia Faba Var. Minor) Seeds Of A Kind Used For Sowi",
"installedCapacity": 5000,
"uom": "KG"
},
{
"productId": 2559,
"productDesc": "Medicaments Containing Penicillins Or Derivatives Thereof, With A Penicillanic Acid Structure, Or Streptomycins Or Derivatives, Neso",
"plannedCapacity": 5222,
"uom": "Doses"
},
{
"productId": "002577",
"productDesc": "Other Medicaments Containing Alkaloids Or Derivatives Thereof But Notcontaining Hormones, Other Products Of Head 2937 Or Antibiotics",
"installedCapacity": 250000,
"uom": "Doses"
},
{
"productId": "002574",
"productDesc": "Other Medicaments Primarily Affecting The Central Nervous System Not Elsewhere Specified Or Included",
"installedCapacity": 1000,
"uom": "Doses"
},
{
"productId": 109,
"productDesc": "Hams, Shoulders And Cuts Thereof, Of Swine, Bone In, Salted, In Brine, Dried Or Smoked",
"installedCapacity": 30000,
"uom": "LBS/D"
},
{
"productId": 2187,
"productDesc": "Methyl Acrylate",
"installedCapacity": 20000,
"plannedCapacity": 1.1,
"uom": "M Lbs/yr"
},
{
"productId": "000522",
"productDesc": "Broad Beans (Vicia Faba Var. Major) And Horse Beans (Vicia Faba Var. Equine And Vicia Faba Var. Minor) Except Seed, Dried, Shelled",
"uom": "KG"
},
{
"productId": 9981,
"productDesc": "Electricity",
"installedCapacity": 250,
"plannedCapacity": 200,
"uom": "MW"
}
],
"projectCompanies": [
{
"companyId": 3042104,
"companyName": "Nam Bo Dong Service Construction Company Limitted",
"firmTypeDesc": "Contractor",
"physicalAddress": {
"addressLine1": "449/62 Truong Chinh,",
"addressLine2": "Ward 14, Tan Binh District,",
"city": "Ho Chi Minh City",
"stateName": "HN",
"postalCode": "00",
"countryName": "VN"
},
"projectContact": {
"contactId": 3247445,
"firstName": "Hoa Binh",
"lastName": "Nguyen",
"titleId": 728,
"titleDesc": "Project Manager",
"phone": {
"cc": 84,
"number": "973325333"
},
"emailAddress": "binhnguyen@nambodong.com."
}
},
{
"companyId": 3042104,
"companyName": "Nam Bo Dong Service Construction Company Limitted",
"firmTypeDesc": "Contractor",
"physicalAddress": {
"addressLine1": "449/62 Truong Chinh,",
"addressLine2": "Ward 14, Tan Binh District,",
"city": "Ho Chi Minh City",
"stateName": "HN",
"postalCode": "00",
"countryName": "VN"
},
"projectContact": {
"contactId": 3247448,
"firstName": "Duc",
"lastName": "Hoang",
"titleId": 1979,
"titleDesc": "Deputy Director",
"phone": {
"cc": 84,
"number": "838130580"
}
}
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"security": [
{
"JWT": [
]
}
],
"operationId": "getProjectDetail",
"summary": "Return Project(s) Detail",
"description": "Returns up to 5 project records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n projects/detail?projectId=300100998&fields=projectId&fields=projectName&fields=tiv&fields=currency&fields=plantPhysicalAddress.postalCode\n\nThese are the supported parameters:"
}
},
"/boilers/summary": {
"summary": "Find Boiler Summary",
"description": "Returns Boiler Summary.",
"post": {
"tags": [
"Boiler Search"
],
"parameters": [
{
"name": "boilerId",
"description": "The ID of the boiler. The Boiler ID is a unique number assigned to each boiler. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 18813
}
},
"in": "query",
"required": false
},
{
"name": "boilerTypeDesc",
"description": "Boiler Type. Each boiler is identified with a type. Types range from Fluidized Bed Boilers to Package Boilers. This parameter supports multiple values.\n\n\n List of supported values:
\n\n Advanced Gas-Cooled Reactor (AGR)\n Basic Gas-Cooled Reactor (Magnox)\n Boiling Water Reactor (BWR)\n Chemical Recovery Boiler\n Dry Bottom Boiler\n Fluidized Bed Boiler\n Heat Recovery Steam Generator (HRSG)\n Incinerator/Mass Burn Boiler\n Pressurized Heavy Water Reactor (CANDU)\n Pressurized Water Reactor (PWR)\n Pyrolysis Boiler\n Watertube Boiler\n Wet Bottom Boiler\n\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Pyrolysis Boiler"
}
},
"in": "query"
},
{
"name": "boilerInformation",
"description": "Boiler Information. Additional information is included for boilers such as Model and Environmental Controls. Searching by Boiler Information can be done using one or multiple keywords to find boilers with specific model numbers or environmental equipment such as baghouses or Low NOx burners. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Burner"
}
},
"in": "query"
},
{
"name": "boilerManufacturerName",
"description": "Manufacturer of the boiler. Boilers are identified by their manufacturer. Searching by Boiler Manufacturer name can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Babcock & Wilcox"
}
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boreas Offshore Windfarm"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. IIR assigns each Boiler to one of twelve industries. Search for boilers using the two digit Industry Code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Search for boilers using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel. To search by multiple values, use the same parameter multiple times with different values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Entergy Corporation"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by operator name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Entergy Louisiana LLC"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Entergy Louisiana LLC"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone. Searching by Zone code can be done by typing in the particular Zone code using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*10"
}
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "GT 06"
}
},
"in": "query"
},
{
"name": "unitTypeId",
"description": "Unit Type ID. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 126
}
},
"in": "query"
},
{
"name": "unitTypeDesc",
"description": "Unit Type description. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "unitStatusDesc",
"description": "Status of the unit. The unit status allows to search for units in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Planned\n On Hold\n Engineered\n Cancelled\n Under Construction\n Operational\n Mothballed\n Closed\n Shuttered\n Removed\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "unitCapacityMwMin",
"description": "The minimum Unit Capacity Megawatts searches for units equal to or greater than the value given. The minimum Unit Capacity Megawatts can be used in conjunction with the maximum Unit Capacity Megawatts to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "unitCapacityMwMax",
"description": "The maximum Unit Capacity Megawatts searches for units equal to or less than the value given. The maximum Unit Capacity Megawatts can be used in conjunction with the minimum Unit Capacity Megawatts to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "unitClassification",
"description": "Unit Ownership Classification. This parameter supports multiple values.",
"schema": {
"enum": [
"Utility",
"Non-Utility"
],
"type": "string",
"example": "Utility"
},
"in": "query"
},
{
"name": "cogenChp",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "powerUsageDesc",
"description": "Power Usage of the unit. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Base Load\n Intermediate Load\n Peak Load\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Base Load"
}
},
"in": "query"
},
{
"name": "unitKickoffDateMin",
"description": "Unit Construction Kickoff Date. To search by minimum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Construction Kickoff date can be used in conjunction with the maximum Unit Kickoff date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitKickoffDateMax",
"description": "Unit Construction Kickoff Date. To search by maximum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Construction Kickoff date can be used in conjunction with the minimum Unit Kickoff date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMin",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by minimum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Start-Up date can be used in conjunction with the maximum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMax",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by maximum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Start-Up date can be used in conjunction with the minimum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMin",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by minimum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Shutdown date can be used in conjunction with the maximum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMax",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by maximum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Shutdown date can be used in conjunction with the minimum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "boilerTempCmin",
"description": "The minimum Boiler Temperature (Celsius) searches for boilers equal to or greater than the value given. The minimum Boiler Temperature (Celsius) can be used in conjunction with the maximum Boiler Temperature (Celsius) to select a temperature range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "boilerTempCmax",
"description": "The maximum Boiler Temperature (Celsius) searches for boilers equal to or less than the value given. The maximum Boiler Temperature (Celsius) can be used in conjunction with the minimum Boiler Temperature (Celsius) to select a temperature range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "boilerTempFmin",
"description": "The minimum Boiler Temperature (Fahrenheit) searches for boilers equal to or greater than the value given. The minimum Boiler Temperature (Fahrenheit) can be used in conjunction with the maximum Boiler Temperature (Fahrenheit) to select a temperature range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "boilerTempFmax",
"description": "The maximum Boiler Temperature (Fahrenheit) searches for boilers equal to or less than the value given. The maximum Boiler Temperature (Fahrenheit) can be used in conjunction with the minimum Boiler Temperature (Fahrenheit) to select a temperature range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 1100
},
"in": "query"
},
{
"name": "boilerPressurePsigMin",
"description": "The minimum Boiler Pressure (PSIG) searches for boiler equal to or greater than the value given. The minimum Boiler Pressure (PSIG) can be used in conjunction with the maximum Boiler Pressure (PSIG) to select a pressure range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "boilerPressurePsigMax",
"description": "The maximum Boiler Pressure (PSIG) searches for boilers equal to or less than the value given. The maximum Boiler Pressure (PSIG) can be used in conjunction with the minimum Boiler Pressure (PSIG) to select a pressure range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "boilerPressureBarMin",
"description": "The minimum Boiler Pressure (BAR) searches for boilers equal to or greater than the value given. The minimum Boiler Pressure (BAR) can be used in conjunction with the maximum Boiler Pressure (BAR) to select a pressure range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "boilerPressureBarMax",
"description": "The maximum Boiler Pressure (BAR) searches for boilers equal to or less than the value given. The maximum Boiler Pressure (BAR) can be used in conjunction with the minimum Boiler Pressure (BAR) to select a pressure range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "boilerSteamCapacityTonMin",
"description": "The minimum Boiler Steam Capacity (TONS/hour) searches for boilers equal to or greater than the value given. The minimum Boiler Steam Capacity (TONS/hour) can be used in conjunction with the maximum Boiler Steam Capacity (TONS/hour) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "boilerSteamCapacityTonMax",
"description": "The maximum Boiler Steam Capacity (TONS/hour) searches for boilers equal to or less than the value given. The maximum Boiler Steam Capacity (TONS/hour) can be used in conjunction with the minimum Boiler Steam Capacity (TONS/hour) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 2000
},
"in": "query"
},
{
"name": "boilerSteamCapacityLbMin",
"description": "The minimum Boiler Steam Capacity (LBS/hour) searches for boilers equal to or greater than the value given. The minimum Boiler Steam Capacity (LBS/hour) can be used in conjunction with the maximum Boiler Steam Capacity (LBS/hour) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "boilerSteamCapacityLbMax",
"description": "The maximum Boiler Steam Capacity (LBS/hour) searches for boilers equal to or less than the value given. The maximum Boiler Steam Capacity (LBS/hour) can be used in conjunction with the minimum Boiler Steam Capacity (LBS/hour) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 2000
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for boiler records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The boiler minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for boiler records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The boiler maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new boiler records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The boiler minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new boiler records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The boiler maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of boiler results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned boiler results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boilerSummaryResponse"
},
"examples": {
"boilerSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"boilers": [
{
"boilerId": 4043,
"boilerName": "Boiler 01",
"boilerTypeDesc": "Dry Bottom Boiler",
"boilerManufacturerName": "ALSTOM Combustion Engineering",
"designFirm": "Brown & Root",
"constructionFirm": "Brown & Root",
"unitId": 1006230,
"unitName": "White Bluff 01",
"plantOwnerName": "Entergy Arkansas Incorporated",
"plantId": 1014425,
"plantName": "White Bluff Power Station",
"plantPhysicalAddress": {
"stateName": "Arkansas",
"countryName": "U.S.A."
},
"fuel": {
"primaryFuel": "Coal Subbituminous"
},
"unitTypeDesc": "Steam Turbine",
"unitCapacity": 50000,
"unitCapacityUom": "MW"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getBoilerSummary",
"summary": "Return Boiler(s) Summary",
"description": "Returns up to 100 boiler records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Boiler ID returned here and refer to the [/boilers/detail](#post-/boilers/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n boilerId=101&boilerId=106108\n \nSearching by wildcard keyword:\n\n boilerInformation=Test\n \n Example of returned boilers:\n \"boilerInformation\" : \"PC Radiant Front-Fired ULNB OFA ESP-CS (LNB HERT Planned Test)\"\n \"boilerInformation\" : \"PC Tangential-Fired SCR ESP-CS FGD-dWStest2\"\n \n\nThese are the supported parameters:"
}
},
"/boilers/detail": {
"summary": "Find Boiler Detail by ID",
"description": "Returns Boiler Details.",
"post": {
"tags": [
"Boiler Search"
],
"parameters": [
{
"name": "boilerId",
"description": "The ID of the boiler. The Boiler ID is a unique number assigned to each boiler. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 18813
}
},
"in": "query",
"required": false
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of boiler results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned boiler results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boilerDetailResponse"
},
"examples": {
"boilerDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"boilers": [
{
"boilerId": 18813,
"boilerName": "Boiler 05 - Updated Boom",
"boilerTypeDesc": "Dry Bottom Boiler",
"boilerManufacturerName": "Babcock & Wilcox",
"boilerInformation": "Opposed-Fired LNB OFA MC (SNCR-2011)",
"boilerSteamCapacity": 3200000,
"steamCapacityUom": "lbs/hr",
"boilerPressure": 2400,
"pressureUom": "PSIG",
"boilerTemperature": 1000,
"designBtuConsumption": 4551,
"temperatureUom": "deg F",
"btuConsumptionUom": "MMBTU/hr",
"unitId": 1008261,
"unitName": "Edge Moor 05",
"plantOwnerName": "Calpine Corporation",
"plantOperatorName": "Calpine Corporation",
"plantId": 1012715,
"plantName": "Edge Moor Power Station",
"plantPhysicalAddress": {
"addressLine1": "200 Hay Road",
"city": "Wilmington",
"stateName": "Delaware",
"postalCode": "19809",
"countryName": "U.S.A.",
"countyName": "New Castle"
},
"plantLatitude": 39.737935,
"plantLongitude": -75.503508,
"unitStatusDesc": "Operational",
"fuel": {
"primaryFuel": "Natural Gas",
"secondaryFuel": "Fuel Oil No. 6 Residual",
"fuelGroup": "Natural Gas"
},
"powerUsageDesc": "Peak Load",
"unitStartupDate": "1973-08-01T05:00:00Z[UTC]",
"unitTypeDesc": "Steam Turbine",
"primarySicId": "4931",
"unitClassification": "Non-Utility",
"worldRegionName": "North America",
"unitCapacity": 100000,
"unitCapacityUom": "MW"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getBoilerDetail",
"summary": "Return Boiler(s) Detail",
"description": "Returns up to 5 boiler records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n boilers/detail?boilerId=18813&fields=boilerId&fields=boilerName&fields=boilerTypeDesc\n\nThese are the supported parameters:"
}
},
"/drives/summary": {
"summary": "Find Drive Summary",
"description": "Returns Drive Summary.",
"post": {
"tags": [
"Drive Search"
],
"parameters": [
{
"name": "driveId",
"description": "The ID of the drive. The Drive ID is a unique number assigned to each drive. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 106108
}
},
"in": "query",
"required": false
},
{
"name": "driveTypeDesc",
"description": "Drive Type description. Each drive is identified with a type. Types are steam or combustion drive. This parameter supports multiple values.\n\n\n List of supported values:
\n\n Aeroderivative Combustion Turbine\n ST Steam Turbine\n HT Hydraulic Turbine\n IC Internal Combustion Engine\n Heavy Frame Combustion Turbine\n WT Wind Turbine\n EM Electric Motor\n Turbo Expander\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ST Steam Turbine"
}
},
"in": "query"
},
{
"name": "driveManufacturerName",
"description": "Manufacturer name of the drive. Combustion and Steam Drives are identified by their manufacturer. Searching by Drive Manufacturer can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "General Electric"
}
},
"in": "query"
},
{
"name": "driveCategory",
"description": "Category of the drive. This parameter supports multiple values.\n\n\n List of supported values:
\n\n Generator\n Compressor\n Pump\n\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Generator"
}
},
"in": "query"
},
{
"name": "driveSeries",
"description": "Drive Series. Each drive is associated with a Drive Series. Searching by drive series can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SGT5-2000E"
}
},
"in": "query"
},
{
"name": "driveInformation",
"description": "Drive Information. Additional information is included for drives such as Drive Model, Inlet Cooling and Environmental Controls. Searching by Drive Information can be done using one or multiple keywords to find drives with Chillers, SCRs, SNCRs, GTIC (Gas Drive Inlet Cooling), and Specific Drive Model numbers. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Chiller"
}
},
"in": "query"
},
{
"name": "driveStatusDesc",
"description": "Status of the drive. The drive status allows to search for drives in various classifications. This parameter supports multiple values.\n\nList of supported values:
\n\n Planned\n On Hold\n Engineered\n Cancelled\n Under Construction\n Operational\n Mothballed\n Closed\n Shuttered\n Removed\n\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "driveCapacityMwMin",
"description": "The minimum Drive Capacity (Megawatts) searches for drives equal to or greater than the value given. The minimum Drive Capacity (Megawatts) can be used in conjunction with the maximum Drive Capacity (Megawatts) to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 500
},
"in": "query"
},
{
"name": "driveCapacityMwMax",
"description": "The maximum Drive Capacity (Megawatts) searches for drives equal to or less than the value given. The maximum Drive Capacity (Megawatts) can be used in conjunction with the minimum Drive Capacity (Megawatts) to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 2000
},
"in": "query"
},
{
"name": "driveCapacityHpMin",
"description": "The minimum Drive Capacity (Horsepower) searches for drives equal to or greater than the value given. The minimum Drive Capacity (Horsepower) can be used in conjunction with the maximum Drive Capacity (Horsepower) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 500
},
"in": "query"
},
{
"name": "driveCapacityHpMax",
"description": "The maximum Drive Capacity (Horsepower) searches for drives equal to or less than the value given. The maximum Drive Capacity (Horsepower) can be used in conjunction with the minimum Drive Capacity (Horsepower) to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 2000
},
"in": "query"
},
{
"name": "drivenEquipmentManufacturerName",
"description": "Driven Equipment Manufacturer. Generators, Pumps and Compressors are identified by their current manufacturer. Searching by Driven Equipment Manufacturer can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "BRUSH Electric"
}
},
"in": "query"
},
{
"name": "drivenEquipmentType",
"description": "Driven Equipment Type. All Pumps and or Compressors are classified as Centrifugal or Positive Displacement. Searching by driven equipment type can be done using one or multiple keywords. This parameter supports multiple values.\n\n\n List of supported values:
\n\n Centrifugal/Axial\n Reciprocating/Rotary\n\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Centrifugal/Axial"
}
},
"in": "query"
},
{
"name": "drivenEquipmentInformation",
"description": "Driven Equipment Information. Additional information is included for Generators, Pumps or Compressors such as Model, MVA, kV, Poles, RPM, Generator Cooling Method. Searching by driven equipment information can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "1500RPM"
}
},
"in": "query"
},
{
"name": "unitKickoffDateMin",
"description": "Unit Construction Kickoff Date. To search by minimum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Construction Kickoff date can be used in conjunction with the maximum Unit Kickoff end date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitKickoffDateMax",
"description": "Unit Construction Kickoff Date. To search by maximum Unit Construction Kickoff date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Construction Kickoff date can be used in conjunction with the minimum Unit Kickoff date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "driveStartupDateMin",
"description": "Drive Start-Up Date. To search by minimum Drive Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Drive Start-Up date can be used in conjunction with the maximum Drive Start-Up date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "driveStartupDateMax",
"description": "Drive Start-Up Date. To search by maximum Drive Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Drive Start-Up date can be used in conjunction with the minimum Drive Start-Up date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "driveShutdownDateMin",
"description": "Drive Shutdown Date. To search by minimum Drive Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Drive Shutdown date can be used in conjunction with the maximum Drive Shutdown date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "driveShutdownDateMax",
"description": "Drive Shutdown Date. To search by maximum Drive Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Drive Shutdown date can be used in conjunction with the minimum Drive Shutdown date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boreas Offshore Windfarm"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "General Electric"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by operator name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "General Electric"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "General Electric"
}
},
"in": "query"
},
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "GT 06"
}
},
"in": "query"
},
{
"name": "unitTypeId",
"description": "Unit Type ID. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 126
}
},
"in": "query"
},
{
"name": "unitTypeDesc",
"description": "Unit Type description. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel. To search by multiple values, use the same parameter multiple times with different values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "fuelGroup",
"description": "Fuel Type Group. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Coal\n Fuel Oil\n Natural Gas\n Nuclear\n Renewable Energy\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "powerUsageDesc",
"description": "Power Usage of the unit. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Base Load\n Intermediate Load\n Peak Load\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Base Load"
}
},
"in": "query"
},
{
"name": "unitClassification",
"description": "Unit Ownership Classification. This parameter supports multiple values.",
"schema": {
"enum": [
"Utility",
"Non-Utility"
],
"type": "string",
"example": "Utility"
},
"in": "query"
},
{
"name": "cogenChp",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. IIR assigns each Drive to one of twelve industries. Search for drives using the two digit Industry Code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Search for drives using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone. Searching by Zone code can be done by typing in the particular Zone code using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*10"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for drive records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The drive minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for drive records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The drive maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new drive records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The drive minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new drive records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The drive maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of drive results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned drive results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/driveSummaryResponse"
},
"examples": {
"driveSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"drives": [
{
"driveId": 100,
"driveManufacturerName": "GE Energy",
"driveCapacityMegawatts": 20,
"driveInformation": "MS5001N",
"drivenEquipmentManufacturerName": "GE Energy",
"unitId": 1000863,
"unitName": "Unit 01 GT/HRSG (MOTHBALLED)",
"plantId": 1001813,
"plantName": "Bill Greehey Refinery - East",
"plantOwnerName": "Valero Refining Company",
"plantPhysicalAddress": {
"city": "Corpus Christi",
"stateName": "Texas",
"countryName": "U.S.A."
},
"fuel": {
"primaryFuel": "Natural Gas"
},
"driveStartupDate": "1984-09-01T05:00:00Z[UTC]",
"unitTypeDesc": "Simple Cycle Combustion Turbine"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getDriveSummary",
"summary": "Return Drive(s) Summary",
"description": "Returns up to 100 drive records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Drive ID returned here and refer to the [/drives/detail](#post-/drives/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n driveId=101&driveId=106108\n \nSearching by wildcard keyword:\n\n driveTypeDesc=Turbine\n \n Example of returned drives:\n \"driveTypeDesc\": \"ST Steam Turbine\"\n \"driveTypeDesc\": \"Heavy Frame Combustion Turbine\"\n \"driveTypeDesc\": \"Aeroderivative Combustion Turbine\"\n \nThese are the supported parameters:"
}
},
"/drives/detail": {
"summary": "Find Drive Detail by ID",
"description": "Returns Drive Details.",
"post": {
"tags": [
"Drive Search"
],
"parameters": [
{
"name": "driveId",
"description": "The ID of the drive. The Drive ID is a unique number assigned to each drive. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 106108
}
},
"in": "query",
"required": false
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of drive results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned drive results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/driveDetailResponse"
},
"examples": {
"driveDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"drives": [
{
"driveId": 100,
"driveName": "GT 01",
"driveTypeDesc": "Heavy Frame Combustion Turbine",
"driveStatusDesc": "Mothballed",
"driveManufacturerName": "GE Energy",
"driveCapacityMegawatts": 20,
"driveCapacityHorsepower": 26820,
"driveCategory": "Generator",
"driveSeries": "MS5001N",
"driveInformation": "MS5001N",
"drivenEquipmentManufacturerName": "GE Energy",
"unitId": 1000863,
"unitName": "Unit 01 GT/HRSG (MOTHBALLED)",
"unitStatusDesc": "Mothballed",
"plantId": 1001813,
"plantName": "Bill Greehey Refinery - East",
"plantOwnerName": "Valero Refining Company",
"plantOperatorName": "Valero Refining Company",
"plantParentName": "Valero Energy Company",
"plantPhysicalAddress": {
"addressLine1": "1147 Cantwell Lane",
"city": "Corpus Christi",
"stateName": "Texas",
"postalCode": "78407",
"countryName": "U.S.A.",
"countyName": "Nueces"
},
"pecZone": "TX*05",
"plantPhone": "+1 3612896000",
"plantLatitude": 27.812287,
"plantLongitude": -97.446712,
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"worldRegionId": 1,
"worldRegionName": "North America",
"nercRegion": "ERCOT",
"powerTradeRegion": "Southwest",
"powerUsageDesc": "Peak Load",
"fuel": {
"primaryFuel": "Natural Gas",
"fuelGroup": "Natural Gas"
},
"heatRate": 14622,
"cogenChp": 1,
"unitStartupDate": "1984-09-01T05:00:00Z[UTC]",
"unitShutdownDate": "2009-12-01T06:00:00Z[UTC]",
"driveStartupDate": "1984-09-01T05:00:00Z[UTC]",
"driveShutdownDate": "2009-12-01T06:00:00Z[UTC]",
"unitTypeId": "00107",
"unitTypeDesc": "Simple Cycle Combustion Turbine",
"unitClassification": "2911",
"industryCode": "06",
"industryCodeDesc": "Petroleum Refining (HPI)",
"primarySicId": "2911",
"offshore": 0,
"liveDate": "2008-05-21T22:33:47Z[UTC]",
"releaseDate": "2008-05-21T22:33:47Z[UTC]"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getDriveDetail",
"summary": "Return Drive(s) Detail",
"description": "Returns up to 5 drive records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n drives/detail?driveId=106268&fields=driveId&fields=driveName&fields=driveStatusDesc\n\nThese are the supported parameters:"
}
},
"/miningequipment/summary": {
"summary": "Find Mining Equipment Summary",
"description": "Returns Mining Equipment Summary.",
"post": {
"tags": [
"Mining Equipment Search"
],
"parameters": [
{
"name": "mEquipmentId",
"description": "The ID of the mining equipment. The Mining Equipment ID is a unique number assigned to each mining equipment. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "mEquipmentType",
"description": "Mining Equipment Type. Each mining equipment is identified with a type. Searching by Mining Equipment Type can be done using one or multiple keywords. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Continuous Miners\n Dozers\n Draglines\n Drills\n Excavators\n Graders\n Haul Trucks\n Haulers\n Loaders\n Longwall Mining Systems\n Mining Shovels\n Roof Bolters\n Scrapers\n Surface Mining Machines\n Water Trucks\n\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Excavators"
}
},
"in": "query"
},
{
"name": "mEquipmentManufacturerName",
"description": "Manufacturer name of the mining equipment. Mining Equipment are identified by their manufacturer. Searching by Mining Equipment Manufacturer can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Komatsu"
}
},
"in": "query"
},
{
"name": "mEquipmentModel",
"description": "Mining Equipment Model. Additional information is available for mining equipment such as the Model. Searching by Mining Equipment Model can be done using one or multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "336F L"
}
},
"in": "query"
},
{
"name": "mEquipmentProduct",
"description": "Mining Equipment Product. Searching by mining equipment product can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gold Ore"
}
},
"in": "query"
},
{
"name": "capacityMin",
"description": "The minimum Mining Equipment Capacity searches for mining equipment equal to or greater than the value given. The minimum Mining Equipment Capacity can be used in conjunction with the maximum Mining Equipment Capacity to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 20
},
"in": "query"
},
{
"name": "capacityMax",
"description": "The maximum Mining Equipment Capacity searches for mining equipment equal to or less than the value given. The maximum Mining Equipment Capacity can be used in conjunction with the minimum Mining Equipment Capacity to select a capacity range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 1000
},
"in": "query"
},
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "GT 06"
}
},
"in": "query"
},
{
"name": "unitStatusDesc",
"description": "Status of the unit. The unit status allows to search for units in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Planned\n On Hold\n Engineered\n Cancelled\n Under Construction\n Operational\n Mothballed\n Closed\n Shuttered\n Removed\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "unitStartupDateMin",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by minimum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Start-Up date can be used in conjunction with the maximum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMax",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by maximum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Start-Up date can be used in conjunction with the minimum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMin",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by minimum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Shutdown date can be used in conjunction with the maximum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMax",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by maximum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Shutdown date can be used in conjunction with the minimum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boreas Offshore Windfarm"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Goldrich Mining Company"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by operator name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Goldrich Mining Company"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Goldrich Mining Company"
}
},
"in": "query"
},
{
"name": "primarySicId",
"description": "Plant Primary SIC ID. Searching by Primary SIC ID can be done by entering the four-digit SIC ID. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "primarySicDesc",
"description": "Plant Primary SIC description. Searching by Primary SIC description can be done by using one or multiple keywords. To search by multiple SIC descriptions, use the same parameter multiple times with different values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Transmission"
}
},
"in": "query"
},
{
"name": "secondarySicId",
"description": "Plant Secondary SIC ID. Searching by the Secondary SIC ID can be done by entering the four-digit SIC ID. This parameter supports multiple values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 4922
}
},
"in": "query"
},
{
"name": "secondarySicDesc",
"description": "Plant Secondary SIC description. Searching by Secondary SIC description can be done by using one or multiple keywords. To search by multiple SIC descriptions, use the same parameter multiple times with different values. To get the list of supported SIC Codes, please refer to the [/sicCodes](#post-/sicCodes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Electricity"
}
},
"in": "query"
},
{
"name": "sicProductId",
"description": "Plant SIC Product ID. Searching by SIC Product ID can be done by entering one or multiple SIC Product IDs. This parameter supports multiple values. To get the list of supported SIC Products, please refer to the [/sicProducts](#post-/sicProducts) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "4922*0004"
}
},
"in": "query"
},
{
"name": "sicProductDesc",
"description": "Plant SIC Product description. Searching by SIC Product description can be done by entering one or multiple SIC Product descriptions. This parameter supports multiple values. To get the list of supported SIC Products, please refer to the [/sicProducts](#post-/sicProducts) endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas Pipelines"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone. Searching by Zone code can be done by typing in the particular Zone code using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*10"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "miningAboveGround",
"description": "All Above Ground mining methods.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningUnderground",
"description": "All Underground mining methods. ",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningPlacer",
"description": "Placer mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningOpenPit",
"description": "Open Pit mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningQuarry",
"description": "Quarry mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningStrip",
"description": "Strip (Open Cast & Mountain Top) mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningAuger",
"description": "Auger mining method",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningHydraulic",
"description": "Hydraulic mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningBorehole",
"description": "Borehole mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningDredging",
"description": "Dredging mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningDrift",
"description": "Drift mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningShaft",
"description": "Shaft mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningSlope",
"description": "Slope mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningLongwall",
"description": "Longwall mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningRoomPillar",
"description": "Room & Pillar mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningCutFill",
"description": "Cut and Fill mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningCaving",
"description": "Caving (Long Hole & Sub-Level) mining method. ",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningStoping",
"description": "Stoping mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "miningInSituSolution",
"description": "In-Situ – Solution & Leaching mining method.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for mining equipment records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The mining equipment minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for mining equipment records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The mining equipment maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new mining equipment records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The mining equipment minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new mining equipment records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The mining equipment maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of mining equipment results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned mining equipment results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/miningEquipmentSummaryResponse"
},
"examples": {
"miningEquipmentSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"miningEquipment": [
{
"miningEquipmentId": 276,
"miningEquipmentType": "Excavators",
"miningEquipmentManufacturerName": "Caterpillar Incorporated",
"miningEquipmentModel": "XF 460",
"unitId": 2085284,
"unitName": "Mining Trucks",
"plantId": 1026124,
"plantName": "Fermont Mount-Wright A-G Iron Mine",
"plantOwnerName": "ArcelorMittal Mines Canada",
"plantPhysicalAddress": {
"city": "Fermont",
"stateName": "Quebec",
"countryName": "Canada"
}
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getMiningEquipmentSummary",
"summary": "Return Mining Equipment Summary",
"description": "Returns up to 100 mining equipment records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Mining Equipment ID returned here and refer to the [/miningequipment/detail](#post-/miningequipment/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n miningEquipmentId=78&miningEquipmentId=70\n \nSearching by wildcard keyword:\n\n miningEquipmentModel=BE\n \n Example of returned mining equipment:\n \"miningEquipmentModel\": \"BE300LC\"\n \"miningEquipmentModel\": \"BE700\"\n \nThese are the supported parameters:"
}
},
"/miningequipment/detail": {
"summary": "Find Mining Equipment Detail by ID",
"description": "Returns Mining Equipment Details.",
"post": {
"tags": [
"Mining Equipment Search"
],
"parameters": [
{
"name": "mEquipmentId",
"description": "The ID of the mining equipment. The Mining Equipment ID is a unique number assigned to each mining equipment. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of mining equipment results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned mining equipment results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/miningEquipmentDetailResponse"
},
"examples": {
"miningEquipmentDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"miningEquipment": [
{
"mEquipmentId": 276,
"mEquipmentName": "Mining Equip Regression Testings 3/13/2019",
"mEquipmentType": "Excavators",
"mEquipmentManufacturerName": "Caterpillar Incorporated",
"mEquipmentProduct": "Gold Ore",
"mEquipmentCapacity": 150,
"mEquipmentCapacityUom": "T/yr",
"mEquipmentModel": "XF 460",
"mEquipmentStatusId": "O",
"mEquipmentStatusDesc": "Operational",
"mEquipmentComments": "Regression Testing 3/13/2019",
"unitId": 2085284,
"unitName": "Mining Trucks",
"unitStatusDesc": "Operational",
"plantId": 1026124,
"plantName": "Fermont Mount-Wright A-G Iron Mine",
"plantOwnerId": 1047471,
"plantOwnerName": "ArcelorMittal Mines Canada",
"plantOperatorName": "ArcelorMittal Mines Canada",
"plantParentName": "ArcelorMittal",
"plantPhysicalAddress": {
"addressLine1": "Mount-Wright",
"city": "Fermont",
"stateName": "Quebec",
"countryName": "Canada",
"countyName": "7-Rivieres-Caniapisc",
"postalCode": "G0G1J0"
},
"pecZone": "PQ*03",
"offshore": 0,
"plantPhone": "+1 4182874512",
"plantLatitude": 52.778352,
"plantLongitude": -67.298908,
"marketRegionId": "PQ",
"marketRegionName": "Quebec",
"worldRegionId": 1,
"worldRegionName": "North America",
"powerUsageDesc": "Intermediate Load",
"areaName": "Mining Area",
"fuel": {
"primaryFuel": "Fuel Gas",
"secondaryFuel": "Biodiesel",
"fuelGroup": "Natural Gas"
},
"heatRate": 999999999,
"miningMethod": {
"aboveGround": 0,
"placer": 0,
"openPit": 0,
"quarry": 0,
"strip": 0,
"auger": 0,
"hydraulic": 0,
"dredging": 0,
"underground": 0,
"borehole": 0,
"drift": 0,
"shaft": 0,
"slope": 0,
"longwall": 0,
"roomPillar": 0,
"cutFill": 0,
"caving": 0,
"stoping": 0,
"inSituSolution": 0
},
"unitStartupDate": "2019-07-01T05:00:00Z[UTC]",
"unitShutdownDate": "2020-07-31T05:00:00Z[UTC]",
"unitTypeId": 189,
"unitTypeDesc": "Mine",
"industryCode": 8,
"industryCodeDesc": "Metals & Minerals",
"liveDate": "2019-03-13T19:55:18Z[UTC]",
"releaseDate": "2019-08-08T14:20:46Z[UTC]",
"primarySicId": "1011",
"primarySicDesc": "Iron Ores Mining"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getMiningEquipmentDetail",
"summary": "Return Mining Equipment Detail",
"description": "Returns up to 5 mining equipment records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n miningequipment/detail?mEquipmentId=326&fields=mEquipmentId&fields=mEquipmentName&fields=mEquipmentType\n\nThese are the supported parameters:"
}
},
"/otherequipment/summary": {
"summary": "Find Other Equipment Summary",
"description": "Returns Other Equipment Summary.",
"post": {
"tags": [
"Other Equipment Search"
],
"parameters": [
{
"name": "equipmentId",
"description": "The ID of the equipment. The Equipment ID is a unique number assigned to each equipment. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "equipmentType",
"description": "Equipment Type. Each equipment is identified with a type. Searching by Equipment Type can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported Equipment Types, please refer to the [/equipmentTypes](#post-/equipmentTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Fuel Cell"
}
},
"in": "query"
},
{
"name": "equipmentManufacturerName",
"description": "Manufacturer of the equipment. Equipment are identified by their manufacturer. Searching by Equipment Manufacturer can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Komatsu"
}
},
"in": "query"
},
{
"name": "equipmentVendor",
"description": "Vendor/Packager of the equipment. Searching by Equipment Vendor can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Tesla"
}
},
"in": "query"
},
{
"name": "equipmentInformation",
"description": "Equipment Information. Additional information is available for equipment such as the Model\n and Environmental Controls. Searching by Equipment Information can be done using one or\n multiple keywords. This parameter supports multiple values. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Solar Panels"
}
},
"in": "query"
},
{
"name": "equipmentProductId",
"description": "Equipment Product ID. To search by multiple Product IDs, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 9811
}
},
"in": "query"
},
{
"name": "equipmentProductDesc",
"description": "Equipment Product description. Searching by equipment product description can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Electricity"
}
},
"in": "query"
},
{
"name": "equipmentCapacityMin",
"description": "The minimum Equipment Capacity searches for equipment equal to or greater than the value given. The minimum Equipment Capacity can be used in conjunction with the maximum Equipment Capacity to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 20
},
"in": "query"
},
{
"name": "equipmentCapacityMax",
"description": "The maximum Equipment Capacity searches for equipment equal to or less than the value given. The maximum Equipment Capacity can be used in conjunction with the minimum Equipment Capacity to select a capacity range.\n",
"schema": {
"format": "double",
"type": "number",
"example": 1000
},
"in": "query"
},
{
"name": "unitId",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 2020068
}
},
"in": "query"
},
{
"name": "unitName",
"description": "Name of the unit. Searching by unit name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "GT 06"
}
},
"in": "query"
},
{
"name": "unitStatusDesc",
"description": "Status of the unit. The unit status allows to search for units in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Planned\n On Hold\n Engineered\n Cancelled\n Under Construction\n Operational\n Mothballed\n Closed\n Shuttered\n Removed\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "unitTypeDesc",
"description": "Unit Type description. Each unit is identified by a specific unit type. This parameter supports multiple values. To get the list of supported Unit Types, please refer to the [/unitTypes](#post-/unitTypes) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "unitKickoffDateMin",
"description": "Unit Construction Kick-Off Date. To search by minimum Unit Construction Kick-Off date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Construction Kick-Off date can be used in conjunction with the maximum Unit Kick-Off date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitKickoffDateMax",
"description": "Unit Construction Kick-Off Date. To search by maximum Unit Construction Kick-Off date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Construction Kick-Off date can be used in conjunction with the minimum Unit Kick-Off date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMin",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by minimum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Start-Up date can be used in conjunction with the maximum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "unitStartupDateMax",
"description": "The Unit Start-Up Date can be used to find units that have become operational over a period of time. To search by maximum Unit Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Start-Up date can be used in conjunction with the minimum Unit Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMin",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by minimum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Unit Shutdown date can be used in conjunction with the maximum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "unitShutdownDateMax",
"description": "The Unit Shutdown Date can be used to find units that have been decommissioned over a period of time. To search by maximum Unit Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Unit Shutdown date can be used in conjunction with the minimum Unit Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-05-05"
},
"in": "query"
},
{
"name": "primaryFuel",
"description": "Primary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Biodiesel"
}
},
"in": "query"
},
{
"name": "secondaryFuel",
"description": "Secondary Fuel of the unit. To search by multiple values, use the same parameter multiple times with different values. \n\nList of supported values:
\n\n Biodiesel\n Biomass\n Biomass Gasified\n Black Liquor\n Blast-Furnace Gas\n Breeze Coke\n Coal\n Coal Anthracite\n Coal Bed Methane\n Coal Bituminous\n Coal Gasified\n Coal Lignite\n Coal Subbituminous\n Coal Waste\n Coke-Oven Gas\n Combined Cycle Waste Heat\n Crude Oil\n Digester Gas\n Ethanol\n Fuel Gas\n Fuel Oil\n Fuel Oil No. 1 Distillate\n Fuel Oil No. 2 Distillate Diesel\n Fuel Oil No. 4 Distillate\n Fuel Oil No. 5 Residual\n Fuel Oil No. 6 Residual\n Geothermal\n Hydro\n Hydrogen\n Industrial Waste Heat\n Jet Fuel\n Kerosene\n Landfill Gas\n Liquefied Natural Gas\n Metallurgical (Coal) Coke\n Naphtha\n Natural Gas\n Natural Gas Liquids\n Nuclear\n Oxygen\n Petroleum Coke\n Petroleum Coke Gasified\n Phosphoric Acid\n Propane\n Pyrolysis Pitch\n Re-refined Motor Oil\n Solar\n Synthetic Natural Gas\n Tidal\n Tire Derived Fuel\n Waste (solid/sludge)\n Waste (solid/sludge) Gasified\n Wind\n Wood\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "fuelGroup",
"description": "Fuel Type Group. To search by multiple values, use the same parameter multiple times with different values.\n\n\nList of supported values:
\n\n Coal\n Fuel Oil\n Natural Gas\n Nuclear\n Renewable Energy\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Coal"
}
},
"in": "query"
},
{
"name": "powerUsageDesc",
"description": "Power Usage of the unit. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Base Load\n Intermediate Load\n Peak Load\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Base Load"
}
},
"in": "query"
},
{
"name": "unitClassification",
"description": "Unit Ownership Classification. This parameter supports multiple values.",
"schema": {
"enum": [
"Utility",
"Non-Utility"
],
"type": "string",
"example": "Utility"
},
"in": "query"
},
{
"name": "cogenChp",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "plantId",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1003456
}
},
"in": "query"
},
{
"name": "plantName",
"description": "Name of the plant. Searching by plant name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Boreas Offshore Windfarm"
}
},
"in": "query"
},
{
"name": "plantOwnerName",
"description": "Owner name of the plant. Searching by the owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Engie Green"
}
},
"in": "query"
},
{
"name": "plantOperatorName",
"description": "Operator name of the plant. Searching by operator name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Engie Green"
}
},
"in": "query"
},
{
"name": "plantParentName",
"description": "Parent Company name of the plant. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Energias de Portugal SA"
}
},
"in": "query"
},
{
"name": "industryCode",
"description": "Industry Code. IIR assigns each Equipment to one of twelve industries. Search for units using the two digit Industry code. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 01 - Power\n 02 - Terminals \n 03 - Oil & Gas Pipelines \n 04 - Production (Oil & Gas)\n 05 - Alternative Fuel\n 06 - Petroleum Refining (HPI) \n 07 - Chemical Processing (CPI)\n 08 - Metals & Minerals\n 09 - Pulp, Paper & Wood\n 10 - Food & Beverage\n 12 - Industrial Manufacturing\n 13 - Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "01"
}
},
"in": "query"
},
{
"name": "industryCodeDesc",
"description": "Industry Code description. Search for Equipment using the Industry Code description. This parameter supports multiple values. \n\n\nList of supported values:
\n\n Power \n Terminals\n Oil & Gas Pipelines\n Production (Oil & Gas)\n Alternative Fuel\n Petroleum Refining (HPI)\n Chemical Processing (CPI)\n Metals & Minerals\n Pulp, Paper & Wood\n Food & Beverage\n Industrial Manufacturing\n Pharmaceutical & Biotech\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Power"
}
},
"in": "query"
},
{
"name": "physicalAddressCountryName",
"description": "Country name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "physicalAddressStateName",
"description": "State name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "physicalAddressCity",
"description": "City name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "physicalAddressPostalCode",
"description": "Postal Code of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77006
}
},
"in": "query"
},
{
"name": "physicalAddressCountyName",
"description": "County name of the plant. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "pecZone",
"description": "Zone. Searching by Zone code can be done by typing in the particular Zone code using the state prefix followed by an asterisk and the zone number. This parameter supports multiple values. To get the list of supported PEC Zones, please refer to the [/pecZones](#post-/pecZones) endpoint. ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "TX*10"
}
},
"in": "query"
},
{
"name": "marketRegionId",
"description": "Market Region ID. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "marketRegionName",
"description": "Market Region name. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "worldRegionId",
"description": "World Region ID. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "worldRegionName",
"description": "World Region name. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "offshore",
"description": "Search by onshore (0) or offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "offshoreCountryName",
"description": "Offshore Country name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "offshoreWaterbodyName",
"description": "Offshore Waterbody name. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "offshoreAreaName",
"description": "Offshore Area name. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "offshoreFieldName",
"description": "Offshore Field name. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for equipment records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The equipment minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for equipment records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The equipment maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new equipment records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The equipment minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new equipment records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The equipment maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of other equipment results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned other equipment results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/otherEquipmentSummaryResponse"
},
"examples": {
"otherEquipmentSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"otherEquipments": [
{
"equipmentId": 2,
"equipmentType": "Drums",
"equipmentManufacturerName": "Another Drummer",
"equipmentVendor": "Comision Federal",
"equipmentStatusDesc": "Operational",
"unitId": 2085269,
"unitName": "PDH test",
"unitTypeDesc": "Propane Dehydrogenation (PDH)",
"plantId": 1517384,
"plantName": "Mont Belvieu NGL Fractionator",
"plantOwnerName": "Enterprise Products Partners LP",
"plantPhysicalAddress": {
"city": "Mont Belvieu",
"stateName": "Texas",
"countryName": "U.S.A."
}
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getOtherEquipmentSummary",
"summary": "Return Other Equipment Summary",
"description": "Returns up to 100 other equipment records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Other Equipment ID returned here and refer to the [/otherequipment/detail](#post-/otherequipment/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n otherEquipmentId=78&otherEquipmentId=70\n \nSearching by wildcard keyword:\n\n equipmentInformation=Solar\n \n Example of returned other equipment:\n \"equipmentInformation\": \"18.840 Polycrystalline Solar Panels\"\n \"equipmentInformation\": \"31.600 Solar Panels\"\n \n\nThese are the supported parameters:"
}
},
"/otherequipment/detail": {
"summary": "Find Other Equipment by ID",
"description": "Returns Other Equipment Details.",
"post": {
"tags": [
"Other Equipment Search"
],
"parameters": [
{
"name": "equipmentId",
"description": "The ID of the equipment. The Equipment ID is a unique number assigned to each equipment. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of other equipment results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned other equipment results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/otherEquipmentDetailResponse"
},
"examples": {
"otherEquipmentDetailResponse": {
"value": {
"limit": 1,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"otherEquipments": [
{
"equipmentId": 2,
"equipmentName": "Now we can release this",
"equipmentType": "Drums",
"equipmentManufacturerName": "Another Drummer",
"equipmentVendor": "Comision Federal",
"equipmentStatusId": "O",
"equipmentStatusDesc": "Operational",
"equipmentInformation": "DRUM 210023",
"equipmentComments": "Drop that beat",
"equipmentProductId": "010118",
"equipmentProductDesc": "Ethane, gaseous",
"equipmentProductUom": "MMSCFD",
"equipmentCapacity": 222222.013,
"unitId": 2085269,
"unitName": "PDH test",
"unitStatusDesc": "Operational",
"unitTypeId": "00212",
"unitTypeDesc": "Propane Dehydrogenation (PDH)",
"plantId": 1517384,
"plantName": "Mont Belvieu NGL Fractionator",
"plantOwnerId": 1001132,
"plantOwnerName": "Enterprise Products Partners LP",
"plantOperatorName": "Enterprise Products Partners LP",
"plantParentName": "Enterprise Products Partners LP",
"plantPhysicalAddress": {
"addressLine1": "10207 FM 1942",
"city": "Mont Belvieu",
"stateName": "Texas",
"countryName": "U.S.A.",
"countyName": "Chambers",
"postalCode": "77580"
},
"pecZone": "TX*07",
"plantPhone": "+1 2813854200",
"plantLatitude": 29.839409,
"plantLongitude": -94.90073,
"marketRegionId": "SW",
"marketRegionName": "Southwest",
"worldRegionId": 1,
"worldRegionName": "North America",
"offshore": 0,
"areaName": "South",
"primarySicId": "1321",
"cogenChp": 0,
"industryCode": "04",
"industryCodeDesc": "Production (Oil & Gas)",
"liveDate": "2017-12-01T13:41:10Z[UTC]",
"releaseDate": "2020-10-12T22:11:17Z[UTC]"
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getOtherEquipmentDetail",
"summary": "Return Other Equipment Detail",
"description": "Returns up to 5 other equipment records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n otherequipment/detail?equipmentId=11&fields=equipmentId&fields=equipmentName&fields=equipmentType\n\nThese are the supported parameters:"
}
},
"/pipelines/summary": {
"summary": "Find Pipeline Summary",
"description": "Returns Pipeline Summary.",
"post": {
"tags": [
"Pipeline Search"
],
"parameters": [
{
"name": "pipelineId",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3500089
}
},
"in": "query"
},
{
"name": "pipelineName",
"description": "Name of the pipeline. Pipeline names are based on the owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to. Searching by pipeline name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transcanada"
}
},
"in": "query"
},
{
"name": "pipelineSystemId",
"description": "The ID of the pipeline system. To search by multiple pipeline system IDs, use the same parameter multiple times with different values. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "pipelineSystemName",
"description": "Name of the pipeline system. Searching by Pipeline System name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Atmos Natural Gas"
}
},
"in": "query"
},
{
"name": "pipelineStatusDesc",
"description": "Status of the pipeline. The Pipeline status allows to search for pipelines in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Cancelled\n Closed\n Engineered\n Lead\n Mothballed\n On Hold\n Operational\n Planned\n Removed\n Shuttered\n Under Construction\n Unresolved\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "pipelineOwnerName",
"description": "Owner name of the pipeline. Searching by the Pipeline Owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Kinder Morgan"
}
},
"in": "query"
},
{
"name": "pipelineOperatorName",
"description": "Operator name of the pipeline. Searching by the Pipeline Operator name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Kinder Morgan"
}
},
"in": "query"
},
{
"name": "pipelineParentName",
"description": "Parent Company name of the pipeline. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Kinder Morgan"
}
},
"in": "query"
},
{
"name": "productCarried",
"description": "Products Carried by the pipeline. All pipeline records have a designated product with unit of measurement assigned to them. To search by multiple Products, use the same parameter multiple times with different values. This parameter supports multiple values. To get the list of supported HS Products, please refer to the [/hsProducts](#post-/hsProducts) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas, Gaseous"
}
},
"in": "query"
},
{
"name": "pipelineType",
"description": "Type of pipeline. Each Pipeline is identified by a specific pipeline type. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Gathering\n Lateral\n Main/Trunk\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Main/Trunk"
}
},
"in": "query"
},
{
"name": "materialUsed",
"description": "Material used for the pipeline. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Flexible\n Stainless Steel\n Steel\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Steel"
}
},
"in": "query"
},
{
"name": "interIntraState",
"description": "Interstate/Intrastate. This parameter supports multiple values.\n\n\n List of supported values
\n\n Interstate\n Intrastate\n \n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Interstate"
}
},
"in": "query"
},
{
"name": "completionDateMin",
"description": "The Completion Date of the pipeline. The date of completion of mechanical construction and integrity testing. To search by minimum Completion date simply enter the date using the correct format (YYYY-MM-DD). The minimum Completion date can be used in conjunction with the maximum Completion date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "completionDateMax",
"description": "The Completion Date of the pipeline. The date of completion of mechanical construction and integrity testing. To search by maximum Completion date simply enter the date using the correct format (YYYY-MM-DD). The maximum Completion date can be used in conjunction with the minimum Completion date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "startupDateMin",
"description": "The Start-Up Date of the pipeline. Commencement of Commercial Operations which can differ significantly from the Completion Date. To search by minimum Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The minimum Start-Up date can be used in conjunction with the maximum Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "startupDateMax",
"description": "The Start-Up Date of the pipeline. Commencement of Commercial Operations which can differ significantly from the Completion Date. To search by maximum Start-Up date simply enter the date using the correct format (YYYY-MM-DD). The maximum Start-Up date can be used in conjunction with the minimum Start-Up date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "shutdownDateMin",
"description": "The Shutdown Date of the pipeline. The date of the termination of commercial operations. To search by minimum Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The minimum Shutdown date can be used in conjunction with the maximum Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-05-05"
},
"in": "query"
},
{
"name": "shutdownDateMax",
"description": "The Shutdown End Date of the pipeline. The date of the termination of commercial operations. To search by maximum Shutdown date simply enter the date using the correct format (YYYY-MM-DD). The maximum Shutdown date can be used in conjunction with the minimum Shutdown date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-05-05"
},
"in": "query"
},
{
"name": "pipelineLengthMiMin",
"description": "The minimum Pipeline Length (Miles) searches for pipelines equal to or greater than the value given. The minimum Pipeline Length (Miles) can be used in conjunction with the maximum Pipeline Length (Miles) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 25
},
"in": "query"
},
{
"name": "pipelineLengthMiMax",
"description": "The maximum Pipeline Length (Miles) searches for pipelines equal to or less than the value given. The maximum Pipeline Length (Miles) can be used in conjunction with the minimum Pipeline Length (Miles) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "pipelineLengthKmMin",
"description": "The minimum Pipeline Length (Kilometers) searches for pipelines equal to or greater than the value given. The minimum Pipeline Length (Kilometers) can be used in conjunction with the maximum Pipeline Length (Kilometers) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 5
},
"in": "query"
},
{
"name": "pipelineLengthKmMax",
"description": "The maximum Pipeline Length (Kilometers) searches for pipelines equal to or less than the value given. The maximum Pipeline Length (Kilometers) can be used in conjunction with the minimum Pipeline Length (Kilometers) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "systemLengthMiMin",
"description": "The minimum Pipeline System Length (Miles) searches for pipelines equal to or greater than the value given. The minimum Pipeline System Length (Miles) can be used in conjunction with the maximum Pipeline System Length (Miles) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 30
},
"in": "query"
},
{
"name": "systemLengthMiMax",
"description": "The maximum Pipeline System Length (Miles) searches for pipelines equal to or less than the value given. The maximum Pipeline System Length (Miles) can be used in conjunction with the minimum Pipeline System Length (Miles) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 60
},
"in": "query"
},
{
"name": "systemLengthKmMin",
"description": "The minimum Pipeline System Length (Kilometers) searches for pipelines equal to or greater than the value given. The minimum Pipeline System Length (Kilometers) can be used in conjunction with the maximum Pipeline System Length (Kilometers) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "systemLengthKmMax",
"description": "The maximum Pipeline System Length (Kilometers) searches for pipelines equal to or less than the value given. The maximum Pipeline System Length (Kilometers) can be used in conjunction with the minimum Pipeline System Length (Kilometers) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 60
},
"in": "query"
},
{
"name": "designPressurePsiMin",
"description": "The minimum Design Pressure (PSI) searches for pipelines equal to or greater than the value given. The minimum Design Pressure (PSI) can be used in conjunction with the maximum Design Pressure (PSI) to select a pressure range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "designPressurePsiMax",
"description": "The maximum Design Pressure (PSI) searches for pipelines equal to or less than the value given. The maximum Design Pressure (PSI) can be used in conjunction with the minimum Design Pressure (PSI) to select a pressure range.\n",
"schema": {
"format": "int32",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "designPressureBarMin",
"description": "The minimum Design Pressure (BAR) searches for pipelines equal to or greater than the value given. The minimum Design Pressure (BAR) can be used in conjunction with the maximum Design Pressure (BAR) to select a pressure range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "designPressureBarMax",
"description": "The maximum Design Pressure (BAR) searches for pipelines equal to or less than the value given. The maximum Design Pressure (BAR) can be used in conjunction with the minimum Design Pressure (BAR) to select a pressure range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "pipelinePathDiameterInchesMin",
"description": "The minimum Pipeline Path Diameter (Inches) searches for pipelines equal to or greater than the value given. The minimum Pipeline Path Diameter (Inches) can be used in conjunction with the maximum Pipeline Path Diameter (Inches) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "pipelinePathDiameterInchesMax",
"description": "The maximum Pipeline Path Diameter (Inches) searches for pipelines equal to or less than the value given. The maximum Pipeline Path Diameter (Inches) can be used in conjunction with the minimum Pipeline Path Diameter (Inches) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 20
},
"in": "query"
},
{
"name": "pipelinePathDiameterCmMin",
"description": "The minimum Pipeline Path Diameter (Centimeters) searches for pipelines equal to or greater than the value given. The minimum Pipeline Path Diameter (Centimeters) can be used in conjunction with the maximum Pipeline Path Diameter (Centimeters) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 12
},
"in": "query"
},
{
"name": "pipelinePathDiameterCmMax",
"description": "The maximum Pipeline Path Diameter (Centimeters) searches for pipelines equal to or less than the value given. The maximum Pipeline Path Diameter (Centimeters) can be used in conjunction with the minimum Pipeline Path Diameter (Centimeters) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "pipelineConnectionDiameterInchesMin",
"description": "The minimum Pipeline Connection Diameter (Inches) searches for pipelines equal to or greater than the value given. The minimum Pipeline Connection Diameter (Inches) can be used in conjunction with the maximum Pipeline Connection Diameter (Inches) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "pipelineConnectionDiameterInchesMax",
"description": "The maximum Pipeline Connection Diameter (Inches) searches for pipelines equal to or less than the value given. The maximum Pipeline Connection Diameter (Inches) can be used in conjunction with the minimum Pipeline Connection Diameter (Inches) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 20
},
"in": "query"
},
{
"name": "pipelineConnectionDiameterCmMin",
"description": "The minimum Pipeline Connection Diameter (Centimeters) searches for pipelines equal to or greater than the value given. The minimum Pipeline Connection Diameter (Centimeters) can be used in conjunction with the maximum Pipeline Connection Diameter (Centimeters) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 12
},
"in": "query"
},
{
"name": "pipelineConnectionDiameterCmMax",
"description": "The maximum Pipeline Connection Diameter (Centimeters) searches for pipelines equal to or less than the value given. The maximum Pipeline Connection Diameter (Centimeters) can be used in conjunction with the minimum Pipeline Connection Diameter (Centimeters) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "insulated",
"description": "Pipeline Insulated (No/Yes). Search for pipelines that are known to have been insulated with a coating to act as a thermal insulation.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "aboveGround",
"description": "Above Ground Pipeline Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "belowGround",
"description": "Below Ground Pipeline Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "subsea",
"description": "Subsea Pipeline Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "offshore",
"description": "Search for either Pipeline Origination/Destination/Connection Onshore (0) or Offshore (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "originationOffshore",
"description": "Search by Pipeline Origination Onshore (0) or Offshore (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "originationWorldRegionId",
"description": "World Region ID of the Pipeline Origination. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "originationWorldRegionName",
"description": "World Region name of the Pipeline Origination. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "originationMarketRegionId",
"description": "Market Region ID of the Pipeline Origination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "originationMarketRegionName",
"description": "Market Region name of the Pipeline Origination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "originationCountryName",
"description": "Country name of the Pipeline Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "originationStateName",
"description": "State name of Pipeline Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "originationCountyName",
"description": "The County name of the Pipeline Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Zapata"
}
},
"in": "query"
},
{
"name": "originationCity",
"description": "City of the Pipeline Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Zapata"
}
},
"in": "query"
},
{
"name": "originationPostalCode",
"description": "Postal Code of the Pipeline Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 78076
}
},
"in": "query"
},
{
"name": "originationAddress",
"description": "Physical Address of the Pipeline Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "3 M North of Coyanosa"
}
},
"in": "query"
},
{
"name": "originationOffshoreCountryName",
"description": "Offshore Country of the Pipeline Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "originationOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Pipeline Origination. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf"
}
},
"in": "query"
},
{
"name": "originationOffshoreAreaName",
"description": "Offshore Area of the Pipeline Origination. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "originationOffshoreFieldName",
"description": "Offshore Field of the Pipeline Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "originationOffshoreBlock",
"description": "Offshore Quadrant/Block of the Pipeline Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "destinationOffshore",
"description": "Search by Pipeline Destination Onshore (0) or Offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "destinationWorldRegionId",
"description": "World Region ID of the Pipeline Destination. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "destinationWorldRegionName",
"description": "World Region name of the Pipeline Destination. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "destinationMarketRegionId",
"description": "Market Region ID of the Pipeline Destination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "destinationMarketRegionName",
"description": "Market Region name of the Pipeline Destination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "destinationCountryName",
"description": "Country name of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "destinationStateName",
"description": "State name of Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "destinationCountyName",
"description": "County name of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Fort Bend"
}
},
"in": "query"
},
{
"name": "destinationCity",
"description": "City of the Pipeline Destination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Sugar Land"
}
},
"in": "query"
},
{
"name": "destinationPostalCode",
"description": "Postal Code of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77478
}
},
"in": "query"
},
{
"name": "destinationAddress",
"description": "Physical Address of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "4445 Oilfield Road"
}
},
"in": "query"
},
{
"name": "destinationOffshoreCountryName",
"description": "Offshore Country of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "destinationOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Pipeline Destination. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf"
}
},
"in": "query"
},
{
"name": "destinationOffshoreAreaName",
"description": "Offshore Area of the Pipeline Destination. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "destinationOffshoreFieldName",
"description": "Offshore Field of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "destinationOffshoreBlock",
"description": "Offshore Quadrant/Block of the Pipeline Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "connectionOffshore",
"description": "Search by Pipeline Connection Onshore (0) or Offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "connectionWorldRegionId",
"description": "World Region ID of the Pipeline Connection. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "connectionWorldRegionName",
"description": "World Region name of the Pipeline Connection. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "connectionMarketRegionId",
"description": "Market Region ID of the Pipeline Connection. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "connectionMarketRegionName",
"description": "Market Region name of the Pipeline Connection. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "connectionCountryName",
"description": "Country name of the Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "connectionStateName",
"description": "State name of Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "connectionCountyName",
"description": "County name of the Pipeline Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "connectionCity",
"description": "City of the Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "connectionPostalCode",
"description": "Postal Code of the Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 78076
}
},
"in": "query"
},
{
"name": "connectionAddress",
"description": "Physical Address of the Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "3 M North"
}
},
"in": "query"
},
{
"name": "connectionOffshoreCountryName",
"description": "Offshore Country of the Pipeline Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "connectionOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Pipeline Connection. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf"
}
},
"in": "query"
},
{
"name": "connectionOffshoreAreaName",
"description": "Offshore Area of the Pipeline Connection. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "connectionOffshoreFieldName",
"description": "Offshore Field of the Pipeline Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "connectionOffshoreBlock",
"description": "Offshore Quadrant/Block of the Pipeline Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for pipeline records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The pipeline minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for pipeline records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The pipeline maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new pipeline records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The pipeline minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new pipeline records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The pipeline maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of pipeline results to return. By default, it will return 100 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned pipeline results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pipelineSummaryResponse"
},
"examples": {
"pipelineSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"pipelines": [
{
"pipelineName": "Pipeline Test 2",
"pipelineSystemId": 101,
"pipelineSystemName": "Pipeline System Restest",
"pipelineStatusDesc": "Operational",
"pipelineLengthMiles": 500,
"pipelineLengthKilometers": 804,
"systemLengthMiles": 5000,
"systemLengthKilometers": 8046,
"pipelineOrigination": {
"plantPhysicalAddress": {
"city": "Abilene",
"stateName": "Texas",
"countryName": "U.S.A."
}
},
"pipelineDestination": {
"plantPhysicalAddress": {
"city": "San Antonio",
"stateName": "Texas",
"countryName": "U.S.A."
}
},
"primaryProductDesc": "Gasoline Storage",
"pipelineOwner": [
{
"companyName": "Shell Oil Company"
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getPipelineSummary",
"summary": "Return Pipeline(s) Summary",
"description": "Returns up to 100 pipeline records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Pipeline ID returned here and refer to the [/pipelines/detail](#post-/pipelines/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n pipelineId=3500123&pipelineId=3500426\n \nSearching by wildcard keyword:\n\n pipelineName=Test\n \n Example of returned pipelines:\n \"pipelineName\": \"My Lateral Test 2\"\n \"pipelineName\": \"Test Pipelines\"\n\nThese are the supported parameters:"
}
},
"/pipelines/detail": {
"summary": "Find Pipeline Detail by ID",
"description": "Returns Pipeline Details.",
"post": {
"tags": [
"Pipeline Search"
],
"parameters": [
{
"name": "pipelineId",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3500089
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of pipeline results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned pipeline results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pipelineDetailResponse"
},
"examples": {
"pipelineDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"pipelines": [
{
"pipelineId": 3500020,
"pipelineName": "AgeCon Pipeline",
"pipelineOperatorName": "Agennix Incorporated",
"pipelineStatusDesc": "Planned",
"pipelineType": "Main/Trunk",
"offshore": 0,
"materialUsed": "Stainless Steel",
"interIntraState": "Interstate",
"aboveGround": "1",
"pipelineOrigination": {
"plantId": 1065311,
"plantName": "*1058582 Piceance Creek Compressor Station",
"offshore": 0,
"plantPhysicalAddress": {
"addressLine1": "17 Miles SW of Meeker",
"countyName": "Rio Blanco",
"city": "Meeker",
"stateName": "Colorado",
"countryName": "U.S.A.",
"postalCode": "81641"
},
"plantLatitude": 40.04066,
"plantLongitude": -107.91588,
"worldRegionId": 1,
"worldRegionName": "North America",
"marketRegionId": "RM",
"marketRegionName": "Rocky Mountains"
},
"pipelineDestination": {
"plantId": 1078209,
"plantName": "Alameda Simms Wastewater Cogen",
"offshore": 0,
"plantPhysicalAddress": {
"addressLine1": "4545 Groveway Drive",
"countyName": "Harris",
"city": "Houston",
"stateName": "Texas",
"countryName": "U.S.A.",
"postalCode": "770871122"
},
"plantLatitude": 29.629444,
"plantLongitude": -95.406666,
"worldRegionId": 1,
"worldRegionName": "North America",
"marketRegionId": "SW",
"marketRegionName": "Southwest"
},
"primaryProductId": 7849,
"primaryProductDesc": "Machines Nesoi For Production And Assembly (Except Testing) Of Diodes, Transistors And Similar Semiconductor Devices Andelectronic I",
"liveDate": "2014-01-16T14:33:51Z[UTC]",
"releaseDate": "2014-01-16T14:33:51Z[UTC]",
"pipelineOwner": [
{
"companyId": 1090852,
"companyName": "Agennix Incorporated",
"classification": "P",
"ownerPercent": 100,
"address": {
"addressLine1": "8 Greenway Plaza Suite 910",
"city": "Houston",
"stateName": "Texas",
"countryName": "U.S.A.",
"postalCode": "77046"
}
}
],
"pipelineProduct": [
{
"productId": 7849,
"productDesc": "Machines Nesoi For Production And Assembly (Except Testing) Of Diodes, Transistors And Similar Semiconductor Devices Andelectronic I",
"productStatus": "Current Product",
"productCapacity": 46.58,
"uom": "NO"
}
],
"pipelineConnections": [
{
"plantId": 1062625,
"plantName": "Natural Gas Compressor Station 10",
"receiptDeliveryPoint": "Both",
"industryCodeDesc": "Production (Oil & Gas)",
"diameterInInches": 15,
"diameterInCentimeters": 38,
"diameterOutInches": 15,
"diameterOutCentimeters": 38,
"diameterUom": "Inches (in)",
"offshore": 0,
"plantPhysicalAddress": {
"addressLine1": "test road",
"countyName": "Hong Kong",
"city": "Hong Kong",
"stateName": "Hong Kong",
"countryName": "Hong Kong",
"postalCode": "5544"
},
"worldRegionId": 6,
"worldRegionName": "Asia",
"marketRegionId": "EA",
"marketRegionName": "East Asia"
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getPipelineDetail",
"summary": "Return Pipeline(s) Detail",
"description": "Returns up to 5 pipeline records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n pipelines/detail?pipelineId=3501148&fields=pipelineId&fields=pipelineName&fields=pipelineStatusDesc\n\nThese are the supported parameters:"
}
},
"/transmissionlines/summary": {
"summary": "Find Transmission Line Summary",
"description": "Returns Transmission Line Summary.",
"post": {
"tags": [
"Transmission Line Search"
],
"parameters": [
{
"name": "tLineId",
"description": "The ID of the transmission line. The Transmission Line ID is a unique seven-digit number used by IIR that is assigned to each transmission line profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3501034
}
},
"in": "query"
},
{
"name": "tLineName",
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name. Searching by transmission line name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transmission line"
}
},
"in": "query"
},
{
"name": "transmissionSystemId",
"description": "The ID of the transmission system. To search by multiple pipeline system IDs, use the same parameter multiple times with different values. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 101
}
},
"in": "query"
},
{
"name": "transmissionSystemName",
"description": "Name of the transmission system. Searching by Transmission System name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Transmission System"
}
},
"in": "query"
},
{
"name": "tLineStatusDesc",
"description": "Status of the transmission line. The Transmission Line status allows to search for transmission lines in various classifications. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Cancelled\n Engineered\n On Hold\n Operational\n Planned\n Removed\n Under Construction\n\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Operational"
}
},
"in": "query"
},
{
"name": "tLineOwnerName",
"description": "Owner name of the transmission line. Searching by the Transmission Line Owner name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Comision Federal de Electricidad"
}
},
"in": "query"
},
{
"name": "tLineOperatorName",
"description": "Operator name of the transmission line. Searching by the Transmission Line Operator name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "CFE Transmision EPS"
}
},
"in": "query"
},
{
"name": "tLineParentName",
"description": "Parent Company name of transmission line. Searching by the name of the parent company can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Comision Federal de Electricidad"
}
},
"in": "query"
},
{
"name": "tLineType",
"description": "Type of transmission line. There are two different types of transmission lines: AC and DC. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC\n DC\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "AC"
}
},
"in": "query"
},
{
"name": "tLineLengthMiMin",
"description": "The minimum Transmission Line Length (Miles) searches for transmission lines equal to or greater than the value given. The minimum Transmission Line Length (Miles) can be used in conjunction with the maximum Transmission Line Length (Miles) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 25
},
"in": "query"
},
{
"name": "tLineLengthMiMax",
"description": "The maximum Transmission Line Length (Miles) searches for transmission lines equal to or less than the value given. The maximum Transmission Line Length (Miles) can be used in conjunction with the minimum Transmission Line (Miles) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "tLineLengthKmMin",
"description": "The minimum Transmission Line Length (Kilometers) searches for transmission lines equal to or greater than the value given. The minimum Transmission Line Length (Kilometers) can be used in conjunction with the maximum Transmission Line Length (Kilometers) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 5
},
"in": "query"
},
{
"name": "tLineLengthKmMax",
"description": "The maximum Transmission Line Length (Kilometers) searches for transmission lines equal to or less than the value given. The maximum Transmission Line Length (Kilometers) can be used in conjunction with the minimum Transmission Line Length (Kilometers) to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "systemLengthMiMin",
"description": "The minimum Transmission System Length (Miles) searches for transmission lines equal to or greater than the value given. The minimum Transmission System Length (Miles) can be used in conjunction with the maximum Transmission System Length (Miles) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 30
},
"in": "query"
},
{
"name": "systemLengthMiMax",
"description": "The maximum Transmission System Length (Miles) searches for transmission lines equal to or less than the value given. The maximum Transmission System Length (Miles) can be used in conjunction with the minimum Transmission System Length (Miles) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 60
},
"in": "query"
},
{
"name": "systemLengthKmMin",
"description": "The minimum Transmission System Length (Kilometers) searches for transmission lines equal to or greater than the value given. The minimum Transmission System Length (Kilometers) can be used in conjunction with the maximum Transmission System Length (Kilometers) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 10
},
"in": "query"
},
{
"name": "systemLengthKmMax",
"description": "The maximum Transmission System Length (Kilometers) searches for transmission lines equal to or less than the value given. The maximum Transmission System Length (Kilometers) can be used in conjunction with the minimum Transmission System Length (Kilometers) to select a range.",
"schema": {
"format": "int64",
"type": "integer",
"example": 60
},
"in": "query"
},
{
"name": "overhead",
"description": "Overhead Transmission Line Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "belowGround",
"description": "Below Ground Transmission Line Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "subsea",
"description": "Subsea Transmission Line Layout.",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 1
},
"in": "query"
},
{
"name": "controlAreaName",
"description": "Balancing Authority/Control Area name. Searching by the Balancing Authority/Control Area name can be done using one or multiple keywords. This parameter supports multiple values. To get the list of supported Balancing Authorities/Control Areas, please refer to the [/controlAreas](#post-/controlAreas) endpoint. \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Alliant East (MISO)"
}
},
"in": "query"
},
{
"name": "nercRegion",
"description": "NERC Region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n ASCC\n ERCOT\n SPP \n RFC ECAR \n RFC MAAC\n NPCC \n SERC \n WECC \n FRCC\n RFC MAIN \n MRO\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "ASCC"
}
},
"in": "query"
},
{
"name": "kVratingMin",
"description": "The minimum kV Rating searches for transmission lines equal to or greater than the value given. The minimum kV Rating can be used in conjunction with the maximum kV Rating to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "kVratingMax",
"description": "The maximum kV Rating searches for transmission lines equal to or less than the value given. The maximum kV Rating can be used in conjunction with the minimum kV Rating to select a range.\n",
"schema": {
"format": "int64",
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offshore",
"description": "Search for either Transmission Line Origination/Destination/Connection Onshore (0) or Offshore (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "originationOffshore",
"description": "Search by Transmission Line Origination Onshore (0) or Offshore (1).\n",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "originationWorldRegionId",
"description": "World Region ID of the Transmission Line Origination. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "originationWorldRegionName",
"description": "World Region name of the Transmission Line Origination. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "originationMarketRegionId",
"description": "Market Region ID of the Transmission Line Origination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "originationMarketRegionName",
"description": "Market Region name of the Transmission Line Origination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "originationCountryName",
"description": "Country name of the Transmission Line Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "originationStateName",
"description": "State name of Transmission Line Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "originationCountyName",
"description": "County name of the Transmission Line Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Hidalgo"
}
},
"in": "query"
},
{
"name": "originationCity",
"description": "City of the Transmission Line Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Edinburg"
}
},
"in": "query"
},
{
"name": "originationPostalCode",
"description": "Postal Code of the Transmission Line Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 78539
}
},
"in": "query"
},
{
"name": "originationAddress",
"description": "Physical Address of the Transmission Line Origination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Intersection of FM 1925 & FM 2061"
}
},
"in": "query"
},
{
"name": "originationOffshoreCountryName",
"description": "Offshore Country of the Transmission Line Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "originationOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Transmission Line Origination. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "originationOffshoreAreaName",
"description": "Offshore Area of the Transmission Line Origination. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "originationOffshoreFieldName",
"description": "Offshore Field of the Transmission Line Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "originationOffshoreBlock",
"description": "Offshore Quadrant/Block of the Transmission Line Origination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "destinationOffshore",
"description": "Search by Transmission Line Destination Onshore (0) or Offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "destinationWorldRegionId",
"description": "World Region ID of the Transmission Line Destination. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "destinationWorldRegionName",
"description": "World Region name of the Transmission Line Destination. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "destinationMarketRegionId",
"description": "Market Region ID of the Transmission Line Destination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "destinationMarketRegionName",
"description": "Market Region name of the Transmission Line Destination. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "destinationCountryName",
"description": "Country name of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "destinationStateName",
"description": "State name of Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "destinationCountyName",
"description": "County name of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Nueces"
}
},
"in": "query"
},
{
"name": "destinationCity",
"description": "City of the Transmission Line Destination. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Corpus Christi"
}
},
"in": "query"
},
{
"name": "destinationPostalCode",
"description": "Postal Code of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Corpus Christi"
}
},
"in": "query"
},
{
"name": "destinationAddress",
"description": "Physical Address of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Intersection of Yorktown Blvd & Waldron Road"
}
},
"in": "query"
},
{
"name": "destinationOffshoreCountryName",
"description": "Offshore Country of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "destinationOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Transmission Line Destination. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "destinationOffshoreAreaName",
"description": "Offshore Area of the Transmission Line Destination. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "destinationOffshoreFieldName",
"description": "Offshore Field of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "destinationOffshoreBlock",
"description": "Offshore Quadrant/Block of the Transmission Line Destination. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "connectionOffshore",
"description": "To search by Transmission Line Connection Onshore (0) or Offshore (1).",
"schema": {
"enum": [
"0",
"1"
],
"type": "string",
"example": 0
},
"in": "query"
},
{
"name": "connectionWorldRegionId",
"description": "World Region ID of the Transmission Line Connection. Searching by World Region ID will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n 1 - North America\n 2 - Middle America\n 3 - South America\n 4 - Europe\n 5 - Africa\n 6 - Asia\n 7 - Oceania\n\n ",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 1
}
},
"in": "query"
},
{
"name": "connectionWorldRegionName",
"description": "World Region name of the Transmission Line Connection. Searching by World Region name will provide results based on a specific world region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n North America\n Middle America\n South America\n Europe\n Africa\n Asia\n Oceania\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "North America"
}
},
"in": "query"
},
{
"name": "connectionMarketRegionId",
"description": "Market Region ID of the Transmission Line Connection. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n AC - Atlantic Canada\n CA - Central America\n CR - Caribbean\n CS - Central Asia\n EA - East Asia\n EAF - Eastern Africa\n EU - Eastern Europe\n GL - Great Lakes\n GLD - Greenland\n MA - Mid Atlantic\n MAF - Middle Africa\n MW - Midwest\n MX - Mexico\n NAF - Northern Africa\n NE - Northeast\n NG - New England\n NU - Northern Europe\n OC - Oceania\n ON - Ontario\n PQ - Quebec\n RM - Rocky Mountains\n RU - Russia\n SA - Southeast Asia\n SAF - Southern Africa\n SE - Southeast\n SO - South America\n SS - South Asia\n SU - Southern Europe\n SW - Southwest\n TR - Turkey\n WA - Western Asia\n WAF - Western Africa\n WC - West Coast\n WCA - Western Canada\n WU - Western Europe\n ",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "SW"
}
},
"in": "query"
},
{
"name": "connectionMarketRegionName",
"description": "Market Region name of the Transmission Line Connection. Searching by Market Region will provide results based on a specific market region. This parameter supports multiple values.\n\n\nList of supported values:
\n\n Atlantic Canada\n Central America\n Caribbean\n Central Asia\n East Asia\n Eastern Africa\n Eastern Europe\n Great Lakes\n Greenland\n Mid Atlantic\n Middle Africa\n Midwest\n Mexico\n Northern Africa\n Northeast\n New England\n Northern Europe\n Oceania\n Ontario\n Quebec\n Rocky Mountains\n Russia\n Southeast Asia\n Southern Africa\n Southeast\n South America\n South Asia\n Southern Europe\n Southwest\n Turkey\n Western Asia\n Western Africa\n West Coast\n Western Canada\n Western Europe\n \n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Southwest"
}
},
"in": "query"
},
{
"name": "connectionCountryName",
"description": "Country name of the Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "connectionStateName",
"description": "State name of Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
}
},
"in": "query"
},
{
"name": "connectionCountyName",
"description": "County name of the Transmission Line Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Harris"
}
},
"in": "query"
},
{
"name": "connectionCity",
"description": "City of the Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Houston"
}
},
"in": "query"
},
{
"name": "connectionPostalCode",
"description": "Postal Code of the Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 77479
}
},
"in": "query"
},
{
"name": "connectionAddress",
"description": "Physical Address of the Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "2277 Plaza"
}
},
"in": "query"
},
{
"name": "connectionOffshoreCountryName",
"description": "Offshore Country of the Transmission Line Connection. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "U.S.A."
}
},
"in": "query"
},
{
"name": "connectionOffshoreWaterbodyName",
"description": "Offshore Waterbody of the Transmission Line Connection. Searching by Offshore Waterbody name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Gulf of Mexico"
}
},
"in": "query"
},
{
"name": "connectionOffshoreAreaName",
"description": "Offshore Area of the Transmission Line Connection. Searching by Offshore Area name can be done using one or multiple keywords. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Garden Banks"
}
},
"in": "query"
},
{
"name": "connectionOffshoreFieldName",
"description": "Offshore Field of the Transmission Line Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "EI361"
}
},
"in": "query"
},
{
"name": "connectionOffshoreBlock",
"description": "Offshore Quadrant/Block of the Transmission Line Connection. This parameter supports multiple values.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": 331
}
},
"in": "query"
},
{
"name": "releaseDateMin",
"description": "Search for transmission line records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by minimum release date simply enter the date using the correct format (YYYY-MM-DD). The transmission line minimum release date can be used in conjunction with the maximum release date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2018-12-01"
},
"in": "query"
},
{
"name": "releaseDateMax",
"description": "Search for transmission line records that have been updated over a specific period of time. This includes full quality control updates as well as record updates throughout the year. To search by maximum release date simply enter the date using the correct format (YYYY-MM-DD). The transmission line maximum release date can be used in conjunction with the minimum release date to select a date range.",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-01"
},
"in": "query"
},
{
"name": "liveDateMin",
"description": "Search for new transmission line records that have not been previously reported or updated. To search by minimum live date simply enter the date using the correct format (YYYY-MM-DD). The transmission line minimum live date can be used in conjunction with the maximum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2019-01-02"
},
"in": "query"
},
{
"name": "liveDateMax",
"description": "Search for new transmission line records that have not been previously reported or updated. To search by maximum live date simply enter the date using the correct format (YYYY-MM-DD). The transmission line maximum live date can be used in conjunction with the minimum live date to select a date range.\n",
"schema": {
"format": "date-time",
"type": "string",
"example": "2020-01-02"
},
"in": "query"
},
{
"name": "limit",
"description": "Number of transmission line results to return. By default, it will return 100 records. Maximum is 1000 records.",
"schema": {
"type": "integer",
"example": 100
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned transmission line results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transmissionLineSummaryResponse"
},
"examples": {
"transmissionLineSummaryResponse": {
"value": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"transmissionLines": [
{
"tLineId": 3501014,
"tLineName": "Transmission Line B",
"tLineParentName": "Ameron Concrete And Steel",
"transmissionSystemId": 9,
"transmissionSystemName": "Test Transmission System 4 Life",
"tLineStatusDesc": "Operational",
"tLineType": "AC",
"systemLengthMiles": 500,
"systemLengthKilometers": 804,
"tLineOrigination": {
"plantPhysicalAddress": {
"city": "Saint Petersburg",
"stateName": "Florida",
"countryName": "U.S.A."
}
},
"tLineDestination": {
"plantPhysicalAddress": {
"city": "Waynesburg",
"stateName": "Pennsylvania",
"countryName": "U.S.A."
}
}
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getTransmissionLineSummary",
"summary": "Return Transmission Line(s) Summary",
"description": "Returns up to 100 transmission line records by default (maximum is 1000, with parameter \"limit\") based on the provided search criteria and user's coverage. To get detailed information, please use the Transmission Line ID returned here and refer to the [/transmissionlines/detail](#post-/transmissionlines/detail) endpoint.\n\nCertain search parameters support multiple values. To search by multiple values, use the same parameter multiple times with different values (if parameter type is an Array, then it's searchable by multiple values).\n\nAdditionally, there are certain parameters that support wildcard keyword search. To search by multiple keywords, use the same parameter multiple times with different keywords.\n\nExamples:\n\nSearching by multiple values: \n\n tLineId=3500347&transmissionLineId=3500388\n \nSearching by wildcard keyword:\n\n tLineName= mission\n \n Example of returned transmission lines:\n \"tLineName\": \"Transmission Line B\"\n \"tLineName\": \"Transmission Line Z\"\n \n\nThese are the supported parameters:"
}
},
"/transmissionlines/detail": {
"summary": "Find Transmission Line Detail by ID",
"description": "Returns Transmission Line Details.",
"post": {
"tags": [
"Transmission Line Search"
],
"parameters": [
{
"name": "tLineId",
"description": "The ID of the transmission line. The Transmission Line ID is a unique seven-digit number used by IIR that is assigned to each transmission line profile. This parameter supports multiple values.\n",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer",
"example": 3501034
}
},
"in": "query"
},
{
"name": "fields",
"description": "Specify the fields you want to return.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"in": "query",
"required": false
},
{
"name": "limit",
"description": "Number of transmission line results to return. By default, it will return 5 records. Maximum is 50 records.",
"schema": {
"type": "integer",
"example": 50
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned transmission line results by this amount.",
"schema": {
"type": "integer",
"example": 0
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transmissionLineDetailResponse"
},
"examples": {
"transmissionLineDetailResponse": {
"value": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"transmissionLines": [
{
"tLineId": 3501014,
"tLineName": "Transmission Line B",
"tLineOperatorName": "Comision Federal",
"tLineParentName": "Ameron Concrete And Steel",
"transmissionSystemId": 9,
"tLineStatusDesc": "Operational",
"tLineType": "AC",
"kVRating": 280,
"systemLengthMiles": 500,
"systemLengthKilometers": 804,
"overhead": "1",
"belowGround": "0",
"subsea": "0",
"offshore": 0,
"tLineOrigination": {
"plantId": 1049059,
"plantName": "40th Street Substation",
"offshore": 0,
"plantPhysicalAddress": {
"addressLine1": "4055 13Th Ave N",
"countyName": "Pinellas",
"city": "Saint Petersburg",
"stateName": "Florida",
"countryName": "U.S.A.",
"postalCode": "33713"
},
"plantLatitude": 27.784792,
"plantLongitude": -82.688281,
"worldRegionId": 1,
"worldRegionName": "North America",
"marketRegionId": "SE",
"marketRegionName": "Southeast"
},
"tLineDestination": {
"plantId": 1082769,
"plantName": "502 Junction Substation",
"offshore": 0,
"plantPhysicalAddress": {
"addressLine1": "From SW PA to Mt Storm subs (WV)",
"countyName": "Greene",
"city": "Waynesburg",
"stateName": "Pennsylvania",
"countryName": "U.S.A.",
"postalCode": "15370"
},
"plantLatitude": 39.813552,
"plantLongitude": -80.188344,
"worldRegionId": 1,
"worldRegionName": "North America",
"marketRegionId": "NE",
"marketRegionName": "Northeast"
},
"liveDate": "2018-03-29T21:27:28Z[UTC]",
"releaseDate": "2018-03-29T21:27:28Z[UTC]",
"tLineOwner": [
{
"companyId": 1050737,
"companyName": "Ameron Concrete And Steel",
"secondaryName": "David wuz here",
"classification": "P",
"ownerPercent": 100,
"address": {
"addressLine1": "2325 South 7th Street",
"addressLine2": "Test",
"city": "Phoenix",
"stateName": "Arizona",
"countryName": "U.S.A.",
"postalCode": "850345597"
}
}
]
}
]
}
}
}
}
},
"description": "OK"
}
},
"operationId": "getTransmissionLineDetail",
"summary": "Return Transmission Line(s) Detail",
"description": "Returns up to 5 transmission line records by default (maximum is 50, with parameter \"limit\") based on the provided search criteria and user's coverage.\n\nBy default, the request sends back a default set of predefined fields specific to the endpoint used. To return the exact fields you need and improve performance, use the fields
query parameter in your method call.\n\nExample:\n\n transmissionlines/detail?tLineId=3501033&fields=tLineId&fields=tLineName&fields=tLineStatusDesc&fields=tLineType\n\nThese are the supported parameters:"
}
}
},
"components": {
"schemas": {
"faxNumber": {
"description": "Fax Number",
"type": "object",
"properties": {
"cc": {
"description": "Fax country code number.",
"type": "string"
},
"number": {
"description": "Fax number of the plant.",
"type": "string"
}
}
},
"pipelineSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"pipelines"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of pipeline results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned pipeline results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of pipeline results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of pipelines IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"pipelines": {
"description": "List of pipelines IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineSummaryFields"
}
}
}
},
"projectCapacity": {
"description": "Project Capacity",
"required": [
"productId",
"productDesc",
"UOM"
],
"type": "object",
"properties": {
"installedCapacity": {
"format": "double",
"description": "Installed (existing) capacity of the project.",
"type": "number"
},
"plannedCapacity": {
"format": "double",
"description": "Planned (new) capacity of the project.",
"type": "number"
},
"productId": {
"description": "Product ID",
"type": "string"
},
"productDesc": {
"description": "Product description.",
"type": "string"
},
"uom": {
"description": "Capacity unit of measure.",
"type": "string"
}
}
},
"biddingCompanies": {
"description": "Bidding Companies",
"required": [
"companyId",
"companyName",
"projectResponsibility"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "ID of the bidder company.",
"type": "integer"
},
"companyName": {
"description": "Name of the bidder company.",
"type": "string"
},
"projectResponsibility": {
"description": "Project responsibility of the bidder company.",
"type": "string"
}
}
},
"miningMethod": {
"description": "Mining Methods",
"type": "object",
"properties": {
"placer": {
"description": "Placer mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"openPit": {
"description": "Open Pit mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"quarry": {
"description": "Quarry mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"strip": {
"description": "Strip (Open Cast & Mountain Top) mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"auger": {
"description": "Auger mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"hydraulic": {
"description": "Hydraulic mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"boreHole": {
"description": "Borehole mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"dredging": {
"description": "Dredging mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"drift": {
"description": "Drift mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"shaft": {
"description": "Shaft mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"slope": {
"description": "Slope mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"longwall": {
"description": "Longwall mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"roomPillar": {
"description": "Room & Pillar mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"cutFill": {
"description": "Cut and Fill mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"caving": {
"description": "Caving (Long Hole & Sub-Level) mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"stoping": {
"description": "Stoping mining method.",
"enum": [
"0",
"1"
],
"type": "string"
},
"inSituSolution": {
"description": "In-Situ – Solution & Leaching mining method.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"oilGasBasins": {
"description": "The Oil & Gas Basins to which the Plant is connected to.",
"type": "object",
"properties": {
"oilGasBasinDesc": {
"description": "Oil & Gas Basin description. ",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"shalePlays": {
"description": "The Shale Plays to which the Plant is connected for feedstock.",
"type": "object",
"properties": {
"shalePlayDesc": {
"description": "Shale Play description.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"coalUsage": {
"description": "Coal Usage of the plant.",
"type": "object",
"properties": {
"metallurgical": {
"description": "Metallurgical Coal Usage.",
"enum": [
"0",
"1"
],
"type": "string"
},
"thermal": {
"description": "Thermal/Steam Coal Usage.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"transportationMode": {
"description": "Transportation Modes",
"type": "object",
"properties": {
"highway": {
"description": "Truck/Highway transportation mode.",
"enum": [
"0",
"1"
],
"type": "string"
},
"pipe": {
"description": "Pipeline transportation mode.",
"enum": [
"0",
"1"
],
"type": "string"
},
"rail": {
"description": "Rail transportation mode.",
"enum": [
"0",
"1"
],
"type": "string"
},
"air": {
"description": "Air transportation mode.",
"enum": [
"0",
"1"
],
"type": "string"
},
"dock": {
"description": "Dock/Port transportation mode.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"projectKeyNeeds": {
"description": "Equipment requirements for a project.",
"type": "object",
"properties": {
"architectural": {
"description": "Architectural equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"batchProcess": {
"description": "Batch Process equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"civilSite": {
"description": "Civil/Site equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"communications": {
"description": "Communications equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"continuousProcess": {
"description": "Continuous Process equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"controlRoom": {
"description": "Control Room equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"electrical": {
"description": "Electrical equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"environmental": {
"description": "Environmental equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"feedstock": {
"description": "Feedstock equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"heatTransfer": {
"description": "Heat Transfer equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"hvac": {
"description": "HVAC equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"instrumentation": {
"description": "Instrumentation equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"insulationCoatings": {
"description": "Insulation/Coatings equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"mechanical": {
"description": "Mechanical equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"miningEquip": {
"description": "Mining equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"materialHandling": {
"description": "Material Handling equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"nde": {
"description": "NDE equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"packaging": {
"description": "Packaging equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"pipingFittings": {
"description": "Piping/Fittings equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"processEquip": {
"description": "Process Equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"pumps": {
"description": "Pumps equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"structural": {
"description": "Structural equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"storage": {
"description": "Storage equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"transportation": {
"description": "Transportation equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"utilities": {
"description": "Utilities equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"valves": {
"description": "Valves equipment key needs. Reflect equipment requirements for a project.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"constructionKeyNeeds": {
"description": "Contracting services required for a project.",
"type": "object",
"properties": {
"civil": {
"description": "Civil construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"electrical": {
"description": "Electrical construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"environmental": {
"description": "Environmental construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"hvac": {
"description": "HVAC construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"instrumentation": {
"description": "Instrumentation construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"mechanical": {
"description": "Mechanical construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"structural": {
"description": "Structural construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"general": {
"description": "General construction key needs. Reflect contracting services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"engineeringKeyNeeds": {
"description": "Engineering services required for a project.",
"type": "object",
"properties": {
"civil": {
"description": "Civil engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"electrical": {
"description": "Electrical engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"environmental": {
"description": "Environmental engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"hvac": {
"description": "HVAC engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"instrumentation": {
"description": "Instrumentation engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"mechanical": {
"description": "Mechanical engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"structural": {
"description": "Structural engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"process": {
"description": "Process engineering key needs. Reflect engineering services required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"matterPhase": {
"description": "Matter Phases of the project.",
"type": "object",
"properties": {
"gas": {
"description": "Gas matter phase.",
"enum": [
"0",
"1"
],
"type": "string"
},
"liquid": {
"description": "Liquid matter phase.",
"enum": [
"0",
"1"
],
"type": "string"
},
"plasma": {
"description": "Plasma matter phase.",
"enum": [
"0",
"1"
],
"type": "string"
},
"solid": {
"description": "Solid matter phase.",
"enum": [
"0",
"1"
],
"type": "string"
},
"vapor": {
"description": "Vapor matter phase.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"environmentalRequirements": {
"description": "Environmental requirements for a project. Each report is tagged with environmental requirements for Air (A), Land (L) or Water (W) when a project requires the procurement of environmental, technologies, equipment, materials or services.",
"type": "object",
"properties": {
"air": {
"format": "int64",
"description": "Environmental requirements for Air.",
"type": "integer"
},
"land": {
"format": "int64",
"description": "Environmental requirements for Land.",
"type": "integer"
},
"water": {
"format": "int64",
"description": "Environmental requirements for Water.",
"type": "integer"
}
}
},
"fuel": {
"description": "The Fuel/Energy Source Types.",
"type": "object",
"properties": {
"primaryFuel": {
"description": "The primary fuel/energy source.",
"type": "string"
},
"secondaryFuel": {
"description": "The secondary fuel/energy source.",
"type": "string"
},
"fuelGroup": {
"description": "The Fuel Group.",
"type": "string"
}
}
},
"physicalAddressSummary": {
"description": "Physical Address.",
"type": "object",
"properties": {
"city": {
"description": "City.",
"type": "string"
},
"stateName": {
"description": "State.",
"type": "string"
},
"countryName": {
"description": "Country.",
"type": "string"
}
}
},
"fuelSummary": {
"description": "The Fuel/Energy Source Types.",
"type": "object",
"properties": {
"primaryFuel": {
"description": "The primary fuel/energy source.",
"type": "string"
}
}
},
"transmissionLineDestinationSummary": {
"description": "Transmission Line Destination.",
"type": "object",
"properties": {
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "The Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "The Offshore Address of the plant."
}
}
},
"transmissionLineOriginationSummary": {
"description": "Transmission Line Origination.",
"type": "object",
"properties": {
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "The Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "The Offshore Address of the plant."
}
}
},
"pipelineOriginationSummary": {
"description": "Pipeline Origination.",
"type": "object",
"properties": {
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "The Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "The Offshore Address of the plant."
}
}
},
"pipelineDestinationSummary": {
"description": "Pipeline Destination.",
"type": "object",
"properties": {
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "The Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "The Offshore Address of the plant."
}
}
},
"capacity": {
"description": "Capacity",
"required": [
"productDesc",
"type",
"UOM"
],
"type": "object",
"properties": {
"productId": {
"description": "Product ID.",
"type": "string"
},
"productDesc": {
"description": "Product description.",
"type": "string"
},
"type": {
"description": "The capacity type. Feed vs Output.",
"type": "string"
},
"actualCapacity": {
"format": "double",
"description": "Actual capacity. ",
"type": "number"
},
"designCapacity": {
"format": "double",
"description": "Design capacity.",
"type": "number"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
}
}
},
"futureCapacity": {
"description": "Unit Future Capacity",
"type": "object",
"properties": {
"type": {
"description": "The capacity type. Feed vs Output.",
"type": "string"
},
"productId": {
"description": "Product ID.",
"type": "string"
},
"productDesc": {
"description": "Product description.",
"type": "string"
},
"currentCapacity": {
"format": "double",
"description": "Current Capacity of the unit.",
"type": "number"
},
"futureCapacity": {
"format": "double",
"description": "Future Capacity of the unit. Will be renamed to plannedCapacity in v2.2.",
"type": "number"
},
"capacityChange": {
"format": "int64",
"description": "Capacity Change. Deprecated. Will not exist in v2.2.",
"type": "integer"
},
"futureKickoffDate": {
"format": "date-time",
"description": "Future Capacity Kickoff Date.",
"type": "string"
},
"futureCompletionDate": {
"format": "date-time",
"description": "Future Capacity Completion/Online date.",
"type": "string"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
},
"futureCapacityStatus": {
"description": "Status of the future capacity.",
"type": "string"
}
}
},
"sicCodeResponse": {
"description": "SIC Codes Details",
"type": "object",
"properties": {
"limit": {
"description": "Limit number of SIC Code results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned SIC Code results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of SIC Code results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of SIC Codes IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"sicCodes": {
"description": "List of SIC Codes IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sicCodeFields"
}
}
}
},
"controlAreaFields": {
"type": "object",
"properties": {
"controlAreaId": {
"description": "Balancing Authority/Control Area ID (e.g. \"WALC\").",
"type": "string"
},
"controlAreaName": {
"description": "Balancing Authority/Control Area name (e.g. \"Western Area Power Administration - Desert Southwest Region\"). ",
"type": "string"
}
}
},
"hsProductFields": {
"type": "object",
"properties": {
"hsProductId": {
"description": "HS Product ID.",
"type": "string"
},
"hsProductDesc": {
"description": "HS Product description.",
"type": "string"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
},
"sicCode": {
"description": "SIC Code.",
"type": "string"
},
"sicCodeDesc": {
"description": "SIC Code description.",
"type": "string"
}
}
},
"sicProductFields": {
"type": "object",
"properties": {
"sicProductId": {
"description": "SIC Product ID.",
"type": "string"
},
"sicProductDesc": {
"description": "SIC Product description.",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
}
}
},
"pecZoneFields": {
"type": "object",
"properties": {
"pecZoneId": {
"description": "Zone ID.",
"type": "string"
},
"pecZoneName": {
"description": "Zone Name.",
"type": "string"
}
}
},
"equipmentTypesFields": {
"type": "object",
"properties": {
"equipmentTypeId": {
"format": "int32",
"description": "Equipment Type ID.",
"type": "integer"
},
"equipmentTypeDesc": {
"description": "Equipment Type description.",
"type": "string"
}
}
},
"unitTypesFields": {
"type": "object",
"properties": {
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
}
}
},
"sicCodeFields": {
"description": "SIC Codes Details",
"required": [
"sicCode",
"sicCodeDesc"
],
"type": "object",
"properties": {
"sicCode": {
"description": "SIC Code.",
"type": "string"
},
"sicCodeDesc": {
"description": "SIC Code description.",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
}
}
},
"sicProduct": {
"description": "The Product SIC Code(s) of the plant.",
"type": "object",
"properties": {
"sicProductId": {
"description": "SIC Product ID of the plant.",
"type": "string"
},
"sicProductDesc": {
"description": "SIC Product description.",
"type": "string"
}
}
},
"offlineCapacitySummary": {
"description": "The Capacity Off-Line.",
"type": "object",
"properties": {
"capacityOffline": {
"format": "int64",
"description": "Capacity Off-line.",
"type": "integer"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
}
}
},
"pipelineProduct": {
"description": "Products Carried by the pipeline.",
"type": "object",
"properties": {
"productId": {
"description": "Product ID.",
"type": "string"
},
"productDesc": {
"description": "Product description.",
"type": "string"
},
"productStatus": {
"description": "Product Status.",
"type": "string"
},
"productCapacity": {
"format": "double",
"description": "Product Capacity.",
"type": "number"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
}
}
},
"pipelineOrigination": {
"description": "Pipeline Origination Details.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"diameterOutInches": {
"format": "int64",
"description": "Diameter Out (Inches).",
"type": "integer"
},
"diameterOutCentimeters": {
"format": "int64",
"description": "Diameter Out (Centimeters).",
"type": "integer"
}
}
},
"transmissionLineOrigination": {
"description": "Transmission Line Origination Details.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
}
}
},
"transmissionLineDestination": {
"description": "Transmission Line Destination Details.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
}
}
},
"ownerCompanySummary": {
"description": "Owner Company.",
"type": "object",
"properties": {
"companyName": {
"description": "Owner name.",
"type": "string"
}
}
},
"operatorCompany": {
"description": "Operator of the plant.",
"required": [
"companyId",
"companyName"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "Operator ID.",
"type": "integer"
},
"companyName": {
"description": "Operator name.",
"type": "string"
}
}
},
"parentCompany": {
"description": "Parent Company of the plant.",
"required": [
"companyId",
"companyName",
"website"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "Parent Company ID.",
"type": "integer"
},
"companyName": {
"description": "Parent Company name.",
"type": "string"
},
"website": {
"description": "Website of the Parent Company.",
"type": "string"
}
}
},
"offshoreAddressSummary": {
"description": "Offshore Address.",
"type": "object",
"properties": {
"offshoreFieldName": {
"description": "Offshore Field.",
"type": "string"
},
"offshoreWaterbodyName": {
"description": "Offshore Waterbody.",
"type": "string"
},
"offshoreCountryName": {
"description": "Offshore Country.",
"type": "string"
}
}
},
"offshoreAddress": {
"description": "Offshore Address.",
"type": "object",
"properties": {
"offshoreBlockV1": {
"description": "Offshore Quadrant/Block V1.",
"type": "string"
},
"offshoreBlockV2": {
"description": "Offshore Quadrant/Block V2. Optional.",
"type": "string"
},
"offshoreFieldName": {
"description": "Offshore Field.",
"type": "string"
},
"offshoreWaterbodyName": {
"description": "Offshore Waterbody.",
"type": "string"
},
"offshoreCountryName": {
"description": "Offshore Country.",
"type": "string"
},
"offshoreAreaName": {
"description": "Offshore Area.",
"type": "string"
}
}
},
"otherEquipmentSummaryFields": {
"required": [
"equipmentId",
"equipmentStatusDesc",
"equipmentType",
"plantId",
"plantName",
"plantPhysicalAddress",
"plantOwnerName",
"unitId",
"unitName",
"unitTypeDesc"
],
"type": "object",
"properties": {
"equipmentId": {
"format": "int32",
"description": "The ID of the equipment. The Equipment ID is a unique number assigned to each equipment.",
"type": "integer"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitTypeDesc": {
"description": "The Unit Type description.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"equipmentType": {
"description": "The Equipment Type. Each equipment is identified with a type.",
"type": "string"
},
"equipmentManufacturerName": {
"description": "The Manufacturer of the equipment. Equipment are identified by their manufacturer.",
"type": "string"
},
"equipmentVendor": {
"description": "The Vendor/Packager of the equipment.",
"type": "string"
},
"equipmentStatusDesc": {
"description": "Status of the equipment.",
"type": "string"
},
"equipmentInformation": {
"description": "The Equipment Information. Additional information is available for equipment such as the Model and Environmental Controls.",
"type": "string"
}
}
},
"transmissionLineSummaryFields": {
"required": [
"transmissionLineId",
"tLineType",
"tLineStatusDesc",
"tLineParentName",
"tLineOrigination",
"tLineDestination",
"tLineId",
"tLineName"
],
"type": "object",
"properties": {
"tLineId": {
"format": "int32",
"description": "The ID of the transmission line. The Transmission Line ID is a seven-digit unique number used by IIR that is assigned to each transmission line profile.",
"type": "integer"
},
"tLineName": {
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name.",
"type": "string"
},
"tLineParentName": {
"description": "The Parent Company name of transmission line.",
"type": "string"
},
"tLineOrigination": {
"$ref": "#/components/schemas/transmissionLineOriginationSummary"
},
"tLineDestination": {
"$ref": "#/components/schemas/transmissionLineDestinationSummary"
},
"tLineType": {
"description": "The Type of Transmission Line. There are two different types of transmission lines: AC and DC.",
"type": "string"
},
"tLineStatusDesc": {
"description": "Status of the transmission line.",
"type": "string"
},
"tLineLengthMiles": {
"format": "int64",
"description": "Transmission Line Length (Miles).",
"type": "integer"
},
"tLineLengthKilometers": {
"format": "int64",
"description": "Transmission Line Length (Kilometers).",
"type": "integer"
},
"transmissionSystemId": {
"format": "int32",
"description": "The ID of the transmission system.",
"type": "integer"
},
"transmissionSystemName": {
"description": "Name of the transmission system.",
"type": "string"
},
"systemLengthMiles": {
"format": "int64",
"description": "Transmission System Length (Miles).",
"type": "integer"
},
"systemLengthKilometers": {
"format": "int64",
"description": "Transmission Line System Length (Kilometers).",
"type": "integer"
}
}
},
"pipelineDestination": {
"description": "Pipeline Destination Details.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"diameterInInches": {
"format": "int64",
"description": "Diameter In (Inches).",
"type": "integer"
},
"diameterInCentimeters": {
"format": "int64",
"description": "Diameter In (Centimeters).",
"type": "integer"
}
}
},
"pipelineConnections": {
"description": "Pipeline Connections.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"industryCodeDesc": {
"description": "The Industry Code description.",
"type": "string"
},
"receiptDeliveryPoint": {
"description": "Receipt/Delivery.",
"type": "string"
},
"diameterInInches": {
"format": "int64",
"description": "Diameter In (Inches).",
"type": "integer"
},
"diameterInCentimeters": {
"format": "int64",
"description": "Diameter In (Centimeters).",
"type": "integer"
},
"diameterOutInches": {
"format": "int64",
"description": "Diameter Out (Inches).",
"type": "integer"
},
"diameterOutCentimeters": {
"format": "int64",
"description": "Diameter Out (Centimeters).",
"type": "integer"
},
"diameterUom": {
"description": "Diameter Unit of Measure.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
}
}
},
"driveSummaryFields": {
"required": [
"driveId",
"unitName",
"unitTypeDesc",
"plantName",
"plantOwnerName",
"driveStatusDesc",
"primaryFuel",
"physicalAddress",
"offshoreAddress",
"plantId",
"plantPhysicalAddress",
"unitId"
],
"type": "object",
"properties": {
"driveId": {
"format": "int32",
"description": "The ID of the Drive. The Drive ID is a unique number assigned to each drive.",
"type": "integer"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
},
"unitId": {
"format": "int32",
"description": "The ID of the Unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of Plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"driveInformation": {
"description": "Drive Information. Additional information is included for drives such as Drive Model, Inlet Cooling and Environmental Controls.",
"type": "string"
},
"driveStatusDesc": {
"description": "Status of the drive.",
"type": "string"
},
"driveManufacturerName": {
"description": "The Manufacturer of the drive. Combustion and Steam Drives are identified by their manufacturer.",
"type": "string"
},
"drivenEquipmentManufacturerName": {
"description": "Driven Equipment Manufacturer. Generators, Pumps and Compressors are identified by their current manufacturer.",
"type": "string"
},
"driveCapacityMegawatts": {
"format": "double",
"description": "Drive Capacity - Megawatts.",
"type": "number"
},
"fuel": {
"$ref": "#/components/schemas/fuelSummary",
"description": "The Fuel/Energy Source Types."
},
"driveStartupDate": {
"format": "date-time",
"description": "Drive Start-Up Date.",
"type": "string"
}
}
},
"physicalAddress": {
"description": "Physical Address.",
"required": [
"addressLine1",
"city",
"stateName",
"countryName",
"postalCode",
"countyName"
],
"type": "object",
"properties": {
"addressLine1": {
"description": "Street Address Line 1.",
"type": "string"
},
"addressLine2": {
"description": "Street Address Line 2. (Optional)",
"type": "string"
},
"city": {
"description": "City.",
"type": "string"
},
"stateName": {
"description": "State.",
"type": "string"
},
"postalCode": {
"description": "Postal Code.",
"type": "string"
},
"countryName": {
"description": "Country.",
"type": "string"
},
"countyName": {
"description": "County.",
"type": "string"
}
}
},
"secondarySic": {
"description": "The Secondary Plant SIC Code(s).",
"type": "object",
"properties": {
"sicId": {
"description": "Secondary SIC ID.",
"type": "string"
},
"sicDesc": {
"description": "Secondary SIC description.",
"type": "string"
}
}
},
"boilerSummaryFields": {
"required": [
"boilerId",
"boilerName",
"boilerTypeDesc",
"unitName",
"plantName",
"plantOwnerName",
"unitStatusDesc",
"unitTypeDesc",
"physicalAddress",
"plantId",
"unitId"
],
"type": "object",
"properties": {
"boilerId": {
"format": "int32",
"description": "The ID of the boiler. The Boiler ID is a unique number assigned to each boiler.",
"type": "integer"
},
"boilerName": {
"description": "Name of the boiler.",
"type": "string"
},
"boilerTypeDesc": {
"description": "Boiler Type. Each boiler is identified with a type. Types range from Fluidized Bed Boilers to Package Boilers.",
"type": "string"
},
"boilerInformation": {
"description": "Boiler Information. Additional information is included for boilers such as Model and Environmental Controls. ",
"type": "string"
},
"boilerManufacturerName": {
"description": "The Manufacturer name of the boiler. Boilers are identified by their manufacturer.",
"type": "string"
},
"boilerSteamCapacity": {
"format": "int64",
"description": "Boiler Capacity.",
"type": "integer"
},
"steamCapacityUom": {
"description": "Unit of Measure of the boiler capacity.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuelSummary",
"description": "The Fuel/Energy Source Types."
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit.",
"type": "string"
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"offshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
}
}
},
"pipelineOwnerSummary": {
"description": "Owner Name.",
"type": "object",
"properties": {
"companyName": {
"description": "Pipeline Owner Name.",
"type": "string"
}
}
},
"pipelineSummaryFields": {
"required": [
"pipelineId",
"pipelineName",
"pipelineOwnerName",
"pipelineStatus",
"primaryProductDesc",
"pipelineOrigination",
"pipelineDestination",
"pipelineOwner",
"pipelineStatusDesc"
],
"type": "object",
"properties": {
"pipelineId": {
"format": "int32",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile.",
"type": "integer"
},
"pipelineName": {
"description": "Name of the pipeline. Pipeline names are based on the Owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to.",
"type": "string"
},
"pipelineOwner": {
"description": "Owner Name.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineOwnerSummary"
}
},
"pipelineOrigination": {
"$ref": "#/components/schemas/pipelineOriginationSummary"
},
"pipelineDestination": {
"$ref": "#/components/schemas/pipelineDestinationSummary"
},
"pipelineStatusDesc": {
"description": "Status of the pipeline.",
"type": "string"
},
"primaryProductDesc": {
"description": "Pipeline Primary product carried.",
"type": "string"
},
"pipelineLengthMiles": {
"format": "int64",
"description": "Pipeline Length (Miles).",
"type": "integer"
},
"pipelineLengthKilometers": {
"format": "int64",
"description": "Pipeline Length (Kilometeres).",
"type": "integer"
},
"pipelineSystemId": {
"format": "int32",
"description": "The ID of the Pipeline System.",
"type": "integer"
},
"pipelineSystemName": {
"description": "Name of the Pipeline System.",
"type": "string"
},
"systemLengthMiles": {
"format": "int64",
"description": "Pipeline System Length (Miles).",
"type": "integer"
},
"systemLengthKilometers": {
"format": "int64",
"description": "Pipeline System Length (Kilometers).",
"type": "integer"
}
}
},
"transmissionLineDetailFields": {
"required": [
"transmissionLineId",
"transmissionLineOrigination",
"transmissionLineDestination",
"tLineId",
"tLineName",
"tLineOperatorName",
"tLineParentName",
"tLineOwner",
"kVRating",
"tLineType",
"tLineDestination",
"tLineOrigination",
"releaseDate",
"liveDate",
"tLineStatusDesc"
],
"type": "object",
"properties": {
"tLineId": {
"format": "int32",
"description": "The ID of the transmission line. The Transmission Line ID is a seven-digit unique number used by IIR that is assigned to each transmission line profile.",
"type": "integer"
},
"tLineName": {
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name.",
"type": "string"
},
"tLineOperatorName": {
"description": "Operator name of the transmission line.",
"type": "string"
},
"tLineParentName": {
"description": "The Parent Company name of the transmission line.",
"type": "string"
},
"transmissionSystemId": {
"format": "int32",
"description": "The ID of the transmission system.",
"type": "integer"
},
"transmissionSystemName": {
"description": "Name of the transmission system.",
"type": "string"
},
"tLineStatusDesc": {
"description": "Status of the transmission line.",
"type": "string"
},
"tLineType": {
"description": "The Type of transmission line. There are two different types of transmission lines: AC and DC.",
"type": "string"
},
"tLineLengthMiles": {
"format": "int64",
"description": "Transmission Line Length (Miles).",
"type": "integer"
},
"tLineLengthKilometers": {
"format": "int64",
"description": "Transmission Line Length (Kilometers).",
"type": "integer"
},
"systemLengthMiles": {
"format": "int64",
"description": "Transmission System Length (Miles).",
"type": "integer"
},
"systemLengthKilometers": {
"format": "int64",
"description": "Transmission Line System Length (Kilometers).",
"type": "integer"
},
"kVRating": {
"format": "int64",
"description": "The kV (Kilovolts) Rating of the Transmission Line.",
"type": "integer"
},
"overhead": {
"description": "Transmission Line Layout Overhead.",
"type": "string"
},
"belowGround": {
"description": "Transmission Line Layout Below Ground.",
"type": "string"
},
"subsea": {
"description": "Transmission Line Layout Subsea.",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"controlAreaName": {
"description": "Balancing Authority/Control Area name (e.g. \"Western Area Power Administration - Desert Southwest Region\").",
"type": "string"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of transmission line records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the transmission line record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"offshore": {
"description": "Location of Transmission Line Origination/Destination can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"tLineOrigination": {
"$ref": "#/components/schemas/transmissionLineOrigination",
"description": "Transmission Line Origination."
},
"tLineDestination": {
"$ref": "#/components/schemas/transmissionLineDestination",
"description": "Transmission Line Destination."
},
"tLineOwner": {
"description": "Transmission Line Ownership.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ownerCompany"
}
},
"tLineConnections": {
"description": "Transmission Line Connections.",
"type": "array",
"items": {
"$ref": "#/components/schemas/transmissionLineConnections"
}
}
}
},
"transmissionLineConnections": {
"description": "Transmission Line Connections Details.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant.",
"type": "string"
},
"plantStatusDesc": {
"description": "Status of the plant.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
}
}
},
"projectSummaryFields": {
"required": [
"projectId",
"projectName",
"industryCode",
"industryCodeDesc",
"TIV",
"projectStatusDesc",
"pecZone",
"ownerName",
"plantId",
"physicalAddress",
"releaseDate",
"plantName",
"plantPhysicalAddress",
"projectOwnerName",
"tiv"
],
"type": "object",
"properties": {
"projectId": {
"format": "int32",
"description": "The project ID is a unique eight-digit number used by IIR that is assigned to an individual project.",
"type": "integer"
},
"projectName": {
"description": "Name of the project. ",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code. IIR assigns each project to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"tiv": {
"format": "int64",
"description": "Project Total Investment Value (USD).",
"type": "integer"
},
"releaseDate": {
"format": "date-time",
"description": "The Project report release date.",
"type": "string"
},
"projectStatusDesc": {
"description": "Status description of the project.",
"type": "string"
},
"umbrellaId": {
"format": "int32",
"description": "ID of the Umbrella Project.",
"type": "integer"
},
"umbrellaName": {
"description": "Name of the Umbrella Project.",
"type": "string"
},
"umbrellaProjectCount": {
"format": "int32",
"description": "Umbrella Project Count.",
"type": "integer"
},
"projectOwnerName": {
"description": "Owner Name of the project.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "The name of the plant. ",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
}
}
},
"boilerSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"boilers"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of boiler results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned boiler results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of boiler results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of boilers IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"boilers": {
"description": "List of boilers IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/boilerSummaryFields"
}
}
}
},
"controlAreaResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of Balancing Authority/Control Area results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned Balancing Authority/Control Area results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of Balancing Authorities/Control Areas returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of Balancing Authorities/Control Areas IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"controlAreas": {
"description": "List of Balancing Authorities/Control Areas IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/controlAreaFields"
}
}
}
},
"driveSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"drives"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of drive results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned drive results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of drive results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of drives IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"drives": {
"description": "List of drives IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/driveSummaryFields"
}
}
}
},
"equipmentTypesResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of Equipment Type results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned Equipment Type results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of Equipment Type results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of Equipment Types IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"equipmentTypes": {
"description": "List of Equipment Types IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/equipmentTypesFields"
}
}
}
},
"hsProductResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of HS Product results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned HS Product results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of HS Product results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of HS Products IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"hsProducts": {
"description": "List of HS Products IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/hsProductFields"
}
}
}
},
"offlineEventSummaryResponse": {
"description": "",
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"offlineEvents"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of offline event results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned offline event results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of offline event results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of offline events IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"offlineEvents": {
"description": "List of offline events IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/offlineEventSummaryFields"
}
}
}
},
"otherEquipmentSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"otherEquipment"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of other equipment results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned other equipment results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of other equipment results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of other equipment IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"otherEquipment": {
"description": "List of other equipment IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/otherEquipmentSummaryFields"
}
}
}
},
"pecZoneResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of PEC Zone results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned PEC Zone results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of PEC Zone results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of PEC Zones IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"pecZones": {
"description": "List of PEC Zones IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pecZoneFields"
}
}
}
},
"plantSummaryResponse": {
"title": "Root Type for PlantSummaryResponse",
"description": "The root of the PlantSummaryResponse type's schema.",
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"plants"
],
"type": "object",
"properties": {
"limit": {
"format": "int32",
"description": "Limit number of plant results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"format": "int32",
"description": "Offset the list of returned plant results by this amount.",
"type": "integer"
},
"resultCount": {
"format": "int32",
"description": "Number of plant results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"format": "int32",
"description": "Total number of plants IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"plants": {
"description": "List of plants IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantSummaryFields"
}
}
}
},
"projectSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"projects"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of project results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned project results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of project results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of projects IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"projects": {
"description": "List of projects IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectSummaryFields"
}
}
},
"example": {
"limit": 100,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"projects": [
{
"projectId": 1001528,
"projectName": "SIERRA BLANCA GRASSROOT ROUND TOP MOUNTAIN A-G RARE EARTH/BERYLLIUM/URANIUM MINE",
"industryCode": 8,
"industryCodeDesc": "Metals & Minerals",
"pecZone": "TX*11",
"tiv": 300000000,
"releaseDate": "2012-01-10T03:30:46Z[UTC]",
"projectStatusDesc": "Active",
"plantOwnerName": "Texas Rare Earth Resources Corporation",
"plantId": 1002505,
"plantName": "Sierra Blanca Round Top Mountain A-G Rare Earth Mine",
"plantCity": "Sierra Blanca",
"plantState": "TX",
"plantCountryName": "U.S.A."
}
]
}
},
"tag": {
"type": "object",
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "Tag"
}
},
"sicProductResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of SIC Product results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned SIC Product results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of SIC Product results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of SIC Products IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"sicProducts": {
"description": "List of SIC Products IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sicProductFields"
}
}
}
},
"transmissionLineSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"transmissionLines"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of transmission line results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned transmission line results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of transmission line results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of transmission lines IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"transmissionLines": {
"description": "List of transmission lines IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/transmissionLineSummaryFields"
}
}
}
},
"unitSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"units"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of unit results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned unit results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of unit results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of units IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"units": {
"description": "List of units IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitSummaryFields"
}
}
}
},
"unitTypesResponse": {
"type": "object",
"properties": {
"limit": {
"description": "Limit number of Unit Type results to return. By default, it will return 500 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned Unit Type results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of Unit Type results returned. By default, it's limited to 500 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of Unit Types IIR finds based on the search criteria. If the value exceeds 500, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"unitTypes": {
"description": "List of Unit Types IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitTypesFields"
}
}
}
},
"miningEquipmentSummaryFields": {
"required": [
"miningEquipmentId",
"plantOwnerName",
"plantId",
"plantName",
"miningEquipmentType",
"miningEquipmentModel",
"miningEquipmentManufacturerName",
"releaseDate",
"plantPhysicalAddress",
"unitId",
"unitName",
"mEquipmentId",
"mEquipmentManufacturerName",
"mEquipmentModel",
"mEquipmentType"
],
"type": "object",
"properties": {
"mEquipmentId": {
"format": "int32",
"description": "The ID of the mining equipment. The Mining Equipment ID is a unique number assigned to each mining equipment.",
"type": "integer"
},
"plantOwnerName": {
"description": "Owner Name of the plant.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the Plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the Unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit.",
"type": "string"
},
"mEquipmentManufacturerName": {
"description": "The Manufacturer of the mining equipment. Mining Equipment are identified by their manufacturer.",
"type": "string"
},
"mEquipmentModel": {
"description": "Mining Equipment Model. Additional information is available for mining equipment such as the Model. ",
"type": "string"
},
"mEquipmentType": {
"description": "Mining Equipment Type. Each mining equipment is identified with a type.",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
},
"releaseDate": {
"format": "date-time",
"description": "Release date of the mining equipment record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
},
"miningEquipmentSummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"miningequipment"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of mining equipment results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned mining equipment results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of mining equipment results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of mining equipment IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"miningEquipment": {
"description": "List of mining equipment IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/miningEquipmentSummaryFields"
}
}
}
},
"mailingAddress": {
"description": "Mailing Address.",
"required": [
"addressLine1",
"city",
"state",
"country",
"countryName",
"stateName",
"postalCode"
],
"type": "object",
"properties": {
"addressLine1": {
"description": "Mailing Street Address Line 1.",
"type": "string"
},
"addressLine2": {
"description": "Mailing Street Address Line 2. (Optional)",
"type": "string"
},
"city": {
"description": "Mailing City.",
"type": "string"
},
"stateName": {
"description": "Mailing State.",
"type": "string"
},
"postalCode": {
"description": "Mailing Postal Code.",
"type": "string"
},
"countryName": {
"description": "Mailing Country.",
"type": "string"
}
}
},
"phoneNumber": {
"description": "Phone Number.",
"type": "object",
"properties": {
"cc": {
"format": "int64",
"description": "Country Code. ",
"type": "integer"
},
"number": {
"description": "Phone Number.",
"type": "string"
},
"ext": {
"description": "Extension.",
"type": "string"
}
}
},
"pipelineDetailFields": {
"required": [
"liveDate",
"offshore",
"pipelineDestination",
"pipelineId",
"pipelineName",
"pipelineOperatorName",
"pipelineOrigination",
"pipelineOwner",
"pipelineParentName",
"pipelineProduct",
"pipelineStatusDesc",
"pipelineType",
"primaryProductDesc",
"primaryProductId",
"releaseDate"
],
"type": "object",
"properties": {
"pipelineId": {
"format": "int32",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile.",
"type": "integer"
},
"pipelineName": {
"description": "The Name of the pipeline. Pipeline names are based on the Owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to. ",
"type": "string"
},
"pipelineOperatorName": {
"description": "Operator name of the pipeline.",
"type": "string"
},
"pipelineParentName": {
"description": "Parent Company name of the pipeline.",
"type": "string"
},
"pipelineSystemId": {
"format": "int32",
"description": "The ID of the pipeline system.",
"type": "integer"
},
"pipelineSystemName": {
"description": "Name of the pipeline system.",
"type": "string"
},
"pipelineStatusDesc": {
"description": "Status of the pipeline.",
"type": "string"
},
"pipelineType": {
"description": "The Type of pipeline. Each Pipeline is identified by a specific pipeline type.",
"type": "string"
},
"maintenanceBudget": {
"description": "Maintenance Budget of the pipeline.",
"type": "integer"
},
"maintenanceCurrency": {
"description": "Maintenance Budget Currency.",
"type": "string"
},
"materialUsed": {
"description": "The Material used for the pipeline.",
"type": "string"
},
"interIntraState": {
"description": "Interstate/Intrastate. “Interstate” indicates that the “Pipeline” travels across a state/province border or a country border, while an “Intrastate” “Asset” remains within the same state/province as the “Pipeline Origination”.\n",
"type": "string"
},
"completionDate": {
"format": "date-time",
"description": "The Completion Date of the pipeline. The date of completion of mechanical construction and integrity testing.",
"type": "string"
},
"startupDate": {
"format": "date-time",
"description": "The Start-Up Date of the pipeline. Commencement of Commercial Operations which can differ significantly from the Completion Date.",
"type": "string"
},
"shutdownDate": {
"format": "date-time",
"description": "The Shutdown Date of the pipeline. The date of the termination of commercial operations.",
"type": "string"
},
"pipelineLengthMiles": {
"format": "int64",
"description": "Pipeline Length (Miles).",
"type": "integer"
},
"pipelineLengthKilometers": {
"format": "int64",
"description": "Pipeline Length (Kilometers).",
"type": "integer"
},
"systemLengthMiles": {
"format": "int64",
"description": "Pipeline System Length (Miles).",
"type": "integer"
},
"systemLengthKilometers": {
"format": "int64",
"description": "Pipeline System Length (Kilometers).",
"type": "integer"
},
"primaryProductId": {
"description": "The Primary Product ID Carried by the pipeline.",
"type": "string"
},
"primaryProductDesc": {
"description": "The Primary Product description Carried by the pipeline.",
"type": "string"
},
"insulated": {
"description": "Pipeline Insulated (Yes/No).",
"type": "string"
},
"aboveGround": {
"description": "Pipeline Layout Above Ground.",
"type": "string"
},
"belowGround": {
"description": "Pipeline Layout Below Ground.",
"type": "string"
},
"subsea": {
"description": "Pipeline Layout Subsea.",
"type": "string"
},
"designPressurePsi": {
"format": "int32",
"description": "Pipeline Design Pressure (PSI).",
"type": "integer"
},
"designPressureBar": {
"format": "int64",
"description": "Pipeline Design Pressure (BAR)",
"type": "integer"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of pipeline records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the pipeline record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"offshore": {
"description": "Location of Pipeline Origination/Destination can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"pipelineOrigination": {
"$ref": "#/components/schemas/pipelineOrigination",
"description": "Pipeline Origination."
},
"pipelineDestination": {
"$ref": "#/components/schemas/pipelineDestination",
"description": "Pipeline Destination."
},
"pipelineOwner": {
"description": "Pipeline Ownership.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ownerCompany"
}
},
"pipelineProduct": {
"description": "Products Carried.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineProduct"
}
},
"pipelineConnections": {
"description": "Pipeline Connections.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineConnections"
}
}
}
},
"plantLtsa": {
"description": "LTSA - Long Term Service Agreement",
"required": [
"ltsaId",
"statusId",
"contractLength",
"contractExpiration",
"qcDate"
],
"type": "object",
"properties": {
"ltsaId": {
"format": "int32",
"description": "LTSA ID of the plant.",
"type": "integer"
},
"statusId": {
"format": "int32",
"description": "Status ID of the LTSA.",
"type": "integer"
},
"statusDesc": {
"description": "Status description of the LTSA.",
"type": "string"
},
"contractorName": {
"description": "Company name of the plant’s LTSA.",
"type": "string"
},
"contractLength": {
"format": "int32",
"description": "Contract length of the LTSA.",
"type": "integer"
},
"contractExpiration": {
"format": "date-time",
"description": "Contract expiration date of the plant’s LTSA. This is the date the LTSA ends.",
"type": "string"
},
"personnelCountAvg": {
"format": "int32",
"description": "Average number of personnel for the plant’s LTSA.",
"type": "integer"
},
"personnelCountPeak": {
"format": "int32",
"description": "Peak number of personnel for the plant’s LTSA.",
"type": "integer"
},
"preferredContractor": {
"description": "LTSA Preferred Contractor.",
"enum": [
"0",
"1"
],
"type": "string"
},
"qcDate": {
"format": "date-time",
"description": "The QC date of the plant's LTSA.",
"type": "string"
}
}
},
"unitLtsa": {
"description": "LTSA - Long Term Service Agreement.",
"type": "object",
"properties": {
"ltsaId": {
"format": "int32",
"description": "LTSA ID of the unit.",
"type": "integer"
},
"statusId": {
"format": "int32",
"description": "Status ID of the LTSA.",
"type": "integer"
},
"statusDesc": {
"description": "Status description of the LTSA.",
"type": "string"
},
"type": {
"description": "Type of the LTSA.",
"type": "string"
},
"contractorName": {
"description": "Company name of the unit’s LTSA.",
"type": "string"
},
"contractLength": {
"format": "int32",
"description": "Contract length of the LTSA.",
"type": "integer"
},
"contractExpiration": {
"format": "int32",
"description": "Contract expiration date of the unit’s LTSA. This is the date the LTSA ends.",
"type": "integer"
},
"preferredContractor": {
"description": "LTSA Preferred Contractor.",
"enum": [
"0",
"1"
],
"type": "string"
},
"comments": {
"description": "LTSA Comments.",
"type": "string"
}
}
},
"altPhoneNumber": {
"description": "Alternate Phone.",
"type": "object",
"properties": {
"cc": {
"format": "int32",
"description": "Alternate Country Code. ",
"type": "integer"
},
"number": {
"description": "Alternate Phone Number.",
"type": "string"
},
"ext": {
"description": "Alternate Phone Extension.",
"type": "string"
}
}
},
"companySummaryResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"companies"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of company results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned company results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of company results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of companies IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"companies": {
"description": "List of companies IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/companySummaryFields"
}
}
}
},
"ownerCompany": {
"description": "",
"required": [
"companyId",
"companyName",
"addressLine1",
"city",
"physicalAddress",
"ownerPercent",
"classificationDesc",
"address"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "Owner ID. ",
"type": "integer"
},
"companyName": {
"description": "Owner name.",
"type": "string"
},
"classificationDesc": {
"description": "Classification of the owner company. ",
"type": "string"
},
"ownerPercent": {
"format": "double",
"description": "Ownership Percentage.",
"type": "number"
},
"companyWebsite": {
"description": "Website of the owner company.",
"type": "string"
},
"address": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address of the owner company."
}
}
},
"pipelineInstallationDetails": {
"description": "Pipeline Installation Details.",
"type": "object",
"properties": {
"pipelineInstallationTypeId": {
"format": "int32",
"description": "Pipeline Installation Type ID.",
"type": "integer"
},
"pipelineInstallationTypeDesc": {
"description": "Pipeline Installation Type description.",
"type": "string"
},
"pipelineLengthMiles": {
"format": "double",
"description": "Pipeline Length (Miles).",
"type": "number"
},
"pipelineLengthKilometers": {
"format": "double",
"description": "Pipeline Length (Kilometers).",
"type": "number"
},
"pipelineDiameterInches": {
"format": "double",
"description": "Pipeline Diameter (Inches).",
"type": "number"
},
"pipelineDiameterCentimeters": {
"format": "double",
"description": "Pipeline Diameter (Centimeters).",
"type": "number"
}
}
},
"companyPhysicalAddressSummary": {
"description": "Physical Address.",
"type": "object",
"properties": {
"addressLine1": {
"description": "Street Address Line 1.",
"type": "string"
},
"addressLine2": {
"description": "Street Address Line 2. (Optional)",
"type": "string"
},
"city": {
"description": "City.",
"type": "string"
},
"stateName": {
"description": "State.",
"type": "string"
},
"postalCode": {
"description": "Postal Code.",
"type": "string"
},
"countryName": {
"description": "Country.",
"type": "string"
},
"countyName": {
"description": "County.",
"type": "string"
}
}
},
"companySummaryFields": {
"description": "",
"required": [
"companyId",
"companyName",
"companyStatusDesc",
"classificationDesc",
"physicalAddress"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "The company ID is a unique seven-digit number used by IIR that is assigned to an individual company.",
"type": "integer"
},
"companyName": {
"description": "Name of the company.",
"type": "string"
},
"companyStatusDesc": {
"description": "Status of the company.",
"type": "string"
},
"classificationDesc": {
"description": "Classification of the company.",
"type": "string"
},
"physicalAddress": {
"$ref": "#/components/schemas/companyPhysicalAddressSummary",
"description": "Physical Address of the company."
},
"companiesOwnedCount": {
"format": "int64",
"description": "Number of companies owned by the company.",
"type": "integer"
},
"plantsParentCount": {
"format": "int64",
"description": "Number of plants where the company is the parent company.",
"type": "integer"
},
"plantsOwnedCount": {
"format": "int64",
"description": "Number of plants owned by the company.",
"type": "integer"
},
"plantsOperatedCount": {
"format": "int64",
"description": "Number of plants operated by the company.",
"type": "integer"
},
"projectsAssociatedCount": {
"format": "int64",
"description": "Number of projects associated to the company.",
"type": "integer"
},
"unitsOwnedCount": {
"format": "int64",
"description": "Number of units owned by the company.",
"type": "integer"
},
"tLinesOwnedCount": {
"format": "int64",
"description": "Number of transmission lines owned by the company.",
"type": "integer"
},
"pipelinesOwnedCount": {
"format": "int64",
"description": "Number of pipelines owned by the company.",
"type": "integer"
}
}
},
"companiesOwned": {
"description": "Companies owned by the company.",
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "The ID of the company. The Company ID is a unique number assigned to each company.",
"type": "integer"
}
}
},
"plantsParent": {
"description": "Plants where the company is the parent company.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
}
}
},
"plantsOwned": {
"description": "Plants owned by the company.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
}
}
},
"plantsOperated": {
"description": "Plants operated by the company.",
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
}
}
},
"projectsAssociated": {
"description": "Projects associated to the company.",
"type": "object",
"properties": {
"projectId": {
"format": "int32",
"description": "The ID of the project which is a unique eight-digit number used by IIR that is assigned to an individual project.",
"type": "integer"
}
}
},
"unitsOwned": {
"description": "Units owned by the company.",
"type": "object",
"properties": {
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
}
}
},
"tLinesOwned": {
"description": "Transmission lines owned by the company.",
"type": "object",
"properties": {
"tLineId": {
"format": "int32",
"description": "The ID of the transmission line. The Transmission Line ID is a seven-digit unique number used by IIR that is assigned to each transmission line profile.",
"type": "integer"
}
}
},
"pipelinesOwned": {
"description": "Pipelines owned by the company.",
"type": "object",
"properties": {
"pipelineId": {
"format": "int32",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile.",
"type": "integer"
}
}
},
"projectCompanies": {
"required": [
"companyId",
"companyFunctionId",
"projectContact",
"physicalAddress",
"firmTypeId"
],
"type": "object",
"properties": {
"companyId": {
"format": "int64",
"description": "The Company ID is a unique eight-digit number used by IIR that is assigned to an individual company.",
"type": "integer"
},
"companyName": {
"description": "Name of the company.",
"type": "string"
},
"firmTypeDesc": {
"description": "Project Responsability.",
"type": "string"
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"projectContact": {
"$ref": "#/components/schemas/projectContact",
"description": "Project Contact information."
}
}
},
"companyContacts": {
"description": "Company Contacts.",
"required": [
"contactId",
"firstName",
"lastName",
"phone",
"functionalTitle"
],
"type": "object",
"properties": {
"contactId": {
"format": "int32",
"description": "Contact ID.",
"type": "integer"
},
"firstName": {
"description": "First name of the contact.",
"type": "string"
},
"lastName": {
"description": "Last name of the contact.",
"type": "string"
},
"title": {
"description": "Title of the contact.",
"type": "string"
},
"onSite": {
"description": "Defines if contact is On-site.\n",
"enum": [
"No",
"Yes"
],
"type": "string"
},
"emailAddress": {
"description": "Email of the contact.",
"type": "string"
},
"linkedInId": {
"description": "LinkedIn ID of the contact.",
"type": "string"
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Phone number of the contact."
},
"phoneMobile": {
"description": "Contact Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"altPhone": {
"$ref": "#/components/schemas/altPhoneNumber",
"description": "Alternate phone number of the contact."
},
"altPhoneMobile": {
"description": "Contact Alternate Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
}
}
},
"projectContact": {
"description": "Project Contact information.",
"required": [
"firstName",
"lastName",
"titleDesc",
"phone"
],
"type": "object",
"properties": {
"contactId": {
"description": "Contact ID of the project company.",
"type": "integer"
},
"firstName": {
"description": "Contact's First name.",
"type": "string"
},
"lastName": {
"description": "Contact's Last name.",
"type": "string"
},
"titleDesc": {
"description": "Contact’s title description.",
"type": "string"
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Project Contact’s telephone number."
},
"phoneMobile": {
"description": "Contact Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"emailAddress": {
"description": "Contact’s email address.",
"type": "string"
},
"linkedInId": {
"description": "Contact’s LinkedIn ID.",
"type": "string"
},
"altPhoneCC": {
"format": "int64",
"description": "Contact’s alternate phone country code number.",
"type": "integer"
},
"altPhoneNo": {
"description": "Contact’s alternate phone number.",
"type": "string"
},
"altPhoneExt": {
"description": "Contact’s alternate phone extension number.",
"type": "string"
},
"altPhoneMobile": {
"description": "Contact Alternate Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"alt2PhoneCC": {
"format": "int64",
"description": "Contact’s alternate country code number.",
"type": "integer"
},
"alt2PhoneNo": {
"description": "Contact’s alternate phone number. ",
"type": "string"
},
"alt2PhoneExt": {
"description": "Contact’s alternate phone extension number.",
"type": "string"
},
"alt2PhoneMobile": {
"description": "Contact Alternate Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
}
}
},
"companyDetailResponse": {
"description": "",
"required": [
"limit",
"companies",
"offset",
"resultCount",
"totalCount"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of company results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned company results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of company results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of company IIR finds based on the search criteria. If the value exceeds 5 use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"companies": {
"description": "List of companies IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/companyDetailFields"
}
}
}
},
"projectDetailResponse": {
"title": "Root Type for ProjectData",
"description": "The root of the ProjectData type's schema.",
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"projects"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of project results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned project results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of project results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of projects IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"projects": {
"description": "List of projects IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectDetailFields"
}
}
},
"example": {
"limit": 5,
"offset": 0,
"resultCount": 1,
"totalCount": 1,
"projects": [
{
"projectId": 300007092,
"projectName": "ATTAPU GRASSROOT 66MW NAM KONG II HYDRO POWER STATION",
"industryCode": "01",
"industryCodeDesc": "Power",
"pecZone": "LO*01",
"tiv": 135000000,
"currency": "USD",
"offshore": 0,
"releaseDate": "2018-01-25T20:21:00Z[UTC]",
"projectStatusDesc": "Active",
"projectSicId": "4931",
"projectSicDesc": "Electricity/Steam [IPP]",
"projectTypeId": 1,
"projectTypeDesc": "Grassroot",
"sicProductId": "4931*0003",
"sicProductDesc": "Nonutility Owned Power Generation",
"lastDate": "2018-01-25T20:20:57Z[UTC]",
"liveDate": "2010-02-09T16:18:05Z[UTC]",
"constructionLaborPreference": 0,
"plantOwnerId": 1113989,
"plantOwnerName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"plantId": 1091071,
"plantName": "Nam Kong II Hydro Power Station",
"plantStatus": "UC",
"plantSicId": "4931",
"plantSicDesc": "Electricity/Steam [IPP]",
"plantParentId": 1113989,
"plantParentName": "Hoang Anh Gia Lai Group",
"unitName": "Nam Cong II 01 Nam Cong II 02 Nam Cong II 03",
"plantPhysicalAddress": {
"addressLine1": "Phu Vong Distrcit",
"addressLine2": "Attapeu province",
"stateName": "Attapu",
"postalCode": "00000",
"countryName": "Laos"
},
"plantPhone": "+84 592222257",
"tradingRegionId": 22,
"tradingRegionName": "Southeast Asia",
"marketRegionId": "SA",
"marketRegionName": "Southeast Asia",
"worldRegionId": 6,
"worldRegionName": "Asia",
"pecTiming": "C1",
"pecActivityCode": "36",
"pecActivityDesc": "Construction - Merit Shop",
"projectProbability": "High (81-99%)",
"scope": "Hoang Anh Gia Lai Hydropower Join Stock Company (Owner) and Nam Bo Dong Service Construction (Contractor) continues with Construction of a Grassroot 66MW Hydro Power Station. DETAILS: Construct 66MW Hydroelectric Power Plant utlizing (3) 22MW Francis Hydro Turbine/Generator Sets and associated equipment to generate renewable energy. REQUIRES: Powerhouse, Transmission Line, Dam, Headrace Tunnel, Tailrace Tunnel, Gates, Penstocks, Switchgear, Hydro Turbine/Generators, Transformers, Breakers, Lube Oil System, Rotors, Nozzles, Fans, I&C System, Draft Tubes, Operator Consoles. ENVIRONMENTAL: (L) Dredging, Excavation, Flood Control, Spill Containment; (W) Fish and Wildlife Protection.\r\r",
"schedule": "Hoang Anh Gia Lai Hydropower Join Stock Company and Nam Bo Dong Service Construction continues with construction through 1Q14 (Jan). Hoang Anh Gia Lai Hydropower Join Stock Company and Nam Bo Dong Service Construction releases remaining Equipment RFQs and Construction Subcontractor Bid Documents 3Q11 (Aug) - 3Q13. Construction Kick-Off is scheduled for 1Q11 (Mar). Project Completion is Expected 1Q14 (Jan).",
"afeYearMonth": 201001,
"bidDocYearMonth": 201001,
"completionDate": "2014-01-15T06:00:00Z[UTC]",
"completionDatePrecision": "MONTH",
"longLeadYearMonth": 201001,
"rfqYearMonth": 201001,
"kickoffYearMonth": 201001,
"kickoffSlippage": -9,
"constructionDuration": 49,
"environmental": {
"air": 0,
"land": 1,
"water": 1
},
"engineeringKeyNeeds": {
"civil": 0,
"electrical": 0,
"environmental": 0,
"hvac": 0,
"instrumentation": 0,
"mechanical": 0,
"process": 0,
"structural": 0
},
"constructionKeyNeeds": {
"civil": 1,
"electrical": 1,
"environmental": 1,
"hvac": 1,
"instrumentation": 1,
"mechanical": 1,
"structural": 1,
"general": 1
},
"projectKeyNeeds": {
"architectural": 0,
"batchProcess": 0,
"civilSite": 0,
"communications": 1,
"continuousProcess": 0,
"controlRoom": 0,
"electrical": 0,
"environmental": 0,
"feedstock": 0,
"heatTransfer": 0,
"hvac": 0,
"instrumentation": 0,
"insulationCoatings": 0,
"mechanical": 0,
"miningEquip": 0,
"materialHandling": 0,
"nde": 0,
"packaging": 0,
"pipingFittings": 0,
"processEquip": 0,
"pumps": 1,
"structural": 0,
"storage": 0,
"transportation": 1,
"utilities": 1,
"valves": 1
},
"matterPhase": {
"gas": 0,
"liquid": 1,
"plasma": 0,
"solid": 0,
"vapor": 0
},
"energyProcessKeyNeeds": {
"iep": 0,
"boiler": 0,
"turbine": 1,
"generator": 1,
"cogen": 0,
"incinerator": 0,
"engine": 0
},
"buy": {
"electricity": 0,
"fuel": 0,
"steam": 0
},
"sell": {
"electricity": 1,
"fuel": 0,
"steam": 0
},
"projectFuelTypeCode": "05",
"projectFuelTypeDesc": "Hydro",
"projectCapacity": [
{
"productId": "000220",
"productDesc": "Sea Bass (Dicentrarchus Labrax, Dicentrarchus Punctatus), Excluding Fillets, Livers And Roes, Frozen",
"installedCapacity": 500000,
"plannedCapacity": 50000,
"uom": "KG"
},
{
"productId": 4278,
"productDesc": "Ramie And Other Vegetable Textile Fibers,Raw Or Processed But Not Spun; Tow, Noils And Waste Of These Fibers (Including Yarn Waste A",
"installedCapacity": 40,
"plannedCapacity": 20,
"uom": "KG"
},
{
"productId": "000521",
"productDesc": "Broad Beans (Vicia Faba Var. Major) And Horse Beans (Vicia Faba Var. Equina And Vicia Faba Var. Minor) Seeds Of A Kind Used For Sowi",
"installedCapacity": 5000,
"uom": "KG"
},
{
"productId": "000522",
"productDesc": "Broad Beans (Vicia Faba Var. Major) And Horse Beans (Vicia Faba Var. Equine And Vicia Faba Var. Minor) Except Seed, Dried, Shelled",
"uom": "KG"
},
{
"productId": 2559,
"productDesc": "Medicaments Containing Penicillins Or Derivatives Thereof, With A Penicillanic Acid Structure, Or Streptomycins Or Derivatives, Neso",
"plannedCapacity": 5222,
"uom": "Doses"
},
{
"productId": "002577",
"productDesc": "Other Medicaments Containing Alkaloids Or Derivatives Thereof But Notcontaining Hormones, Other Products Of Head 2937 Or Antibiotics",
"installedCapacity": 250000,
"uom": "Doses"
},
{
"productId": "002574",
"productDesc": "Other Medicaments Primarily Affecting The Central Nervous System Not Elsewhere Specified Or Included",
"installedCapacity": 1000,
"uom": "Doses"
},
{
"productId": 80,
"productDesc": "Chickens, Young (Broilers, Fryers, Roasters And Capons), Not Cut In Pieces, Frozen",
"plannedCapacity": 50000,
"uom": "KG"
},
{
"productId": 2187,
"productDesc": "Methyl Acrylate",
"installedCapacity": 20000,
"plannedCapacity": 1.1,
"uom": "M Lbs/yr"
},
{
"productId": 109,
"productDesc": "Hams, Shoulders And Cuts Thereof, Of Swine, Bone In, Salted, In Brine, Dried Or Smoked",
"installedCapacity": 30000,
"uom": "LBS/D"
},
{
"productId": 9981,
"productDesc": "Electricity",
"installedCapacity": 250,
"plannedCapacity": 200,
"uom": "MW"
}
],
"projectCompanies": [
{
"companyId": 3042104,
"companyName": "Nam Bo Dong Service Construction Company Limitted",
"firmTypeDesc": "Contractor",
"physicalAddress": {
"addressLine1": "449/62 Truong Chinh,",
"addressLine2": "Ward 14, Tan Binh District,",
"city": "Ho Chi Minh City",
"stateName": "HN",
"postalCode": "00",
"countryName": "VN"
},
"projectContact": {
"contactId": 3247445,
"firstName": "Hoa Binh",
"lastName": "Nguyen",
"titleId": 728,
"titleDesc": "Project Manager",
"phone": {
"cc": 84,
"number": "973325333"
},
"emailAddress": "binhnguyen@nambodong.com.",
"directCC": 84
},
"lastDate": "2018-01-25T20:20:57Z[UTC]"
},
{
"companyId": 3042104,
"companyName": "Nam Bo Dong Service Construction Company Limitted",
"firmTypeDesc": "Contractor",
"physicalAddress": {
"addressLine1": "449/62 Truong Chinh,",
"addressLine2": "Ward 14, Tan Binh District,",
"city": "Ho Chi Minh City",
"stateName": "HN",
"postalCode": "00",
"countryName": "VN"
},
"projectContact": {
"contactId": 3247448,
"firstName": "Duc",
"lastName": "Hoang",
"titleId": 1979,
"titleDesc": "Deputy Director",
"phone": {
"cc": 84,
"number": "838130580"
},
"directCC": 84
},
"lastDate": "2018-01-25T20:20:57Z[UTC]"
},
{
"companyId": 1113989,
"companyName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"companyFunctionDesc": "OWNER",
"firmTypeDesc": "Project Manager",
"physicalAddress": {
"addressLine1": "Highway 14, Chuhdrong",
"city": "Plei Cu",
"stateName": "GI",
"postalCode": "00",
"countryName": "VN"
},
"projectContact": {
"contactId": 2121239,
"firstName": "Van Hung",
"lastName": "Nguyen",
"titleId": 346,
"titleDesc": "General Director",
"phone": {
"cc": 84,
"number": "592222259"
},
"directCC": 84
},
"lastDate": "2018-01-25T20:20:57Z[UTC]"
},
{
"companyId": 1113989,
"companyName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"firmTypeDesc": "Project Executive",
"physicalAddress": {
"addressLine1": "Floor 6, No. 15, Truong Chinh, Phu Dong Ward,",
"addressLine2": "Pleiku City, Gia Lai province",
"city": "Plei Cu",
"stateName": "GI",
"postalCode": "15",
"countryName": "VN"
},
"projectContact": {
"contactId": 3323016,
"firstName": "Thao",
"lastName": "Nguyen",
"titleId": 412,
"titleDesc": "Maintenance Manager",
"phone": {
"cc": 84,
"number": "592222257"
},
"directCC": 84
},
"lastDate": "2018-01-25T20:20:57Z[UTC]"
},
{
"companyId": 1113989,
"companyName": "Hoang Anh Gia Lai Hydropower Join Stock Company",
"firmTypeDesc": "Project Director",
"physicalAddress": {
"addressLine1": "Floor 6, No. 15, Truong Chinh, Phu Dong Ward,",
"addressLine2": "Pleiku City, Gia Lai province",
"city": "Plei Cu",
"stateName": "GI",
"postalCode": "15",
"countryName": "VN"
},
"projectContact": {
"contactId": 3344327,
"firstName": "Hung",
"lastName": "Nguyen",
"titleId": 283,
"titleDesc": "Engineering Manager",
"phone": {
"cc": 84,
"number": "592222257"
},
"directCC": 84
},
"lastDate": "2018-01-25T20:20:57Z[UTC]"
}
]
}
]
}
},
"plantDetailResponse": {
"title": "Root Type for plantDetailResponse",
"description": "The root of the plantDetailResponse type's schema.",
"required": [
"limit",
"offset",
"plants",
"resultCount",
"totalCount"
],
"type": "object",
"properties": {
"limit": {
"format": "int32",
"description": "Limit number of plant results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"format": "int32",
"description": "Offset the list of returned plant results by this amount.",
"type": "integer"
},
"resultCount": {
"format": "int32",
"description": "Number of plant results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"format": "int32",
"description": "Total number of plants IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"plants": {
"description": "List of plants IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantDetailFields"
}
}
}
},
"unitDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"units"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of unit results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned unit results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of unit results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of units IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"units": {
"description": "List of units IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitDetailFields"
}
}
}
},
"offlineEventDetailResponse": {
"description": "",
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"offlineEvents"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of offline event results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned offline event results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of offline event results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of offline events IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"offlineEvents": {
"description": "List of offline events IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/offlineEventDetailFields"
}
}
}
},
"boilerDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"boilers"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of boiler results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned boiler results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of boiler results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of boilers IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"boilers": {
"description": "List of boilers IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/boilerDetailFields"
}
}
}
},
"driveDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"drives"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of drive results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned drive results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of drive results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of drives IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"drives": {
"description": "List of drives IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/driveDetailFields"
}
}
}
},
"miningEquipmentDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"miningequipment"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of mining equipment results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned mining equipment results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of mining equipment results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of mining equipment IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"miningEquipment": {
"description": "List of mining equipment IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/miningEquipmentDetailFields"
}
}
}
},
"otherEquipmentDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"otherEquipment"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of other equipment results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned other equipment results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of other equipment results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of other equipment IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"otherEquipment": {
"description": "List of other equipment IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/otherEquipmentDetailFields"
}
}
}
},
"pipelineDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"pipelines"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of pipeline results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned pipeline results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of pipeline results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of pipelines IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"pipelines": {
"description": "List of pipelines IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineDetailFields"
}
}
}
},
"transmissionLineDetailResponse": {
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"transmissionLines"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of transmission line results to return. By default, it will return 5 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned transmission line results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of transmission line results returned. By default, it's limited to 5 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of transmission lines IIR finds based on the search criteria. If the value exceeds 5, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"transmissionLines": {
"description": "List of transmission lines IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/transmissionLineDetailFields"
}
}
}
},
"contact": {
"description": "Plant Contacts",
"required": [
"contactId",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"contactId": {
"format": "int32",
"description": "Contact ID of the plant.",
"type": "integer"
},
"firstName": {
"description": "First name of the contact.",
"type": "string"
},
"lastName": {
"description": "Last name of the contact.",
"type": "string"
},
"actualTitle": {
"description": "Actual title of the contact.",
"type": "string"
},
"functionalTitle": {
"description": "Functional title of the contact.",
"type": "string"
},
"onSite": {
"description": "Defines if contact is On-site. \n",
"enum": [
"No",
"Yes"
],
"type": "string"
},
"emailAddress": {
"description": "Email of the contact.",
"type": "string"
},
"linkedInId": {
"description": "LinkedIn ID of the contact.",
"type": "string"
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Phone number of the contact."
},
"phoneMobile": {
"description": "Contact Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"altPhone": {
"$ref": "#/components/schemas/altPhoneNumber",
"description": "Alternate phone of the contact."
},
"altPhoneMobile": {
"description": "Contact Alternate Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
}
}
},
"boilerDetailFields": {
"required": [
"boilerId",
"boilerName",
"boilerTypeDesc",
"plantName",
"plantOwnerName",
"unitName",
"unitStatusDesc",
"unitTypeDesc",
"physicalAddress",
"offshoreAddress",
"marketRegionId",
"marketRegionName",
"plantId",
"plantOperatorName",
"plantParentName",
"unitId",
"worldRegionId",
"worldRegionName"
],
"type": "object",
"properties": {
"boilerId": {
"format": "int32",
"description": "The ID of the boiler. The Boiler ID is a unique number assigned to each boiler.",
"type": "integer"
},
"boilerName": {
"description": "Name of the boiler.",
"type": "string"
},
"boilerTypeDesc": {
"description": "The Boiler Type description. Each boiler is identified with a type. Types range from Fluidized Bed Boilers to Package Boilers.",
"type": "string"
},
"boilerManufacturerName": {
"description": "The Manufacturer name of the boiler. Boilers are identified by their manufacturer.",
"type": "string"
},
"designFirm": {
"description": "The Design Firm of the boiler.",
"type": "string"
},
"constructionFirm": {
"description": "The Construction Firm of the boiler.",
"type": "string"
},
"boilerInformation": {
"description": "Boiler Information. Additional information is included for boilers such as Model and Environmental Controls. ",
"type": "string"
},
"boilerSteamCapacity": {
"format": "int64",
"description": "Steam Capacity of the boiler.",
"type": "integer"
},
"steamCapacityUom": {
"description": "Unit of Measure of the boiler steam capacity.",
"type": "string"
},
"boilerPressure": {
"format": "int64",
"description": "Pressure of the boiler.",
"type": "integer"
},
"pressureUom": {
"description": "Unit of Measure of the boiler pressure.",
"type": "string"
},
"boilerTemperature": {
"format": "int64",
"description": "Temperature of the boiler.",
"type": "integer"
},
"temperatureUom": {
"description": "Unit of Measure of the boiler temperature.",
"type": "string"
},
"designBtuConsumption": {
"format": "double",
"description": "BTU Consumption of the boiler.",
"type": "number"
},
"btuConsumptionUom": {
"description": "Unit of Measure of the BTU Consumption.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"unitKickoffDate": {
"format": "date-time",
"description": "Unit Construction Kick-Off Date.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "Unit Shutdown Date.",
"type": "string"
},
"unitCapacity": {
"format": "int64",
"description": "Capacity of the unit.",
"type": "integer"
},
"unitCapacityUom": {
"description": "Unit of Measure of the unit capacity.",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuel",
"description": "The Fuel/Energy Source Types."
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit.",
"type": "string"
},
"unitClassification": {
"description": "The Unit Classification. ",
"type": "string"
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
},
"heatRate": {
"format": "int32",
"description": "Heat Rate of the unit.",
"type": "integer"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"offshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Drive Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"primarySicId": {
"description": "Primary four-digit SIC Code.",
"type": "string"
}
}
},
"driveDetailFields": {
"required": [
"driveId",
"driveName",
"driveType",
"driveStatusDesc",
"driveCategory",
"drivenEquipmentType",
"unitId",
"unitName",
"unitStatusDesc",
"plantName",
"plantId",
"industryCode",
"industryCodeDesc",
"offshore",
"liveDate",
"worldRegionName",
"plantPhysicalAddress",
"plantParentName",
"plantOwnerName",
"plantOwnerId",
"plantOperatorName",
"driveTypeDesc",
"marketRegionId",
"marketRegionName",
"releaseDate",
"unitTypeDesc",
"unitTypeId",
"worldRegionId"
],
"type": "object",
"properties": {
"driveId": {
"format": "int32",
"description": "The ID of the drive. The Drive ID is a unique number assigned to each drive. ",
"type": "integer"
},
"driveName": {
"description": "Name of the drive.",
"type": "string"
},
"driveTypeDesc": {
"description": "Drive Type. Each drive is identified with a type. ",
"type": "string"
},
"driveStatusDesc": {
"description": "Status of the drive.",
"type": "string"
},
"driveManufacturerName": {
"description": "The Manufacturer name of the drive. Combustion and Steam Drives are identified by their manufacturer.",
"type": "string"
},
"driveSeries": {
"description": "The Drive Series. Each drive is associated with a Drive Series. ",
"type": "string"
},
"driveCategory": {
"description": "The Category of the drive.",
"type": "string"
},
"driveInformation": {
"description": "Drive Information. Additional information is included for drives such as Drive Model, Inlet Cooling and Environmental Controls.",
"type": "string"
},
"drivenEquipmentManufacturerName": {
"description": "Driven Equipment Manufacturer. Generators, Pumps and Compressors are identified by their current manufacturer.",
"type": "string"
},
"drivenEquipmentType": {
"description": "Driven Equipment Type. All Pumps and or Compressors are classified as Centrifugal or Positive Displacement.",
"type": "string"
},
"drivenEquipmentInformation": {
"description": "Driven Equipment Information. Additional information is included for Generators, Pumps or Compressors such as Model, MVA, kV, Poles, RPM, Generator Cooling Method.",
"type": "string"
},
"windTurbineCount": {
"format": "int32",
"description": "Wind Turbine Count.",
"type": "integer"
},
"driveCapacityMegawatts": {
"format": "double",
"description": "Drive Capacity - Megawatts.",
"type": "number"
},
"driveCapacityHorsepower": {
"format": "int64",
"description": "Drive Capacity - Horsepower.",
"type": "integer"
},
"designFirm": {
"description": "The Design Firm of the drive.",
"type": "string"
},
"constructionFirm": {
"description": "The Construction Firm of the drive.",
"type": "string"
},
"driveStartupDate": {
"format": "date-time",
"description": "Drive Start-Up Date.",
"type": "string"
},
"driveShutdownDate": {
"format": "date-time",
"description": "Drive Shutdown Date.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuel",
"description": "The Fuel/Energy Source Types."
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit.",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"powerTradeRegion": {
"description": "The Power Trade Region.",
"type": "string"
},
"heatRate": {
"format": "int32",
"description": "Heat Rate of the unit.",
"type": "integer"
},
"unitKickoffDate": {
"format": "date-time",
"description": "Unit Construction Kick-Off Date.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "Unit Shutdown Date.",
"type": "string"
},
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitClassification": {
"description": "The Unit Classification. ",
"type": "string"
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address"
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Drive Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"primarySicId": {
"description": "Primary four-digit SIC Code.",
"type": "string"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of drive records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the drive record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
},
"miningEquipmentDetailFields": {
"required": [
"miningEquipmentId",
"miningEquipmentName",
"miningEquipmentModel",
"miningEquipmentType",
"miningEquipmentManufacturer",
"miningEquipmentStatusDesc",
"plantId",
"plantName",
"releaseDate",
"unitId",
"unitName",
"unitStatusDesc",
"liveDate",
"marketRegionId",
"marketRegionName",
"mEquipmentId",
"mEquipmentManufacturerName",
"mEquipmentModel",
"mEquipmentName",
"mEquipmentStatusDesc",
"mEquipmentStatusId",
"mEquipmentType",
"offshore",
"plantOperatorName",
"plantOwnerName",
"plantParentName",
"plantPhysicalAddress",
"unitTypeDesc",
"unitTypeId",
"worldRegionId",
"worldRegionName"
],
"type": "object",
"properties": {
"mEquipmentId": {
"format": "int32",
"description": "The ID of the mining equipment. The Mining Equipment ID is a unique number assigned to each mining equipment.",
"type": "integer"
},
"mEquipmentName": {
"description": "Name of the mining equipment.",
"type": "string"
},
"mEquipmentType": {
"description": "Mining Equipment Type. Each mining equipment is identified with a type.",
"type": "string"
},
"mEquipmentManufacturerName": {
"description": "Manufacturer of the mining equipment. Mining Equipment are identified by their manufacturer.",
"type": "string"
},
"mEquipmentOwnerName": {
"description": "Owner of the mining equipment.",
"type": "string"
},
"mEquipmentModel": {
"description": "Mining Equipment Model. Additional information is available for mining equipment such as the Model. ",
"type": "string"
},
"mEquipmentProduct": {
"description": "Mining Equipment Product.",
"type": "string"
},
"mEquipmentCapacity": {
"format": "int64",
"description": "Capacity of the mining equipment.",
"type": "integer"
},
"mEquipmentCapacityUom": {
"description": "Unit of Measure of the mining equipment capacity.",
"type": "string"
},
"mEquipmentStatusId": {
"description": "Status ID of the mining equipment.",
"type": "string"
},
"mEquipmentStatusDesc": {
"description": "Status description of the mining equipment.",
"type": "string"
},
"mEquipmentComments": {
"description": "Mining Equipment Comments. ",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitKickoffDate": {
"format": "date-time",
"description": "Unit Construction Kick-Off Date.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "Unit Shutdown Date.",
"type": "string"
},
"areaName": {
"description": "Area name. ",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Drive Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"primarySicId": {
"description": "Primary SIC ID of the plant.",
"type": "string"
},
"primarySicDesc": {
"description": "Primary SIC description of the plant. ",
"type": "string"
},
"secondarySic": {
"description": "The Secondary Plant SIC Code(s).",
"type": "array",
"items": {
"$ref": "#/components/schemas/secondarySic"
}
},
"sicProduct": {
"description": "The SIC Product(s) of the plant.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sicProduct"
}
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"miningMethod": {
"$ref": "#/components/schemas/miningMethod",
"description": "Mining Method."
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of mining equipment records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the mining equipment record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
},
"otherEquipmentDetailFields": {
"required": [
"equipmentId",
"equipmentName",
"equipmentType",
"equipmentStatus",
"plantPhysicalAddress",
"equipmentStatusDesc",
"equipmentStatusId",
"liveDate",
"marketRegionId",
"marketRegionName",
"offshore",
"plantId",
"plantName",
"plantOperatorName",
"plantOwnerName",
"plantParentName",
"releaseDate",
"unitId",
"unitName",
"unitStatusDesc",
"unitTypeDesc",
"unitTypeId",
"worldRegionId",
"worldRegionName"
],
"type": "object",
"properties": {
"equipmentId": {
"format": "int32",
"description": "The ID of the equipment. The Equipment ID is a unique number assigned to each equipment.",
"type": "integer"
},
"equipmentName": {
"description": "Name of the equipment.",
"type": "string"
},
"equipmentType": {
"description": "The Equipment Type. Each equipment is identified with a type.",
"type": "string"
},
"equipmentManufacturerName": {
"description": "The Manufacturer of the equipment. Equipment are identified by their manufacturer.",
"type": "string"
},
"equipmentVendor": {
"description": "The Vendor/Packager of the equipment.",
"type": "string"
},
"equipmentInformation": {
"description": "The Equipment Information. Additional information is available for equipment such as the Model and Environmental Controls.",
"type": "string"
},
"equipmentStatusId": {
"description": "Status ID of the equipment.",
"type": "string"
},
"equipmentStatusDesc": {
"description": "Status description of the equipment.",
"type": "string"
},
"equipmentProductId": {
"description": "Equipment Product ID.",
"type": "string"
},
"equipmentProductDesc": {
"description": "Equipment Product name.",
"type": "string"
},
"equipmentCapacity": {
"format": "double",
"description": "Capacity of the equipment.",
"type": "number"
},
"equipmentProductUom": {
"description": "Unit of measure of the equipment capacity.",
"type": "string"
},
"equipmentComments": {
"description": "Equipment Comments.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitKickoffDate": {
"format": "date-time",
"description": "Unit Construction Kick-Off Date.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "Unit Shutdown Date.",
"type": "string"
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit.",
"type": "string"
},
"heatRate": {
"format": "int32",
"description": "Heat Rate of the unit.",
"type": "integer"
},
"unitClassification": {
"description": "The Unit Classification. ",
"type": "string"
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
},
"areaName": {
"description": "Area name.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Equipment Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongtitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of equipment records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the equipment record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
},
"unitContacts": {
"description": "Area and Unit Contacts.",
"required": [
"contactId",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"contactId": {
"format": "int32",
"description": "The ID of the contact.",
"type": "integer"
},
"firstName": {
"description": "First name of the contact.",
"type": "string"
},
"lastName": {
"description": "Last name of the contact.",
"type": "string"
},
"titleDesc": {
"description": "Title of the contact.",
"type": "string"
},
"linkedInId": {
"description": "LinkedIn ID of the contact.",
"type": "string"
},
"emailAddress": {
"description": "Email of the contact.",
"type": "string"
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Phone number of the contact."
},
"phoneMobile": {
"description": "Contact Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
}
}
},
"unitDetailFields": {
"required": [
"unitId",
"unitName",
"plantId",
"plantName",
"plantStatus",
"plantPhysicalAddress",
"marketRegionName",
"marketRegionId",
"unitStatus",
"unitTypeId",
"unitTypeDesc",
"unitTypeGroup",
"unitStatusGroup",
"areaId",
"areaName",
"industryCode",
"industryCodeDesc",
"liveDate",
"plantOperatorName",
"plantOwnerName",
"plantParentName",
"releaseDate",
"unitStatusDesc",
"worldRegionId",
"worldRegionName"
],
"type": "object",
"properties": {
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"unitClassification": {
"description": "The Unit Classification. ",
"type": "string"
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
},
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitTypeGroup": {
"description": "Unit Type Group.",
"type": "string"
},
"unitStatusGroup": {
"description": "Unit Status Group.",
"type": "string"
},
"unitDetails": {
"description": "Additional comments detailing potential delays due to unforeseen events.",
"type": "string"
},
"heatRate": {
"format": "int32",
"description": "Heat Rate of the unit.",
"type": "integer"
},
"tankCount": {
"format": "int32",
"description": "Number of Tanks.",
"type": "integer"
},
"heaterCount": {
"format": "int32",
"description": "Number of Heaters/Furnaces.",
"type": "integer"
},
"windTurbineCount": {
"format": "int32",
"description": "Wind Turbine Count.",
"type": "integer"
},
"capacity": {
"format": "int64",
"description": "Capacity of the unit.",
"type": "integer"
},
"capacityUom": {
"description": "Capacity UOM (Unit of Measure) of the unit.",
"type": "string"
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit. ",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuel",
"description": "The primary fuel usage of the unit."
},
"unitKickoffDate": {
"format": "date-time",
"description": "Unit Construction Kick-Off Date.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "Unit Shutdown Date.",
"type": "string"
},
"unitCapacity": {
"description": "Unit Capacity",
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity"
}
},
"futureCapacity": {
"description": "Future Capacity of the unit.",
"type": "array",
"items": {
"$ref": "#/components/schemas/futureCapacity"
}
},
"unitContact": {
"description": "Area and Unit Contacts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitContacts"
}
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of unit records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the unit record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantStatusDesc": {
"description": "Status of the plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"tradingRegionId": {
"format": "int32",
"description": "Trading Region ID (e.g. \"1\").",
"type": "integer"
},
"tradingRegionName": {
"description": "Trading Region name (e.g. \"I\"). US Regions are defined by industry standards and grouped by PADDs.",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"primarySicId": {
"description": "Primary four-digit SIC Code identified for a Unit.",
"type": "string"
},
"primarySicDesc": {
"description": "Primary SIC description identified for a Unit.",
"type": "string"
},
"areaId": {
"format": "int32",
"description": "Area ID of the unit.",
"type": "integer"
},
"areaName": {
"description": "Area name of the unit. ",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code of the unit. IIR assigns each Unit Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description of the unit. IIR assigns each Unit Profile to one of twelve industries.",
"type": "string"
},
"technology": {
"description": "Technology information available for a unit which can include Turbine, Boiler information, and Environmental Control equipment types.",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"nercSubRegionName": {
"description": "NERC Sub Region name. ",
"type": "string"
},
"isoRtoRegion": {
"description": "ISO/RTO Region (Independent System Operator Regional Transmission Organization).",
"type": "string"
},
"controlAreaId": {
"description": "Balancing Authority/Control Area ID (e.g. \"WALC\").",
"type": "string"
},
"controlAreaName": {
"description": "Balancing Authority/Control Area name (e.g. \"Western Area Power Administration - Desert Southwest Region\"). ",
"type": "string"
},
"electricalConnectionName": {
"description": "Electrical Connection.",
"type": "string"
},
"ltsa": {
"description": "Long Term Service Agreement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitLtsa"
}
}
}
},
"companyTypes": {
"description": "Company Type(s).",
"type": "object",
"properties": {
"companyType": {
"description": "Company Type. ",
"type": "string"
}
}
},
"companyIndustryCode": {
"description": "Company Industry Code(s). Companies are assigned an industry based on the plants that the company owns. Note that not all companies have an industry association.",
"type": "object",
"properties": {
"industryCode": {
"description": "Industry Code.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
}
}
},
"companyDetailFields": {
"description": "",
"required": [
"companyId",
"companyName",
"companyStatusId",
"classificationId",
"companyStatusDesc",
"classificationDesc",
"physicalAddress",
"mailingAddress",
"phone",
"liveDate",
"releaseDate"
],
"type": "object",
"properties": {
"companyId": {
"format": "int32",
"description": "The company ID is a unique seven-digit number used by IIR that is assigned to an individual company.",
"type": "integer"
},
"companyName": {
"description": "Name of the company.",
"type": "string"
},
"secondaryName": {
"description": "Secondary name of the company.",
"type": "string"
},
"previousName": {
"description": "Previous name of the company.",
"type": "string"
},
"companyStatusId": {
"description": "Status ID of the company.",
"type": "string"
},
"companyStatusDesc": {
"description": "Status of the company.",
"type": "string"
},
"classificationId": {
"description": "Classification ID of the company.",
"type": "string"
},
"classificationDesc": {
"description": "Classification of the company.",
"type": "string"
},
"industryCode": {
"description": "Industry Code(s) of the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/companyIndustryCode"
}
},
"yearEstablished": {
"format": "int32",
"description": "The year the company was established.",
"type": "integer"
},
"stockExchangeDesc": {
"description": "Stock Exchange.",
"type": "string"
},
"stockSymbol": {
"description": "Stock Symbol.",
"type": "string"
},
"webSite": {
"description": "Company Web Site.",
"type": "string"
},
"companyTypes": {
"description": "Company Type(s).",
"type": "array",
"items": {
"$ref": "#/components/schemas/companyTypes"
}
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"mailingAddress": {
"$ref": "#/components/schemas/mailingAddress",
"description": "Mailing Address."
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address."
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Phone Number."
},
"phoneMobile": {
"description": "Company Phone Number is a Mobile Number (0 = No, 1 = Yes ).",
"type": "string"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of company records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the company record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"owner": {
"description": "Company Ownership",
"type": "array",
"items": {
"$ref": "#/components/schemas/ownerCompany"
}
},
"contact": {
"description": "Company Contacts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/companyContacts"
}
},
"companiesOwnedCount": {
"format": "int64",
"description": "Number of companies owned by the company.",
"type": "integer"
},
"companiesOwned": {
"description": "Companies owned by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/companiesOwned"
}
},
"plantsParentCount": {
"format": "int64",
"description": "Number of plants where the company is the parent company.",
"type": "integer"
},
"plantsParent": {
"description": "Plants where the company is the parent company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantsParent"
}
},
"plantsOwnedCount": {
"format": "int64",
"description": "Number of plants owned by the company.",
"type": "integer"
},
"plantsOwned": {
"description": "Plants owned by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantsOwned"
}
},
"plantsOperatedCount": {
"format": "int64",
"description": "Number of plants operated by the company.",
"type": "integer"
},
"plantsOperated": {
"description": "Plants operated by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantsOperated"
}
},
"projectsAssociatedCount": {
"format": "int64",
"description": "Number of projects associated to the company.",
"type": "integer"
},
"projectsAssociated": {
"description": "Projects associated to the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectsAssociated"
}
},
"unitsOwnedCount": {
"format": "int64",
"description": "Number of units owned by the company.",
"type": "integer"
},
"unitsOwned": {
"description": "Units owned by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/unitsOwned"
}
},
"tLinesOwnedCount": {
"format": "int64",
"description": "Number of transmission lines owned by the company.",
"type": "integer"
},
"tLinesOwned": {
"description": "Transmission Lines owned by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/tLinesOwned"
}
},
"pipelinesOwnedCount": {
"format": "int64",
"description": "Number of pipelines owned by the company.",
"type": "integer"
},
"pipelinesOwned": {
"description": "Pipelines owned by the company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelinesOwned"
}
}
}
},
"projectDurationResponse": {
"title": "Root Type for ProjectData",
"description": "The root of the Labor Project Duration Data type's schema.",
"required": [
"limit",
"offset",
"resultCount",
"totalCount",
"projectDuration"
],
"type": "object",
"properties": {
"limit": {
"description": "Limit number of labor project duration results to return. By default, it will return 100 records.",
"type": "integer"
},
"offset": {
"description": "Offset the list of returned labor project duration results by this amount.",
"type": "integer"
},
"resultCount": {
"description": "Number of labor project duration results returned. By default, it's limited to 100 records.",
"type": "integer"
},
"totalCount": {
"description": "Total number of labor project duration IIR finds based on the search criteria. If the value exceeds 100, use multiple queries and combinations of the \"limit\" and \"offset\" parameters to refine search.",
"type": "integer"
},
"projectDuration": {
"description": "List of labor projects duration IIR finds based on the search criteria.",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectDurationFields"
}
}
},
"example": {
"limit": 2,
"offset": 0,
"resultCount": 2,
"totalCount": 2,
"projectDuration": [
{
"projectId": 1001549,
"yearMonth": "201403",
"boilermakerHours": "1480.00",
"carpenterHours": "3255.00",
"electricianHours": "5040.00",
"instrumentationHours": "560.00",
"insulatorsHours": "495.00",
"ironworkerHours": "1265.00",
"millwrightHours": "950.00",
"operatorHours": "2440.00",
"paintingHours": "245.00",
"pipefitterHours": "4685.00",
"plumberHours": "585.00",
"rentalHours": "242430.00",
"scaffoldingHours": "2905.00",
"tivUsd": "5000000.00",
"welderHours": "3385.00",
"laborerHours": "5260.00",
"teamstersHours": "695.00"
},
{
"projectId": 1001549,
"yearMonth": "201402",
"boilermakerHours": "1480.00",
"carpenterHours": "3255.00",
"electricianHours": "5040.00",
"instrumentationHours": "560.00",
"insulatorsHours": "495.00",
"ironworkerHours": "1265.00",
"millwrightHours": "950.00",
"operatorHours": "2440.00",
"paintingHours": "245.00",
"pipefitterHours": "4685.00",
"plumberHours": "585.00",
"rentalHours": "242430.00",
"scaffoldingHours": "2905.00",
"tivUsd": "5000000.00",
"welderHours": "3385.00",
"laborerHours": "5260.00",
"teamstersHours": "695.00"
}
]
}
},
"projectDurationFields": {
"description": "",
"required": [
"projectId"
],
"type": "object",
"properties": {
"projectId": {
"format": "int32",
"description": "The ID of the project which is a unique eight-digit number used by IIR that is assigned to an individual project.",
"type": "integer"
},
"yearMonth": {
"description": "Project duration year and month. ",
"type": "string"
},
"boilermakerHours": {
"description": "Boilermaker Hours.",
"type": "string"
},
"carpenterHours": {
"description": "Carpenter Hours.",
"type": "string"
},
"electricianHours": {
"description": "Electrician Hours.",
"type": "string"
},
"instrumentationHours": {
"description": "Instrumentation Hours.",
"type": "string"
},
"insulatorsHours": {
"description": "Insulators Hours.",
"type": "string"
},
"ironworkerHours": {
"description": "Ironworker Hours.",
"type": "string"
},
"millwrightHours": {
"description": "Millwright Hours.",
"type": "string"
},
"operatorHours": {
"description": "Operator Hours.",
"type": "string"
},
"paintingHours": {
"description": "Painting Hours.",
"type": "string"
},
"pipefitterHours": {
"description": "Pipefitter Hours.",
"type": "string"
},
"plumberHours": {
"description": "Plumber Hours.",
"type": "string"
},
"rentalHours": {
"description": "Rental Hours.",
"type": "string"
},
"scaffoldingHours": {
"description": "Scaffolding Hours.",
"type": "string"
},
"tivUsd": {
"description": "TIV $USD. ",
"type": "string"
},
"welderHours": {
"description": "Welder Hours.",
"type": "string"
},
"laborerHours": {
"description": "Laborer Hours.",
"type": "string"
},
"teamstersHours": {
"description": "Teamsters Hours.",
"type": "string"
}
}
},
"buy": {
"description": "The need to buy or outsource energy-related products and services as dictated by the project.",
"type": "object",
"properties": {
"electricity": {
"format": "int64",
"description": "Electricity is Required for this Project",
"enum": [
"0",
"1"
],
"type": "integer"
},
"fuel": {
"format": "int64",
"description": "Fuel is Required for this Project",
"enum": [
"0",
"1"
],
"type": "integer"
},
"steam": {
"format": "int64",
"description": "Steam is Required for this Project",
"enum": [
"0",
"1"
],
"type": "integer"
}
}
},
"sell": {
"description": "The need to sell energy-related products and services as dictated by the project.",
"type": "object",
"properties": {
"electricity": {
"format": "int64",
"description": "Electricity is sold as a Byproduct of this Project",
"enum": [
"0",
"1"
],
"type": "integer"
},
"fuel": {
"format": "int64",
"description": "Fuel is sold as a Byproduct of this Project",
"enum": [
"0",
"1"
],
"type": "integer"
},
"steam": {
"format": "int64",
"description": "Steam is sold as a Byproduct of this Project",
"enum": [
"0",
"1"
],
"type": "integer"
}
}
},
"marketTrends": {
"description": "Market Trend. This could be an event that impacts plant operations, financial markets, or project spending. Search for keywords in the market trend.",
"type": "object",
"properties": {
"marketTrend": {
"description": "Market Trend.",
"type": "string"
}
}
},
"projectDetailFields": {
"required": [
"projectId",
"projectName",
"industryCode",
"industryCodeDesc",
"pecZone",
"currency",
"offshore",
"marketRegionId",
"marketRegionName",
"tradingRegionDesc",
"worldRegionId",
"worldRegionDesc",
"releaseDate",
"projectStatus",
"projectStatusDesc",
"projectTypeDesc",
"projectSicCode",
"constructionLaborPreference",
"operationsLaborPreference",
"plantId",
"plantName",
"plantParentId",
"plantParentName",
"plantAddress",
"pecTiming",
"pecActivityCode",
"pecActivityDesc",
"projectProbability",
"scope",
"schedule",
"AFEYearMonth",
"BIDDocYearMonth",
"RFQYearMonth",
"energyIEP",
"contrKeyNeedsHVAC",
"projKeyNeedsCivil",
"plantPhysicalAddress",
"plantOwnerName",
"plantOwnerId",
"projectStatusId",
"tiv",
"liveDate",
"pecActivityId",
"projectOwnerId",
"projectOwnerName",
"worldRegionName"
],
"type": "object",
"properties": {
"projectId": {
"format": "int32",
"description": "The ID of the project which is a unique eight-digit number used by IIR that is assigned to an individual project.",
"type": "integer"
},
"projectName": {
"description": "Name of the project.",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code. IIR assigns each project to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"tiv": {
"format": "int64",
"description": "Project Total Investment Value.",
"type": "integer"
},
"currency": {
"description": "Currency of the Total Investment Value.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the project report. Projects updates are performed daily by IIR's research staff when changes to a project are discovered. ",
"type": "string"
},
"projectStatusId": {
"description": "Status of the project.",
"type": "string"
},
"projectStatusDesc": {
"description": "Status description of the project.",
"type": "string"
},
"projectOwnerId": {
"format": "int64",
"description": "Owner ID of the project.",
"type": "integer"
},
"projectOwnerName": {
"description": "Owner Name of the project.",
"type": "string"
},
"umbrellaId": {
"format": "int32",
"description": "ID of the Umbrella project.",
"type": "integer"
},
"umbrellaName": {
"description": "Name of the Umbrella project.",
"type": "string"
},
"umbrellaProjectSummary": {
"description": "Summary of the Umbrella project.",
"type": "string"
},
"umbrellaProjectCount": {
"format": "int32",
"description": "Umbrella Project Count.",
"type": "integer"
},
"projectSicId": {
"description": "Four-digit SIC Code identified for a project.",
"type": "string"
},
"projectSicDesc": {
"description": "SIC Code description identified for a project.",
"type": "string"
},
"projectTypeDesc": {
"description": "Project Type description of the project.",
"type": "string"
},
"sicProductId": {
"description": "SIC Product ID. ",
"type": "string"
},
"sicProductDesc": {
"description": "SIC Product description.",
"type": "string"
},
"liveDate": {
"format": "date-time",
"description": "Initial Release date of project records that have never been reported or updated.",
"type": "string"
},
"constructionLaborPreference": {
"description": "Construction Labor Preference",
"enum": [
"0",
"1"
],
"type": "string"
},
"operationsLaborPreference": {
"description": "Operations Labor Preference.",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantId": {
"format": "int32",
"description": "ID of the plant.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantSicId": {
"description": "Four-digit SIC Code identified for a plant.",
"type": "string"
},
"plantSicDesc": {
"description": "SIC Code description identified for a plant.",
"type": "string"
},
"plantOwnerId": {
"format": "int32",
"description": "Owner ID of the plant.",
"type": "integer"
},
"plantOwnerName": {
"description": "Owner Name of the plant.",
"type": "string"
},
"plantParentId": {
"format": "int32",
"description": "ID of the Parent Company.",
"type": "integer"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address of the plant."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address of the plant."
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"existingSqFt": {
"format": "int32",
"description": "Existing Sq. Ft.",
"type": "integer"
},
"newSqFt": {
"format": "int64",
"description": "New Sq. Ft.",
"type": "integer"
},
"retrofittedSqFt": {
"format": "int64",
"description": "Retrofitted/Renovated Sq. Ft.",
"type": "integer"
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"unitName": {
"description": "Deprecated. Will not exist in v2.2.",
"type": "string"
},
"tradingRegionId": {
"format": "int32",
"description": "Trading Region ID (e.g. \"1\").",
"type": "integer"
},
"tradingRegionName": {
"description": "Trading Region name (e.g. \"I\"). US Regions are defined by industry standards and grouped by PADDs.",
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"isoRtoRegion": {
"description": "ISO/RTO Region (Independent System Operator Regional Transmission Organization).",
"type": "string"
},
"controlAreaId": {
"description": "Balancing Authority/Control Area ID (e.g. \"WALC\").",
"type": "string"
},
"controlAreaName": {
"description": "Balancing Authority/Control Area name (e.g. \"Western Area Power Administration - Desert Southwest Region\"). ",
"type": "string"
},
"electricalConnectionName": {
"description": "Electrical Connection.",
"type": "string"
},
"pecTiming": {
"description": "Each PEC Report is identified by one of six timing phases. \n\nProject’s timing phases: Capital - P1, P2, E1, E2, C1 ; Maintenance - C2.",
"type": "string"
},
"pecActivityId": {
"description": "One out of forty-five PEC activity phases ID of the project.",
"type": "string"
},
"pecActivityDesc": {
"description": "One out of forty-five activity phases description of the project.",
"type": "string"
},
"projectProbability": {
"description": "The Project Probability is our research team's assessment of a project's likelihood of moving forward.",
"type": "string"
},
"scope": {
"description": "Scope of the project.",
"type": "string"
},
"schedule": {
"description": "The project schedule details an estimated timetable for Planning, Design, Engineering, and Construction of the project and includes at least five key project dates, two of which are Kick-Off and Completion.",
"type": "string"
},
"projectDetails": {
"description": "Additional details of the project.",
"type": "string"
},
"afeYearMonth": {
"format": "int32",
"description": "Authorization for Expenditure by YYYY/MM.",
"type": "integer"
},
"bidDocYearMonth": {
"format": "int32",
"description": "Bid Documents by YYYY/MM.",
"type": "integer"
},
"completionDate": {
"format": "date-time",
"description": "Completion Date by MM/DD/YYYY",
"type": "string"
},
"completionDatePrecision": {
"description": "Completion Date Precison.",
"type": "string"
},
"longLeadYearMonth": {
"format": "int32",
"description": "Long-Lead Date by YYYY/MM.",
"type": "integer"
},
"rfqYearMonth": {
"format": "int32",
"description": "Request for Quotation by YYYY/MM.",
"type": "integer"
},
"kickoffYearMonth": {
"format": "int32",
"description": "Kickoff Date by YYYY/MM.",
"type": "integer"
},
"kickoffSlippage": {
"format": "int64",
"description": "Kickoff Slippage.",
"type": "integer"
},
"duration": {
"format": "int64",
"description": "Duration of the project.",
"type": "integer"
},
"marketTrends": {
"description": "Market Trend. This could be an event that impacts plant operations, financial markets, or project spending.",
"type": "array",
"items": {
"$ref": "#/components/schemas/marketTrends"
}
},
"flagBoiler": {
"format": "int64",
"description": "Boiler Industry Flag",
"enum": [
"0",
"1"
],
"type": "integer"
},
"flagIncinerator": {
"format": "int64",
"description": "Incinerator Industry Flag.",
"enum": [
"0",
"1"
],
"type": "integer"
},
"flagBess": {
"format": "int64",
"description": "Battery Energy Storage System Industry Flag.",
"enum": [
"0",
"1"
],
"type": "integer"
},
"engineeringKeyNeeds": {
"$ref": "#/components/schemas/engineeringKeyNeeds",
"description": "Engineering services required for a project."
},
"constructionKeyNeeds": {
"$ref": "#/components/schemas/constructionKeyNeeds",
"description": "Contracting services required for a project."
},
"projectKeyNeeds": {
"$ref": "#/components/schemas/projectKeyNeeds",
"description": "Equipment requirements for a project."
},
"environmental": {
"$ref": "#/components/schemas/environmentalRequirements"
},
"energyProcessKeyNeeds": {
"$ref": "#/components/schemas/energyProcessKeyNeeds"
},
"matterPhase": {
"$ref": "#/components/schemas/matterPhase",
"description": "Matter phases of the project."
},
"buy": {
"$ref": "#/components/schemas/buy",
"description": "The need to buy or outsource energy-related products and services as dictated by the project."
},
"sell": {
"$ref": "#/components/schemas/sell",
"description": "The need to sell energy-related products and services as dictated by the project."
},
"projectFuelTypeCode": {
"description": "Fuel Type ID used to identify the primary Fuel or Energy source that will be utilized as part of the project.",
"type": "string"
},
"projectFuelTypeDesc": {
"description": "Fuel Type description used to identify the primary Fuel or Energy source that will be utilized as part of the project.",
"type": "string"
},
"projectCapacity": {
"description": "Project Capacity",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectCapacity"
}
},
"projectCompanies": {
"description": "Project Companies.",
"type": "array",
"items": {
"$ref": "#/components/schemas/projectCompanies"
}
},
"biddingCompanies": {
"description": "Project Bidding Companies.",
"type": "array",
"items": {
"$ref": "#/components/schemas/biddingCompanies"
}
},
"pipelineInstallations": {
"description": "Pipeline Installation Details.",
"type": "array",
"items": {
"$ref": "#/components/schemas/pipelineInstallationDetails"
}
}
}
},
"offlineEventDetailFields": {
"required": [
"eventId",
"eventKind",
"eventType",
"eventCause",
"eventDuration",
"eventStartDate",
"eventEndDate",
"releaseDate",
"eventStatus",
"eventStatusDesc",
"liveDate",
"offlineEventKey"
],
"type": "object",
"properties": {
"offlineEventKey": {
"description": "Offline Event Key. This is a concatenated primary key which contains the eventId along with the plantId, unitId or asset Id (pipelineId or tLineId) linked by an asterisk (*).",
"type": "string"
},
"eventId": {
"format": "int32",
"description": "Event ID.",
"type": "integer"
},
"eventKind": {
"description": "Event Kind. There are three different kinds of events: Power Outages, Refinery Turnarounds, and Oil & Gas Shutdowns.",
"type": "string"
},
"eventType": {
"description": "Event Type. Each event is identified by a specific event type. Planned events are scheduled events, while unplanned is a forced event resulting from abnormal operating conditions. ",
"type": "string"
},
"eventCause": {
"description": "Event Cause. Events can be electrical, mechanical, weather related, or due to economic conditions. ",
"type": "string"
},
"eventStatusDesc": {
"description": "Status of the event.",
"type": "string"
},
"eventConfirmationStatus": {
"description": "Confirmation Status of the event.",
"type": "string"
},
"offlineCapacity": {
"$ref": "#/components/schemas/offlineCapacity",
"description": "Capacity Off-line."
},
"mmcf": {
"format": "int64",
"description": "MMCF Demand.",
"type": "integer"
},
"estTivUsd": {
"format": "int64",
"description": "Estimated Total Investment Value of the Offline Event in U.S.Dollars. The Offline Event spending is estimated by fitting a regression model to the TIV values of historical maintenance projects based on a unit’s world region, industry, unit type, and capacity.",
"type": "integer"
},
"eventStartDate": {
"format": "date-time",
"description": "Current Kick-Off Date of the event.",
"type": "string"
},
"eventEndDate": {
"format": "date-time",
"description": "Current Completion Date of the event.",
"type": "string"
},
"eventDatePrecision": {
"description": "Event date precision.",
"type": "string"
},
"eventDuration": {
"format": "int64",
"description": "Event Duration number of days.",
"type": "integer"
},
"prevStartDate": {
"format": "date-time",
"description": "Previous Kick-Off Date of the event.",
"type": "string"
},
"prevEndDate": {
"format": "date-time",
"description": "Previous Completion Date of the event.",
"type": "string"
},
"kickoffSlippage": {
"format": "int64",
"description": "Kickoff Slippage from original date.",
"type": "integer"
},
"derate": {
"format": "double",
"description": "The Derate/Rate Cut/Reduced Flows percentage of the capacity offline.",
"type": "number"
},
"eventComments": {
"description": "Event Comments. Each offline event report includes a comment specifying reasons for time down.",
"type": "string"
},
"associatedEntityStartDate": {
"format": "date-time",
"description": "Current Kick-Off Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityEndDate": {
"format": "date-time",
"description": "Current Completion Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityPrevStartDate": {
"format": "date-time",
"description": "Previous Kick-Off Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityPrevEndDate": {
"format": "date-time",
"description": "Previous Completion Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityType": {
"description": "Associated Entity Type (PLANT, UNIT or ASSET).",
"type": "string"
},
"associatedPlantId": {
"format": "int32",
"description": "Associated Plant ID.",
"type": "integer"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"plantOperatorName": {
"description": "Operator name of the plant.",
"type": "string"
},
"plantParentName": {
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant.",
"type": "string"
},
"industryCode": {
"description": "Two digit Industry Code. IIR assigns each unit profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).\n",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address of the Offline Event."
},
"plantPhone": {
"description": "Phone number of the plant.",
"type": "string"
},
"plantPhoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"plantLatitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"plantLongitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Address of the Offline Event."
},
"tradingRegionId": {
"format": "int32",
"description": "Trading Region ID (e.g. \"1\").",
"type": "integer"
},
"tradingRegionName": {
"description": "Trading Region name (e.g. \"I\"). US Regions are defined by industry standards and grouped by PADDs.",
"type": "string"
},
"controlAreaId": {
"description": "Control Area abbreviation (e.g. \"WALC\").",
"type": "string"
},
"controlAreaName": {
"description": "Control Area description (e.g. \"Western Area Power Administration - Desert Southwest Region\"). ",
"type": "string"
},
"electricalConnectionName": {
"description": "Electrical Connection.",
"type": "string"
},
"isoRtoRegion": {
"description": "ISO/RTO Region (Independent System Operator Regional Transmission Organization).",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"nercSubRegionId": {
"description": "The ID of the NERC Sub Region. ",
"type": "string"
},
"nercSubRegionName": {
"description": "NERC Sub Region name. ",
"type": "string"
},
"powerTradeRegion": {
"description": "Power Trade Region (e.g. Rocky Mountains\").",
"type": "string"
},
"gasRegionId": {
"description": "Gas Region ID (e.g. \"WE\").",
"type": "string"
},
"gasRegionName": {
"description": "Gas Region name (e.g. \"Western\").",
"type": "string"
},
"areaId": {
"format": "int32",
"description": "Area ID of the unit.",
"type": "integer"
},
"areaName": {
"description": "Area name of the unit.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"unitTypeId": {
"description": "Unit Type ID.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitTypeGroup": {
"description": "Unit Type Group.",
"type": "string"
},
"unitStartupDate": {
"format": "date-time",
"description": "The Unit Startup date. ",
"type": "string"
},
"unitShutdownDate": {
"format": "date-time",
"description": "The Unit Shutdown date.",
"type": "string"
},
"primarySicId": {
"description": "Primary SIC Code.",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuel",
"description": "The Fuel/Energy Source Types."
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit. ",
"type": "string"
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
},
"heatRate": {
"format": "int32",
"description": "The Heat Rate of the unit. ",
"type": "integer"
},
"pipelineId": {
"format": "int32",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile.",
"type": "integer"
},
"pipelineName": {
"description": "The Name of the pipeline. Pipeline names are based on the Owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to. ",
"type": "string"
},
"pipelineStatusDesc": {
"description": "Status of the pipeline.",
"type": "string"
},
"pipelineLengthMiles": {
"format": "int64",
"description": "Pipeline Length (Miles).",
"type": "integer"
},
"pipelineLengthKilometers": {
"format": "int64",
"description": "Pipeline Length (Kilometers).",
"type": "integer"
},
"pipelineSystemId": {
"format": "int32",
"description": "The ID of the pipeline system.",
"type": "integer"
},
"pipelineSystemName": {
"description": "Name of the pipeline system.",
"type": "string"
},
"pipelineSystemLengthMiles": {
"format": "int64",
"description": "Pipeline System Length (Miles).",
"type": "integer"
},
"pipelineSystemLengthKilometers": {
"format": "int64",
"description": "Pipeline System Length (Kilometers).",
"type": "integer"
},
"tLineId": {
"format": "int32",
"description": "The ID of the transmission line. The Transmission Line ID is a seven-digit unique number used by IIR that is assigned to each transmission line profile.",
"type": "integer"
},
"tLineName": {
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name.",
"type": "string"
},
"tLineStatusDesc": {
"description": "Status of the transmission line.",
"type": "string"
},
"tLineSystemId": {
"format": "int32",
"description": "The ID of the transmission system.",
"type": "integer"
},
"tLineSystemName": {
"description": "Name of the transmission system.",
"type": "string"
},
"tLineLengthMiles": {
"format": "int64",
"description": "Transmission Line Length (Miles).",
"type": "integer"
},
"tLineLengthKilometers": {
"format": "int64",
"description": "Transmission Line Length (Kilometers).",
"type": "integer"
},
"tLineSystemLengthMiles": {
"format": "int64",
"description": "Transmission System Length (Miles).",
"type": "integer"
},
"tLineSystemLengthKilometers": {
"format": "int64",
"description": "Transmission Line System Length (Kilometers).",
"type": "integer"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of offline event records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the offline event record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
},
"offlineCapacity": {
"description": "The Capacity Offline.",
"type": "object",
"properties": {
"productId": {
"description": "Product ID.",
"type": "string"
},
"productDesc": {
"description": "Product description.",
"type": "string"
},
"unitCapacity": {
"format": "int64",
"description": "Capacity of the unit.",
"type": "integer"
},
"capacityOffline": {
"format": "int64",
"description": "Capacity Offline.",
"type": "integer"
},
"uom": {
"description": "Unit of Measure.",
"type": "string"
}
}
},
"plantSummaryFields": {
"required": [
"plantId",
"plantName",
"plantStatusDesc",
"industryCode",
"industryCodeDesc",
"physicalAddress",
"releaseDate",
"owner"
],
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantStatusDesc": {
"description": "Status description of the plant.",
"type": "string"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Plant Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"primarySicId": {
"description": "Primary SIC Code of the plant.",
"type": "string"
},
"primarySicDesc": {
"description": "Primary SIC Code description of the plant.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "Release date of the plant record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"owner": {
"description": "Owner company.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ownerCompanySummary"
}
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address"
}
}
},
"unitSummaryFields": {
"required": [
"unitId",
"unitName",
"plantName",
"plantOwnerName",
"unitTypeDesc",
"plantId",
"plantPhysicalAddress",
"unitStatusDesc"
],
"type": "object",
"properties": {
"unitId": {
"format": "int32",
"description": "The ID of the Unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit.",
"type": "string"
},
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner company name.",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"unitStatusDesc": {
"description": "Status of the unit.",
"type": "string"
},
"plantPhysicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"plantOffshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
},
"unitStartupDate": {
"format": "date-time",
"description": "Unit Start-Up Date.",
"type": "string"
},
"powerUsageDesc": {
"description": "The Power Usage identification of the unit.",
"type": "string"
},
"capacity": {
"format": "int64",
"description": "Capacity of the unit.",
"type": "integer"
},
"capacityUom": {
"description": "Capacity UOM (Unit of Measure) of the unit.",
"type": "string"
}
}
},
"energyProcessKeyNeeds": {
"description": "Energy Process Key Needs are requirements for energy-related equipment (steam or electricity) for the project, as well as any incineration equipment. ",
"type": "object",
"properties": {
"iep": {
"description": "IEP energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"boiler": {
"description": "Boiler energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"turbine": {
"description": "Turbine energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"generator": {
"description": "Generator energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"cogen": {
"description": "Cogen energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"incinerator": {
"description": "Incinerator energy process key needs. Reflect incineration equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"engine": {
"description": "Engine energy process key needs. Reflect energy-related equipment required for a project.",
"enum": [
"0",
"1"
],
"type": "string"
},
"energyStorage": {
"description": "Deprecated. Will not exist in v2.1.",
"enum": [
"0",
"1"
],
"type": "string"
},
"powerToX": {
"description": "Deprecated. Will not exist in v2.1.",
"enum": [
"0",
"1"
],
"type": "string"
}
}
},
"plantDetailFields": {
"required": [
"plantId",
"plantName",
"plantStatusDesc",
"startupDate",
"shutdownDate",
"liveDate",
"releaseDate",
"primaryFuel",
"industryCode",
"industryCodeDesc",
"primarySic",
"primarySicDesc",
"marketRegionId",
"marketRegionName",
"confirmationStatus",
"mailingAddress",
"physicalAddress",
"phoneNumber",
"ownerCompany",
"parentCompany",
"operatorCompany",
"worldRegionName",
"offshore",
"operator",
"owner",
"parent",
"worldRegionId"
],
"type": "object",
"properties": {
"plantId": {
"format": "int32",
"description": "The ID of the plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantStatusDesc": {
"description": "Status description of the plant.",
"type": "string"
},
"noEmployees": {
"format": "int32",
"description": "Number of employees at a plant. ",
"type": "integer"
},
"startupDate": {
"format": "date-time",
"description": "Startup date of the plant. This is the date that the plant actually began production.",
"type": "string"
},
"startupDatePrecision": {
"description": "Startup date precision.",
"type": "string"
},
"closeDate": {
"format": "date-time",
"description": "Close date of the plant. This is the date that the plant closed.",
"type": "string"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of plant records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the plant record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
},
"industryCode": {
"description": "Two digit industry code. IIR assigns each Plant Profile to one of twelve industries.",
"type": "string"
},
"industryCodeDesc": {
"description": "Industry Code description.",
"type": "string"
},
"primarySicId": {
"description": "Primary SIC ID.",
"type": "string"
},
"primarySicDesc": {
"description": "Primary SIC description. ",
"type": "string"
},
"secondarySic": {
"description": "The Secondary Plant SIC Code(s).",
"type": "array",
"items": {
"$ref": "#/components/schemas/secondarySic"
}
},
"operationsLaborPreference": {
"description": "Operations Labor Preference.",
"enum": [
"0",
"1"
],
"type": "string"
},
"plantProbability": {
"description": "The Plant Probability is our research team's assessment for a new plant in the planning, engineering, or under construction phase to move forward to completion and start up.",
"type": "string"
},
"pecZone": {
"description": "Particular zone territory. The Zone is assigned by IIR based on geography by using the state prefix followed by an asterisk and the zone number.",
"type": "string"
},
"tradingRegionId": {
"format": "int32",
"description": "Trading Region ID (e.g. \"1\").",
"type": "integer"
},
"tradingRegionName": {
"description": "Trading Region name (e.g. \"I\"). US Regions are defined by industry standards and grouped by PADDs.",
"type": "string"
},
"marketRegionId": {
"description": "Market Region ID (e.g. \"CS\").",
"type": "string"
},
"marketRegionName": {
"description": "Market Region name (e.g. \"Central Asia\").",
"type": "string"
},
"recordStatus": {
"description": "Record Status of the plant record.",
"type": "string"
},
"confirmationStatus": {
"description": "Confirmation Status of the plant record.",
"type": "string"
},
"plantDetails": {
"description": "Additional comments detailing potential delays due to unforeseen events.",
"type": "string"
},
"existingSqFt": {
"format": "int32",
"description": "Existing Sq. Ft. of the plant.",
"type": "integer"
},
"longitude": {
"format": "double",
"description": "Longitude of the plant.",
"type": "number"
},
"latitude": {
"format": "double",
"description": "Latitude of the plant.",
"type": "number"
},
"worldRegionId": {
"format": "int32",
"description": "World Region ID (e.g. \"1\").",
"type": "integer"
},
"worldRegionName": {
"description": "World Region name (e.g. \"North America\").",
"type": "string"
},
"offshore": {
"description": "Location can be either Onshore (0) or Offshore (1).\n",
"enum": [
"0",
"1"
],
"type": "string"
},
"offshoreAddress": {
"$ref": "#/components/schemas/offshoreAddress",
"description": "Offshore Adress."
},
"offshorePlatformType": {
"format": "int32",
"description": "Offshore Platform Type ID.",
"type": "integer"
},
"offshorePlatformTypeDesc": {
"description": "Offshore Platform Type description.",
"type": "string"
},
"waterDepth": {
"format": "int32",
"description": "Water depth.",
"type": "integer"
},
"waterDepthUom": {
"description": "Water depth unit of measure. Water depth can be measured in Feet or Meters.",
"type": "string"
},
"distanceFromShore": {
"format": "int32",
"description": "Distance from shore.",
"type": "integer"
},
"distanceFromShoreUom": {
"description": "Distance from shore unit of measure. Distance from shore can be measured in Miles or Kilometers.",
"type": "string"
},
"nercRegion": {
"description": "NERC Region (North American Electric Reliability Council).",
"type": "string"
},
"nercSubRegionName": {
"description": "NERC Sub Region name. ",
"type": "string"
},
"isoRtoRegion": {
"description": "ISO/RTO Region (Independent System Operator Regional Transmission Organization).",
"type": "string"
},
"controlAreaId": {
"description": "Balancing Authority/Control Area abbreviation (e.g. \"WALC\").",
"type": "string"
},
"controlAreaName": {
"description": "Balancing Authority/Control Area description (e.g. \"Western Area Power Administration - Desert Southwest Region\"). ",
"type": "string"
},
"electricalConnectionName": {
"description": "Electrical Connection.",
"type": "string"
},
"mailingAddress": {
"$ref": "#/components/schemas/mailingAddress",
"description": "Mailing Address of the plant."
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddress",
"description": "Physical Address of the plant."
},
"phone": {
"$ref": "#/components/schemas/phoneNumber",
"description": "Phone Number of the plant."
},
"phoneMobile": {
"description": "Plant Phone Number is a Mobile Number (0 = No, 1 = Yes).",
"type": "string"
},
"owner": {
"description": "Plant Ownership.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ownerCompany"
}
},
"parent": {
"$ref": "#/components/schemas/parentCompany",
"description": "Name of the Parent Company which is the ultimate owner with the largest percentage ownership of the plant."
},
"operator": {
"$ref": "#/components/schemas/operatorCompany",
"description": "Plant Operator Company."
},
"contact": {
"description": "Plant Contacts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/contact"
}
},
"ltsa": {
"description": "Long Term Service Agreement.",
"type": "array",
"items": {
"$ref": "#/components/schemas/plantLtsa"
}
},
"capacity": {
"description": "Plant Capacity.",
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity"
}
},
"fuel": {
"$ref": "#/components/schemas/fuel",
"description": "The Fuel/Energy Source Types."
},
"shalePlays": {
"description": "The Shale Plays to which the Plant is connected for feedstock.",
"type": "array",
"items": {
"$ref": "#/components/schemas/shalePlays"
}
},
"oilGasBasins": {
"description": "The Oil & Gas Basins to which the Plant is connected to.",
"type": "array",
"items": {
"$ref": "#/components/schemas/oilGasBasins"
}
},
"sicProduct": {
"description": "The SIC Product(s) of the plant.",
"type": "array",
"items": {
"$ref": "#/components/schemas/sicProduct"
}
},
"coalUsage": {
"$ref": "#/components/schemas/coalUsage",
"description": "Coal Usage of the plant."
},
"miningMethod": {
"$ref": "#/components/schemas/miningMethod",
"description": "Mining Methods."
},
"transportationMode": {
"$ref": "#/components/schemas/transportationMode",
"description": "Transportation Mode."
},
"cogenChp": {
"format": "int64",
"description": "Cogeneration/CHP (Combined Heat and Power).",
"type": "integer"
}
}
},
"offlineEventSummaryFields": {
"required": [
"eventStartDate",
"eventEndDate",
"eventId",
"offlineEventKey"
],
"type": "object",
"properties": {
"offlineEventKey": {
"description": "Offline Event Key. This is a concatenated primary key which contains the eventId along with the plantId, unitId or asset Id (pipelineId or tLineId) linked by an asterisk (*).",
"type": "string"
},
"eventId": {
"format": "int32",
"description": "Event ID.",
"type": "integer"
},
"eventType": {
"description": "The Event Type. Each event is identified by a specific event type. Planned events are scheduled events, while unplanned is a forced event resulting from abnormal operating conditions. ",
"type": "string"
},
"eventStatusDesc": {
"description": "Status of the event.",
"type": "string"
},
"associatedEntityStartDate": {
"format": "date-time",
"description": "Current Kick-Off Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityEndDate": {
"format": "date-time",
"description": "Current Completion Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityPrevStartDate": {
"format": "date-time",
"description": "Previous Kick-Off Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityPrevEndDate": {
"format": "date-time",
"description": "Previous Completion Date of the event at the associated entity level (Plant, Unit, Pipeline or Transmission Line).",
"type": "string"
},
"associatedEntityType": {
"description": "Associated Entity Type (PLANT, UNIT or ASSET).",
"type": "string"
},
"associatedPlantId": {
"format": "int32",
"description": "Associated Plant ID.",
"type": "integer"
},
"eventStartDate": {
"format": "date-time",
"description": "Current Kick-Off Date of the event.",
"type": "string"
},
"eventEndDate": {
"format": "date-time",
"description": "Current Completion Date of the event.",
"type": "string"
},
"prevStartDate": {
"format": "date-time",
"description": "Previous Kick-Off Date of the event.",
"type": "string"
},
"prevEndDate": {
"format": "date-time",
"description": "Previous Completion Date of the event.",
"type": "string"
},
"eventComments": {
"description": "Event Comments. Each offline event report includes a comment specifying reasons for time down.",
"type": "string"
},
"eventDuration": {
"format": "int64",
"description": "The Event Duration number of days. ",
"type": "integer"
},
"plantId": {
"format": "int32",
"description": "The ID of the Plant. The Plant ID is a unique seven-digit IIR database ID number assigned to each plant profile.",
"type": "integer"
},
"plantName": {
"description": "Name of the plant. Plant names are based on the Owner's name for a particular plant.",
"type": "string"
},
"plantOwnerName": {
"description": "Owner name of the plant.",
"type": "string"
},
"physicalAddress": {
"$ref": "#/components/schemas/physicalAddressSummary",
"description": "Physical Address."
},
"offshoreAddress": {
"$ref": "#/components/schemas/offshoreAddressSummary",
"description": "Offshore Address."
},
"isoRtoRegion": {
"description": "ISO/RTO Region (Independent System Operator Regional Transmission Organization).",
"type": "string"
},
"tradingRegionName": {
"description": "Trading Region name (e.g. \"I\"). US Regions are defined by industry standards and grouped by PADDs.",
"type": "string"
},
"unitId": {
"format": "int32",
"description": "The ID of the Unit. The Unit ID is a unique seven-digit number used by IIR that is assigned to a unit profile.",
"type": "integer"
},
"unitName": {
"description": "Name of the unit. Unit names are based on the Owner's name for a particular unit. ",
"type": "string"
},
"unitTypeDesc": {
"description": "Unit Type description.",
"type": "string"
},
"fuel": {
"$ref": "#/components/schemas/fuelSummary",
"description": "The Fuel/Energy Source Types."
},
"offlineCapacity": {
"$ref": "#/components/schemas/offlineCapacity",
"description": "The Capacity Offline."
},
"pipelineId": {
"format": "int32",
"description": "The ID of the pipeline. The Pipeline ID is a unique number used by IIR that is assigned to each pipeline profile.",
"type": "integer"
},
"pipelineName": {
"description": "The Name of the pipeline. Pipeline names are based on the Owner's name for a particular pipeline. The name could include the ID or name to which the pipeline sends product to. ",
"type": "string"
},
"pipelineLengthMiles": {
"format": "int64",
"description": "Pipeline Length (Miles).",
"type": "integer"
},
"pipelineLengthKilometers": {
"format": "int64",
"description": "Pipeline Length (Kilometers).",
"type": "integer"
},
"pipelineSystemId": {
"format": "int32",
"description": "The ID of the pipeline system.",
"type": "integer"
},
"pipelineSystemName": {
"description": "Name of the pipeline system.",
"type": "string"
},
"pipelineSystemLengthMiles": {
"format": "int64",
"description": "Pipeline System Length (Miles).",
"type": "integer"
},
"pipelineSystemLengthKilometers": {
"format": "int64",
"description": "Pipeline System Length (Kilometers).",
"type": "integer"
},
"tLineId": {
"format": "int32",
"description": "The ID of the transmission line. The Transmission Line ID is a seven-digit unique number used by IIR that is assigned to each transmission line profile.",
"type": "integer"
},
"tLineName": {
"description": "Name of the transmission line. Each Transmission Line profile has a transmission line name.",
"type": "string"
},
"tLineSystemId": {
"format": "int32",
"description": "The ID of the transmission system.",
"type": "integer"
},
"tLineSystemName": {
"description": "Name of the transmission system.",
"type": "string"
},
"tLineLengthMiles": {
"format": "int64",
"description": "Transmission Line Length (Miles).",
"type": "integer"
},
"tLineLengthKilometers": {
"format": "int64",
"description": "Transmission Line Length (Kilometers).",
"type": "integer"
},
"tLineSystemLengthMiles": {
"format": "int64",
"description": "Transmission System Length (Miles).",
"type": "integer"
},
"tLineSystemLengthKilometers": {
"format": "int64",
"description": "Transmission Line System Length (Kilometers).",
"type": "integer"
},
"liveDate": {
"format": "date-time",
"description": "Initial release date of offline event records that have never been reported or updated.",
"type": "string"
},
"releaseDate": {
"format": "date-time",
"description": "The release date of the offline event record. This includes full quality control updates as well as record updates throughout the year.",
"type": "string"
}
}
}
},
"securitySchemes": {
"JWT": {
"scheme": "bearer",
"type": "http",
"description": "IIR API uses JWT authentication tokens (JSON Web Tokens) to validate all endpoints. The first step for accessing these endpoints is to generate a JWT authentication token, since all API endpoints require a valid token. Once you have generated a token, copy and paste the long string after “authorization: Bearer” and click SET. For security reasons, tokens are only valid for a limited period (By default, tokens will expire after 1 day. Maximum is 30 days)."
}
}
},
"security": [
{
"JWT": [
]
}
],
"tags": [
{
"name": "User",
"description": ""
},
{
"name": "Company Search",
"description": ""
},
{
"name": "Project Search",
"description": ""
},
{
"name": "Plant Search",
"description": ""
},
{
"name": "Unit Search",
"description": ""
},
{
"name": "Offline Event Search",
"description": ""
},
{
"name": "Boiler Search",
"description": ""
},
{
"name": "Drive Search",
"description": ""
},
{
"name": "Mining Equipment Search",
"description": ""
},
{
"name": "Other Equipment Search",
"description": ""
},
{
"name": "Pipeline Search",
"description": ""
},
{
"name": "Transmission Line Search",
"description": ""
},
{
"name": "Labor Project Duration Search ",
"description": ""
},
{
"name": "References",
"description": ""
}
]
}