{"openapi":"3.0.1","info":{"title":"Component & NHTSA Database Code Library APIs: ","description":"This API provides programmatic access to the NHTSA Component Test Database and the NHTSA Database code library, which includes the codes and descriptions for the data fields defined in the NHTSA Test Reference Guides.","version":"1.0.0"},"servers":[{"url":"/","description":"Default Server URL"}],"paths":{"/nhtsa/nhtsadb/api/v1/testPerformers/{database}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"testPerformers","parameters":[{"name":"database","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/ncodes":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"listAllCodes","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/model/{make}/{model}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"findByMakeAndModelId","parameters":[{"name":"make","in":"path","required":true,"schema":{"type":"string"}},{"name":"model","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/model/list/{make}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"listByModel","parameters":[{"name":"make","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/model/":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"listAllModels","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/list/{codeName}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"listByCodeName","parameters":[{"name":"codeName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/filterclass/{senatt}/{sentyp}/{units}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"findFilterClass","parameters":[{"name":"senatt","in":"path","required":true,"schema":{"type":"string"}},{"name":"sentyp","in":"path","required":true,"schema":{"type":"string"}},{"name":"units","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/nhtsadb/api/v1/decode/{codeName}/{code}":{"get":{"tags":["nhtsa-db-data-controller"],"operationId":"findByCodeNameAndCode","parameters":[{"name":"codeName","in":"path","required":true,"schema":{"type":"string"}},{"name":"code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/downloadDataFile":{"get":{"tags":["component-documents-controller"],"operationId":"downloadFile","parameters":[{"name":"testNo","in":"query","required":true,"schema":{"type":"string"}},{"name":"vehNo","in":"query","required":false,"schema":{"type":"string"}},{"name":"compNo","in":"query","required":false,"schema":{"type":"string"}},{"name":"configNo","in":"query","required":false,"schema":{"type":"string"}},{"name":"fileName","in":"query","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","required":true,"schema":{"type":"string"}},{"name":"docNo","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}},"/nhtsa/component/api/v1/component-documents/test-no/{testNo}":{"get":{"tags":["component-documents-controller"],"operationId":"findByTestNo","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results":{"get":{"tags":["component-data-controller"],"operationId":"getAllTestData","parameters":[{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of rows to return","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/test-reference-no/{testReferenceNo}":{"get":{"tags":["component-data-controller"],"operationId":"findByTestReferenceNo","parameters":[{"name":"testReferenceNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/test-no/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"findByTestNo_1","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/occupant-types":{"get":{"tags":["component-data-controller"],"operationId":"getOccupantTypes","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/metadata/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getJsonExport","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"isRequestForZipFile","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-vehicle-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getVehicleInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-vehicle-detail-info/{vehicleNo}/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getVehicleDetailInformation","parameters":[{"name":"vehicleNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-test-detail/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getTestDetails","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-multimedia-files/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getMultiMediaFiles","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-instrumentation-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getInstrumentationInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of rows to return","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-instrumentation-detail-info/{curveNo}/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getInstrumentationDetailInformation","parameters":[{"name":"curveNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-configuration-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getConfigurationInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-configuration-detail-info/{confNo}/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getConfigurationDetailInformation","parameters":[{"name":"confNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-videos-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getVideos","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-testResult-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getTestResultInfo","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-reports-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getReports","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-photos-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getPhotos","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-pedpred-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getPedPredInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getComponentInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-geometry-info/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getGeometryInformation","parameters":[{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/get-component-detail-info/{compNo}/{testNo}":{"get":{"tags":["component-data-controller"],"operationId":"getComponentDetailInformation","parameters":[{"name":"compNo","in":"path","required":true,"schema":{"type":"string"}},{"name":"testNo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}},"/nhtsa/component/api/v1/component-database-test-results/by-search":{"get":{"tags":["component-data-controller"],"operationId":"findBySearch","parameters":[{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"testNoFrom","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"testNoTo","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"testDateFrom","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"testDateTo","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"occupantType","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"testRefNumber","in":"query","description":"supports pattern search","required":false,"schema":{"type":"string"}},{"name":"testType","in":"query","required":false,"schema":{"type":"string"}},{"name":"contract","in":"query","description":"supports pattern search","required":false,"schema":{"type":"string"}},{"name":"testPerformer","in":"query","required":false,"schema":{"type":"string"}},{"name":"testSpecification","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","enum":["contractorStudyTitle ,testNo ,testPerformer,testReferenceNo,testType"]}},{"name":"count","in":"query","description":"Number of rows to return","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APIResponse"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"APIResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Meta"},"results":{"type":"array","items":{"type":"object"}}}},"Meta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"status":{"type":"integer","format":"int64"},"message":{"type":"string"},"error":{"type":"string"}}},"Pagination":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"currentUrl":{"type":"string"},"nextUrl":{"type":"string"},"previousUrl":{"type":"string"}}}}}}