Furnace room where any piece of equipment is over 400,000 Btu perhour input\n
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
Rooms with boilers where the largest piece of equipment is over 15psi and 10 horsepower\n
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
Refrigerant machinery room
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
Hydrogen fuel gas rooms, not classified as Group H
\n
1 hour in Group B, F, M, S and U occupancies; 2 hours in Group A, E,I and R occupancies.\n
\n
\n
\n
Incinerator rooms
\n
2 hours and provide automatic sprinkler system
\n
\n
\n
Paint shops, not classified as Group H, located in occupancies otherthan Group F\n
\n
2 hours; or 1 hour and provide automatic sprinkler system
\n
\n
\n
In Group E occupancies, laboratories and vocational shops notclassified as Group H\n
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
In Group I-2 occupancies, laboratories not classified as Group H
\n
1 hour and provide automatic sprinkler system
\n
\n
\n
In ambulatory care facilities, laboratories not classified as Group H
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
Laundry rooms over 100 square feet
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
In Group I-2, laundry rooms over 100 square feet
\n
1 hour
\n
\n
\n
Group I-3 cells and Group I-2 patient rooms equipped with paddedsurfaces\n
\n
1 hour
\n
\n
\n
In Group I-2, physical plant maintenance shops
\n
1 hour
\n
\n
\n
In ambulatory care facilities or Group I-2 occupancies, waste andlinen collection rooms with containers that have an aggregate volume of 10 cubic feet or greater
\n
1 hour
\n
\n
\n
In other than ambulatory care facilities and Group I-2 occupancies, waste and linen collection rooms over 100 square feet\n
\n
1 hour or provide automatic sprinkler system
\n
\n
\n
In ambulatory care facilities or Group I-2 occupancies, storage rooms greater than 100 square feet\n
\n
1 hour
\n
\n
\n
\n Stationary storage battery systems having an energy capacity greater than the threshold quantity specified in Table 1206.2 of the International Fire Code\n \n \n
\n
\n 1 hour in Group B, F, M, S and U occupancies; 2 hours in Group A, E, I and R occupancies.\n \n
\n
\n
\n
\n Electrical installations and transformers\n
\n
\n See Sections 110.26 through 110.34 and Sections 450.8 through 450.48 of NFPA 70 for \n protection and separation requirements.\n \n
Where Table 509 permits an automatic sprinkler system without a fire barrier, the incidental uses shall be separated from the remainder of the building by construction capable of resisting the passage of smoke. The walls shall extend from the top of the foundation or floor assembly below to the underside of the ceiling that is a component of a fire-resistance-rated floor assembly or roof assembly above or to the underside of the floor or roof sheathing, deck or slab above. Doors shall be self- or automatic-closing upon detection of smoke in accordance with Section 716.2.6.6. Doors shall not have air transfer openings and shall not be undercut in excess of the clearance permitted in accordance with NFPA 80. Walls surrounding the incidental use shall not have air transfer openings unless provided with smoke dampers in accordance with Section 710.8.
Where an automatic sprinkler system is provided in accordance with Table 509, only the space occupied by the incidental use need be equipped with such a system.
",
"type": "codeSection",
"children": []
}
]
}
},
"definition-response" : {
"value": {
"subdefinitions": [],
"term": "ACCESSIBLE.",
"xmlId": "IBC2018_Ch02_Sec202_DefACCESSIBLE",
"definition": "A site, building, facility or portion thereof that complies with Chapter 11.",
"label": "[BE]",
"extended": "",
"type": "definition"
}
},
"subdefinition-response" : {
"value": {
"term": "Low-heat appliance (residential appliance).",
"xmlId": "IFGC2018P3_Ch02_Sec202_DefAPPLIANCE_TYPE_SubDefLOW_HEAT_APPLIANCE_RESIDENTIAL_APPLIANCE",
"definition": "Any appliance in which the products of combustion at the point of entrance to the flue under normal operating conditions have a temperature of 1,000°F (538°C) or less.",
"label": "",
"extended": "",
"type": "subdefinition",
"children": []
}
},
"subchapter-response" : {
"value": {
"ordinal": "1",
"ordinalClean": "1",
"xmlId": "IFGC2018P3_Ch01_SubCh01",
"label": "PART",
"title": "SCOPE AND APPLICATION",
"type": "subchapter"
}
},
"reference-standard-response" : {
"value": {
"promulgator": {
"acronym": "AA",
"city": "Arlington",
"name": "Aluminum Association",
"url": "http://www.aluminum.org",
"state": "VA",
"ordinal": "35",
"ordinalClean": "35",
"streetAddress": "1400 Crystal Drive, Suite 430",
"xmlId": "IBC2018_Ch35_PromAA",
"addressee": "",
"location": "",
"country": "",
"postalCode": "22202",
"type": "promulgator"
},
"references": "1604.3.5, 2002.1",
"number": "ADM1—2015",
"xmlId": "IBC2018_Ch35_PromAA_RefStdADM1_2015",
"title": "Aluminum Design Manual: Part 1—A Specification for Aluminum Structures",
"type": "referenceStandard"
}
},
"figure-response" : {
"value": {
"footnote": "",
"figure": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD...",
"filename": "Images/Fig08.jpg",
"ordinal": "Figure 602.4.1(2)",
"ordinalClean": "602.4.1",
"xmlId": "IBCComm2015V1_Ch06_Sec602.4.1_Fig602.4.1(2)",
"label": "",
"title": "COLUMN/FLOOR BEAM CONNECTIONSAmerican Institute for Timber Construction",
"content": "",
"type": "figure"
}
},
"promulgator-response" : {
"value": {
"acronym": "CSA",
"city": "Cleveland",
"name": "CSA Group",
"url": "https://www.csagroup.org/",
"state": "OH",
"ordinal": "14",
"ordinalClean": "14",
"streetAddress": "8501 East Pleasant Valley Road",
"xmlId": "IPSDC2021P1_Ch14_PromCSA",
"addressee": "",
"location": "",
"country": "",
"postalCode": "44131-5516",
"type": "promulgator",
"children": [
{
"promulgator": {
"acronym": "CSA",
"city": "Cleveland",
"name": "CSA Group",
"url": "https://www.csagroup.org/",
"state": "OH",
"ordinal": "14",
"ordinalClean": "14",
"streetAddress": "8501 East Pleasant Valley Road",
"xmlId": "IPSDC2021P1_Ch14_PromCSA",
"addressee": "",
"location": "",
"country": "",
"postalCode": "44131-5516",
"type": "promulgator"
},
"references": "Table 505.1",
"number": "A257.2—14",
"xmlId": "IPSDC2021P1_Ch14_PromCSA_RefStdA257_2_14",
"title": "Reinforced Circular Concrete Culvert, Storm Drain, Sewer Pipe and Fittings",
"type": "referenceStandard"
}
]
}
},
"chapter-response" : {
"value": {
"ordinal": "1",
"ordinalClean": "1",
"xmlId": "IBC2018_Ch01",
"label": "CHAPTER",
"title": "SCOPE AND ADMINISTRATION",
"type": "chapter",
"userNotes": "
User notes:
\n
About this chapter: Chapter 1 establishes the limits of applicability of the code and describes how the code is to be applied and enforced.
",
"children": [
{
"ordinal": "1",
"ordinalClean": "1",
"xmlId": "IBC2018_Ch01_SubCh01",
"label": "PART",
"title": "SCOPE AND APPLICATION",
"type": "subchapter"
},
{
"ordinal": "2",
"ordinalClean": "2",
"xmlId": "IBC2018_Ch01_SubCh02",
"label": "PART",
"title": "ADMINISTRATION AND ENFORCEMENT",
"type": "subchapter"
}
]
}
}
}
}
}
},
"404": {
"description": "Bad formed XML ID or could not lookup content."
}
},
"x-codeSamples" : [
{
"lang": "CURL",
"source": "curl -X GET \"https://code-connect-api-dev.iccsafe.org/v1/content/{contentId}\" -H \"Authorization: Bearer {OAuth Token}\""
},
{
"lang": "JavaScript",
"source": "var request = new XMLHttpRequest();\n//Add X-AUTH-TOKEN header\nrequest.setRequestHeader('Authorization', 'Bearer {OAuth Token}',);\nrequest.open('GET', 'https://code-connect-api-dev.iccsafe.org/v1/content/{contentId}', true);\nrequest.onload = function () {\n //Access Response Data\n var data = JSON.parse(this.response);\n if (request.status >= 200 && request.status < 400) {\n console.log(data);\n } else {\n //Error\n }\n}"
}
]
}
},
"/v1/content/{content_id}": {
"get": {
"tags" : [
"Images"
],
"operationId": "getContentImage",
"summary": "Images in Content endpoint",
"description": "When making API requests for content, you will find that in some cases the JSON response contains base64 embedded images. Depending on the ID that you request, if the content contains an image you will be able to use it directly from the JSON response as a base64 string. This allows image data to be transmitted as part of a JSON response without requiring separate file handling or additional HTTP requests. \n \n The encoded string includes a data URI prefix (e.g. `data:image/jpeg;base64`) to indicate the MIME type of the image. You can directly embed these images in HTML by assigning the base64 string to the `src` attribute of an `` tag or base64 decoding the string and saving it as an image file. \n \n In some cases you may find base64 encoded images directly within the content, for example: `
Type V construction is required to comply with Table 601 and Chapter 23.
Content endpoint and switch to the `figure-response` sample.",
"security": [
{
"Client ID and Secret": ["content-read"],
"Email and Password": ["content-read"]
}
],
"parameters": [
{
"name": "content_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "OHRC2019P2_Pt03_Ch08_Sec804.1.2_Fig804.1.2"
},
"examples": {
"Figure ID": {
"value": "OHRC2019P2_Pt03_Ch08_Sec804.1.2_Fig804.1.2",
"summary": "Content ID for a figure"
},
"Section with image": {
"value": "IBCComm2015V1_Ch06_Sec602.5",
"summary": "Section ID that contains an image as part of the content"
}
}
}
],
"responses": {
"200": {
"description": "Content schema responses vary depending on the element being retrieved. JSON.",
"headers": {
"X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Client-Remaining" },
"X-RateLimit-Retry-After": { "$ref": "#/components/headers/X-RateLimit-Client-Retry-After" },
"X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Client-Limit" }
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Content"
},
"examples": {
"figure-response" : {
"value": {
"footnote": "",
"figure": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD...",
"filename": "Images/Fig08.jpg",
"ordinal": "Figure 602.4.1(2)",
"ordinalClean": "602.4.1",
"xmlId": "IBCComm2015V1_Ch06_Sec602.4.1_Fig602.4.1(2)",
"label": "",
"title": "COLUMN/FLOOR BEAM CONNECTIONSAmerican Institute for Timber Construction",
"content": "",
"type": "figure"
}
},
"content-with-image-response" : {
"value": {
"type": "codeSection",
"label": "",
"title": "Type V.",
"xmlId": "IBCComm2015V1_Ch06_Sec602.5",
"content": "
Type V construction is that type of construction in which the structural elements, exterior walls and interior walls are of any materials permitted by this code.
❖ Type V construction allows the use of all types of materials, both noncombustible and combustible, but Type V buildings are most commonly constructed of dimensional lumber (see Commentary Figure 602.5 for an example of Type V construction). It is divided into two subclassifications: Types VA and VB. An example of a typical building of Type VA construction is a wood frame building in which the interior and exterior load-bearing walls, floors, roofs and all structural members are protected to provide a minimum 1-hour fire-resistance rating. Type V construction is required to comply with Table 601 and Chapter 23.
= 200 && request.status < 400) {\n console.log(data);\n } else {\n //Error\n }\n}"
}
]
}
},
"/v1/search": {
"get": {
"tags": [
"Search"
],
"operationId": "searchContent",
"summary": "Search within Titles - v1",
"description": "Returns a JSON response listing all search results.\n",
"security": [
{
"Client ID and Secret": ["content-read"],
"Email and Password": ["content-read"]
}
],
"parameters": [
{
"name": "bookId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"example" : "IBC2018",
"description": "Book ID target for search or for searching in multiple titles group the book IDs in brackets `[IBC2018P2,IBC2021P1]`."
},
{
"name": "chapterOrdinal",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "IBC2018_Ch05",
"description": "Chapter Ordinal/Number target for search."
},
{
"name": "contentType",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "table",
"description": "The type of content to filter your search on. Possible values include: codeSection, table, figure, appendix, chapter, definitions, subdefinition, promulgator, referenceStandard"
},
{
"name": "contentOrdinal",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "806.2",
"description": "Content Ordinal target for search."
},
{
"name": "contentId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "IBC2021P1_Ch08_Sec806.2",
"description": "Content ID target for search."
},
{
"name": "search",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"example" : "Means of Egress",
"description": "You can use quotes to search for an exact phrase (e.g. \"Means of Egress\"), or search without quotes to get the results that contain any of the words in the search query (e.g. Means of Egress)."
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"example" : "1",
"description": "Pagination through result set."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"example" : "10",
"description": "Limit Result Set. Default set to 10."
}
],
"responses": {
"200": {
"description": "Search Results JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Search"
},
"examples": {
"search-response-single-book": {
"value": [
{
"chapterid" : "IBC2018P2_Ch26",
"chapterordinal" : "26",
"chaptertitle" : "PLASTIC",
"contentordinal" : "2612.2",
"contentid" : "IBC2018P2_Ch26_Sec2612.2",
"contenttitle" : "Labeling.",
"content" : "
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
",
"contenttype" : "codeSection",
"label" : ""
},
{
"chapterid" : "IBC2018P2_Ch04",
"chapterordinal" : "4",
"chaptertitle" : "SPECIAL DETAILED REQUIREMENTS BASED ON OCCUPANCY AND USE",
"contentordinal" : "428.4",
"contentid" : "IBC2018P2_Ch04_Sec428.4",
"contenttitle" : "Percentage of maximum allowable quantity in each laboratory suite.",
"content" : "
The percentage of maximum allowable quantities of hazardous materials in each laboratory suite shall be in accordance with Table 428.3.
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
",
"contenttype" : "codeSection",
"label" : ""
},
{
"chapterid" : "IBC2018P2_Ch04",
"chapterordinal" : "4",
"chaptertitle" : "SPECIAL DETAILED REQUIREMENTS BASED ON OCCUPANCY AND USE",
"contentordinal" : "428.4",
"contentid" : "IBC2018P2_Ch04_Sec428.4",
"contenttitle" : "Percentage of maximum allowable quantity in each laboratory suite.",
"content" : "
The percentage of maximum allowable quantities of hazardous materials in each laboratory suite shall be in accordance with Table 428.3.
",
"contenttype" : "codeSection",
"label" : "[A]"
},
{
"chapterid" : "IBC2021P1_Ch04",
"chapterordinal" : "4",
"chaptertitle" : "Calculation software tools.",
"contentordinal" : "C407.6",
"contentid" : "IBC2021P1_Ch04_SecC407.6",
"contenttitle" : "Percentage of maximum allowable quantity in each laboratory suite.",
"content" : "
Calculation procedures used to comply with this section shall be software tools capable of calculating the annual energy consumption of all building elements.
",
"contenttype" : "codeSection",
"label" : ""
}
]
}
}
}
}
},
"204": {
"description": "The book index being searched against does not exist."
},
"503": {
"description": "There was an error in building the search query."
}
},
"x-codeSamples": [
{
"lang": "CURL",
"source": "curl -X GET \"https://code-connect-api-dev.iccsafe.org/v1/search?bookId={bookId}&search={search}\" -H \"accept: application/json\" -H \"Authorization: Bearer {OAuth Token}\""
},
{
"lang": "JavaScript",
"source": "var request = new XMLHttpRequest();\n//Add header\nrequest.setRequestHeader('Authorization', 'Bearer {OAuth Token}',);\nrequest.open('GET', 'https://code-connect-api-dev.iccsafe.org/v1/search/?bookId={bookId}&search={search}', true);\nrequest.onload = function () {\n //Access Response Data\n var data = JSON.parse(this.response);\n if (request.status >= 200 && request.status < 400) {\n data.collections.forEach(result => {\n console.log(result.content);\n });\n } else {\n //Error\n }\n}"
},
{
"lang": "CURL - multiple books",
"source": "curl -X GET \"https://code-connect-api-dev.iccsafe.org/v1/search?bookId=[IBC2018P2,IBC2021P1]&search={search}\" -H \"accept: application/json\" -H \"Authorization: Bearer {OAuth Token}\""
},
{
"lang": "JavaScript - multiple books",
"source": "var request = new XMLHttpRequest();\n//Add header\nrequest.setRequestHeader('Authorization', 'Bearer {OAuth Token}',);\nrequest.open('GET', 'https://code-connect-api-dev.iccsafe.org/v1/search/?bookId=[IBC2018P2,IBC2021P1]&search={search}', true);\nrequest.onload = function () {\n //Access Response Data\n var data = JSON.parse(this.response);\n if (request.status >= 200 && request.status < 400) {\n data.collections.forEach(result => {\n console.log(result.content);\n });\n } else {\n //Error\n }\n}"
}
]
}
},
"/v2/search": {
"get": {
"tags": [
"Search"
],
"operationId": "searchContent-v2",
"summary": "Search within Titles - v2",
"description": "Returns a JSON response listing all search results.\n Introduces a new key in the response containing the highlighted parts that match the search query.\n",
"security": [
{
"Client ID and Secret": ["content-read"],
"Email and Password": ["content-read"]
}
],
"parameters": [
{
"name": "bookId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"example" : "IBC2018",
"description": "Book ID target for search or for searching in multiple titles group the book IDs in brackets `[IBC2018P2,IBC2021P1]`."
},
{
"name": "chapterOrdinal",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "IBC2018_Ch05",
"description": "Chapter Ordinal/Number target for search."
},
{
"name": "contentType",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "table",
"description": "The type of content to filter your search on. Possible values include: codeSection, table, figure, appendix, chapter, definitions, subdefinition, promulgator, referenceStandard"
},
{
"name": "contentOrdinal",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "806.2",
"description": "Content Ordinal target for search."
},
{
"name": "contentId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example" : "IBC2021P1_Ch08_Sec806.2",
"description": "Content ID target for search."
},
{
"name": "search",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"example" : "Means of Egress",
"description": "You can use quotes to search for an exact phrase (e.g. \"Means of Egress\"), or search without quotes to get the results that contain any of the words in the search query (e.g. Means of Egress)."
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"example" : "1",
"description": "Pagination through result set."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"example" : "10",
"description": "Limit Result Set. Default set to 10."
}
],
"responses": {
"200": {
"description": "Search Results JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Search-v2"
},
"examples": {
"search-response-single-book": {
"value": [
{
"ordinal" : "26",
"title" : "PLASTIC",
"xmlId" : "IBC2018P2_Ch26_Sec2612.2",
"content" : "
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
"]
}
},
{
"ordinal" : "4",
"title" : "SPECIAL DETAILED REQUIREMENTS BASED ON OCCUPANCY AND USE",
"xmlId" : "IBC2018P2_Ch04_Sec428.4",
"content" : "
The percentage of maximum allowable quantities of hazardous materials in each laboratory suite shall be in accordance with Table 428.3.
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
Plastic composite deck boards and stair treads, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the allowable load and maximum allowable span determined in accordance with ASTM D7032. Plastic composite handrails and guards, or their packaging, shall bear a label that indicates compliance with ASTM D7032 and includes the maximum allowable span determined in accordance with ASTM D7032.
"]
}
},
{
"ordinal" : "4",
"title" : "SPECIAL DETAILED REQUIREMENTS BASED ON OCCUPANCY AND USE",
"xmlId" : "IBC2018P2_Ch04_Sec428.4",
"content" : "
The percentage of maximum allowable quantities of hazardous materials in each laboratory suite shall be in accordance with Table 428.3.
Calculation procedures used to comply with this section shall be software tools capable of calculating the annual energy consumption of all building elements.
Calculation procedures used to comply with this section shall be software tools capable of calculating the annual energy consumption of all building elements.
"]
}
}
]
}
}
}
}
},
"204": {
"description": "The book index being searched against does not exist."
},
"503": {
"description": "There was an error in building the search query."
}
},
"x-codeSamples": [
{
"lang": "CURL",
"source": "curl -X GET \"https://code-connect-api-dev.iccsafe.org/v2/search?bookId={bookId}&search={search}\" -H \"accept: application/json\" -H \"Authorization: Bearer {OAuth Token}\""
},
{
"lang": "JavaScript",
"source": "var request = new XMLHttpRequest();\n//Add header\nrequest.setRequestHeader('Authorization', 'Bearer {OAuth Token}',);\nrequest.open('GET', 'https://code-connect-api-dev.iccsafe.org/v2/search/?bookId={bookId}&search={search}', true);\nrequest.onload = function () {\n //Access Response Data\n var data = JSON.parse(this.response);\n if (request.status >= 200 && request.status < 400) {\n data.collections.forEach(result => {\n console.log(result.content);\n });\n } else {\n //Error\n }\n}"
},
{
"lang": "CURL - multiple books",
"source": "curl -X GET \"https://code-connect-api-dev.iccsafe.org/v2/search?bookId=[IBC2018P2,IBC2021P1]&search={search}\" -H \"accept: application/json\" -H \"Authorization: Bearer {OAuth Token}\""
},
{
"lang": "JavaScript - multiple books",
"source": "var request = new XMLHttpRequest();\n//Add header\nrequest.setRequestHeader('Authorization', 'Bearer {OAuth Token}',);\nrequest.open('GET', 'https://code-connect-api-dev.iccsafe.org/v2/search/?bookId=[IBC2018P2,IBC2021P1]&search={search}', true);\nrequest.onload = function () {\n //Access Response Data\n var data = JSON.parse(this.response);\n if (request.status >= 200 && request.status < 400) {\n data.collections.forEach(result => {\n console.log(result.content);\n });\n } else {\n //Error\n }\n}"
}
]
}
}
},
"components": {
"securitySchemes": {
"Client ID and Secret": {
"type": "oauth2",
"description": "The ICC Code Connect API uses the OAuth 2 Client Credentials Grant Flow. \n\n https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.4 \n\n ICC will register and provide clients with their credentials.",
"flows": {
"clientCredentials": {
"tokenUrl": "/auth/token",
"x-receive-token-in": "request-body",
"x-receive-token-in-options": "request-body",
"scopes": {
"content-read": "Grants access to ICC Content through the client's access configuration."
}
}
}
},
"Email and Password": {
"type": "oauth2",
"description": "The ICC Code Connect API uses the OAuth 2 Client Password Grant Flow. \n\n https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.3.",
"flows": {
"password": {
"tokenUrl": "/auth/login",
"x-receive-token-in": "request-body",
"x-receive-token-in-options": "request-body",
"scopes": {
"content-read": "Grants access to ICC Content through the client's access configuration."
}
}
}
}
},
"parameters": {
"bookId": {
"name": "bookId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example" : "IBC2018"
}
},
"chapterId" : {
"name": "chapterId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example" : "IBC2018_Ch05"
}
}
},
"schemas": {
"Book": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Book Title"
},
"shortCode": {
"type": "string",
"description": "Book Shortcode"
},
"printing": {
"type": "string",
"description": "Printing"
},
"uri": {
"type": "array",
"description": "Book Meta Information",
"items": {
"type": "string"
}
},
"accessStartDate": {
"type": "string|null",
"description": "Start date for access to the book",
"items": {
"type": "string|null"
}
},
"accessEndDate": {
"type": "string|null",
"description": "End date for access to the book",
"items": {
"type": "string|null"
}
}
}
},
"BookWithCount": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Book Title"
},
"shortCode": {
"type": "string",
"description": "Book Shortcode"
},
"printing": {
"type": "string",
"description": "Printing"
},
"uri": {
"type": "array",
"description": "Book Meta Information",
"items": {
"type": "string"
}
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the book",
"properties": {
"chapters": {
"type": "integer",
"description": "Count of chapters in the book"
},
"frontmatter": {
"type": "integer",
"description": "Count of frontmatter in the book"
},
"backmatter": {
"type": "integer",
"description": "Count of backmatter in the book"
},
"appendicies": {
"type": "integer",
"description": "Count of appendicies in the book"
}
}
},
"accessStartDate": {
"type": "string|null",
"description": "Start date for access to the book",
"items": {
"type": "string|null"
}
},
"accessEndDate": {
"type": "string|null",
"description": "End date for access to the book",
"items": {
"type": "string|null"
}
}
}
},
"Search": {
"type": "object",
"properties": {
"chapterid": {
"type": "string",
"description": "Chapter Id"
},
"chapterordinal": {
"type": "string",
"description": "Chapter Ordinal"
},
"chaptertitle": {
"type": "string",
"description": "Chapter Title"
},
"contentordinal": {
"type": "string",
"description": "Content Ordinal"
},
"contentid": {
"type": "string",
"description": "Content Id"
},
"content": {
"type": "string",
"description": "Book Content"
},
"contenttype": {
"type": "string",
"description": "Content type identifier from Book {codeSection, table etc}"
},
"label": {
"type": "string",
"description": "Content label"
}
}
},
"Search-v2": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Chapter Ordinal"
},
"title": {
"type": "string",
"description": "Chapter Title"
},
"xmlId": {
"type": "string",
"description": "Content Id"
},
"content": {
"type": "string",
"description": "Book Content"
},
"type": {
"type": "string",
"description": "Content type identifier from Book {codeSection, table etc}"
},
"label": {
"type": "string",
"description": "Content label"
},
"highlighted": {
"type": "object",
"description": "Book content with inserted <highlight> tags within the matched query results."
}
}
},
"Chapter": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Chapter Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Chapter Title"
},
"id": {
"type": "string",
"description": "Chapter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (chapter)"
}
}
},
"ChapterWithCount": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Chapter Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Chapter Title"
},
"id": {
"type": "string",
"description": "Chapter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (chapter)"
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the chapter",
"properties": {
"sections": {
"type": "integer",
"description": "Count of sections in this chapter"
}
}
}
}
},
"Frontmatter": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Frontmatter ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Frontmatter Title"
},
"id": {
"type": "string",
"description": "Frontmatter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (FrontMatter)"
}
}
},
"FrontmatterWithCount": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Frontmatter ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Frontmatter Title"
},
"id": {
"type": "string",
"description": "Frontmatter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (FrontMatter)"
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the frontmatter",
"properties": {
"sections": {
"type": "integer",
"description": "Count of sections in this frontmatter"
}
}
}
}
},
"Backmatter": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Backmatter Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Backmatter Title"
},
"id": {
"type": "string",
"description": "Backmatter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (Appendix)"
}
}
},
"BackmatterWithCount": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Backmatter Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Backmatter Title"
},
"id": {
"type": "string",
"description": "Backmatter XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (Appendix)"
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the backmatter",
"properties": {
"sections": {
"type": "integer",
"description": "Count of sections in this backmatter"
}
}
}
}
},
"Appendices": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Appendix Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Appendix Title"
},
"id": {
"type": "string",
"description": "Appendix XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (Appendix)"
}
}
},
"AppendicesWithCount": {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Appendix Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Appendix Title"
},
"id": {
"type": "string",
"description": "Appendix XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (Appendix)"
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the appendix",
"properties": {
"sections": {
"type": "integer",
"description": "Count of sections in this appendix"
}
}
}
}
},
"Section" : {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Section Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Section Title"
},
"id": {
"type": "string",
"description": "Section XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (section)"
}
}
},
"SectionWithCount" : {
"type": "object",
"properties": {
"ordinal": {
"type": "string",
"description": "Section Ordinal"
},
"ordinalClean": {
"type": "string",
"description": "Clean value of the ordinal without extra symbols"
},
"title": {
"type": "string",
"description": "Section Title"
},
"id": {
"type": "string",
"description": "Section XML Id"
},
"dtype": {
"type": "string",
"description": "Data Type (section)"
},
"childrenCount": {
"type": "object",
"description": "Count of children items inside the section",
"properties": {
"subsections": {
"type": "integer",
"description": "Count of subsections in this section"
},
"tables": {
"type": "integer",
"description": "Count of tables in this section"
},
"figures": {
"type": "integer",
"description": "Count of figures in this section"
}
}
}
}
},
"Content" : {
"type": "string",
"description": "JSON Object, Misc Format. See examples.",
"format": "json"
},
"Books": {
"type": "object",
"properties": {
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Book"
}
}
}
},
"BooksWithCount": {
"type": "object",
"properties": {
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookWithCount"
}
}
}
},
"Chapters": {
"type": "object",
"properties": {
"bookId": {
"type": "string",
"description": "Book XML Id"
},
"title": {
"type": "string",
"description": "Book Title"
},
"printing": {
"type": "string",
"description": "Book Printing"
},
"chapters": {
"type": "array",
"description": "Book Chapter List",
"items": {
"$ref": "#/components/schemas/Chapter"
}
},
"frontmatter": {
"type": "array",
"description": "Book Frontmatter List",
"items": {
"$ref": "#/components/schemas/Frontmatter"
}
},
"backmatter": {
"type": "array",
"description": "Book Backmatter List",
"items": {
"$ref": "#/components/schemas/Backmatter"
}
},
"appendices": {
"type": "array",
"description": "Book Appendices List",
"items": {
"$ref": "#/components/schemas/Appendices"
}
},
"responseId": {
"type": "string",
"description": "UUID"
}
}
},
"ChaptersWithCount": {
"type": "object",
"properties": {
"bookId": {
"type": "string",
"description": "Book XML Id"
},
"title": {
"type": "string",
"description": "Book Title"
},
"printing": {
"type": "string",
"description": "Book Printing"
},
"chapters": {
"type": "array",
"description": "Book Chapter List",
"items": {
"$ref": "#/components/schemas/ChapterWithCount"
}
},
"frontmatter": {
"type": "array",
"description": "Book Frontmatter List",
"items": {
"$ref": "#/components/schemas/FrontmatterWithCount"
}
},
"backmatter": {
"type": "array",
"description": "Book Backmatter List",
"items": {
"$ref": "#/components/schemas/BackmatterWithCount"
}
},
"appendices": {
"type": "array",
"description": "Book Appendices List",
"items": {
"$ref": "#/components/schemas/AppendicesWithCount"
}
},
"responseId": {
"type": "string",
"description": "UUID"
}
}
},
"Sections": {
"type": "object",
"properties": {
"sectionId": {
"type": "string",
"description": "Parent Section XML Id"
},
"bookId": {
"type": "string",
"description": "Section XML Id"
},
"chapterId": {
"type": "string",
"description": "Book Chapter XML Id"
},
"sections": {
"type": "array",
"description": "Section List",
"items": {
"$ref": "#/components/schemas/Section"
}
},
"responseId": {
"type": "string",
"description": "UUID"
}
}
},
"SectionsWithCount": {
"type": "object",
"properties": {
"sectionId": {
"type": "string",
"description": "Parent Section XML Id"
},
"bookId": {
"type": "string",
"description": "Section XML Id"
},
"chapterId": {
"type": "string",
"description": "Book Chapter XML Id"
},
"sections": {
"type": "array",
"description": "Section List",
"items": {
"$ref": "#/components/schemas/SectionWithCount"
}
},
"responseId": {
"type": "string",
"description": "UUID"
}
}
}
},
"headers": {
"X-RateLimit-Client-Remaining": {
"description": "Remaining number of requests at the given time for the authenticated client.",
"schema": {
"type": "integer"
}
},
"X-RateLimit-Client-Retry-After": {
"description": "Amount of seconds it takes for more requests to be available if rate limit is reached.",
"schema": {
"type": "integer"
}
},
"X-RateLimit-Client-Limit": {
"description": "Amount of requests available to the client before reaching the rate limit.",
"schema": {
"type": "integer"
}
}
}
}
}