swagger.json

{"swagger":"2.0","info":{"title":"Florida Business Inspections API","version":"0.3.0","host":"138.197.90.94","schemes":"http","description":"API For Florida Business Inspections Records. It's datasource is Florida Department of Business & Professional Regulation. See http://www.myfloridalicense.com","contact":{"name":"Joel Quiles","email":"quilesbaker@gmail.com","github":"teh0xqb","url":"http://codefor.miami"},"license":{"name":"MIT License","url":"https://choosealicense.com/licenses/mit/"}},"produces":["application/json"],"consumes":["application/json"],"basePath":"","paths":{"/counties":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response484"},"description":"Returns all counties, no pagination."}},"summary":"Retrieve all available counties"}},"/inspections":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response485"},"description":"Returns all Inspections, 20 per page by default."},"422":{"schema":{"$ref":"#/definitions/UnprocessableError"},"description":"Unprocessable Query Parameters provided to inspections endpoint."}},"parameters":[{"in":"query","name":"countyNumber","description":"","required":false,"type":"integer","format":"int64"},{"in":"query","name":"districtCode","description":"","required":false,"type":"integer","format":"int64"},{"in":"query","name":"zipCodes","description":"","required":false,"type":"string"},{"in":"query","name":"startDate","description":"","required":false,"type":"string"},{"in":"query","name":"endDate","description":"","required":false,"type":"string"},{"in":"query","name":"businessName","description":"","required":false,"type":"string"}],"summary":"List Inspections using filters"}},"/inspections/{id}":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response486"},"description":"Individual Inspection Detail"}},"parameters":[{"in":"path","name":"id","description":"","required":true,"type":"integer","format":"int64"}],"summary":"Retrieve one inspection by id; includes violations details"}},"/businesses":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response487"},"description":"Returns all businesses, 20 per page at a time by default."},"422":{"schema":{"$ref":"#/definitions/UnprocessableError"},"description":"Unprocessable Query Parameters provided to businesses endpoint."}},"parameters":[{"in":"query","name":"countyNumber","description":"","required":false,"type":"integer","format":"int64"},{"in":"query","name":"zipCodes","description":"","required":false,"type":"string"},{"in":"query","name":"perPage","description":"","required":false,"type":"integer","format":"int64"},{"in":"query","name":"page","description":"","required":false,"type":"integer","format":"int64"}],"summary":"List businesses using filters"}},"/businesses/{id}":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response488"},"description":"Retrieve one business by id."}},"parameters":[{"in":"path","name":"licenseNumber","description":"","required":true,"type":"integer","format":"int64"}],"summary":"Retrieve individual Business details by id"}},"/violations":{"get":{"responses":{"200":{"schema":{"$ref":"#/definitions/Response489"},"description":"All Violations with their summary."}},"summary":"List violations"}}},"tags":[],"definitions":{"Business":{"type":"object","properties":{"county_number":{"type":"integer","format":"int64"},"location_address":{"type":"string"},"noncritical_violations_before_2013":{"type":"integer","format":"int64"},"license_type_code":{"type":"string"},"business_name":{"type":"string"},"license_number":{"type":"integer","format":"int64"},"location_zipcode":{"type":"string"},"critical_violations_before_2013":{"type":"integer","format":"int64"},"location-city":{"type":"string"},"location_latitude":{"type":"number","format":"double"},"location_longitude":{"type":"number","format":"double"}},"additionalProperties":false,"required":["county_number","location_address","noncritical_violations_before_2013","license_type_code","business_name","license_number","location_zipcode","critical_violations_before_2013","location-city","location_latitude","location_longitude"]},"BusinessMeta":{"type":"object","properties":{"parameters":{"$ref":"#/definitions/Response487MetaParameters"}},"additionalProperties":false,"required":["parameters"]},"County":{"type":"object","properties":{"district":{"type":"string"},"countynumber":{"type":"integer","format":"int64"},"countyname":{"type":"string"},"inspections":{"type":"integer","format":"int64"}},"additionalProperties":false,"required":["district","countynumber","countyname","inspections"]},"Inspection":{"type":"object","properties":{"intermediateViolations":{"type":"integer","format":"int64"},"locationCity":{"type":"string"},"locationAddress":{"type":"string"},"countyName":{"type":"string"},"licenseTypeCode":{"type":"string"},"businessName":{"type":"string"},"locationZipcode":{"type":"string"},"totalViolations":{"type":"integer","format":"int64"},"type":{"type":"string"},"inspectionDisposition":{"type":"string"},"inspectionNumber":{"type":"integer","format":"int64"},"basicViolations":{"type":"integer","format":"int64"},"id":{"type":"string"},"countyNumber":{"type":"integer","format":"int64"},"licenseNumber":{"type":"integer","format":"int64"},"visitNumber":{"type":"integer","format":"int64"},"inspectionType":{"type":"string"},"inspectionDate":{"type":"string"},"highPriorityViolations":{"type":"integer","format":"int64"},"district":{"type":"string"}},"additionalProperties":false,"required":["intermediateViolations","locationCity","locationAddress","countyName","licenseTypeCode","businessName","locationZipcode","totalViolations","type","inspectionDisposition","inspectionNumber","basicViolations","id","countyNumber","licenseNumber","visitNumber","inspectionType","inspectionDate","highPriorityViolations","district"]},"InspectionDetail":{"type":"object","properties":{"intermediateViolations":{"type":"integer","format":"int64"},"locationCity":{"type":"string"},"locationAddress":{"type":"string"},"countyName":{"type":"string"},"licenseTypeCode":{"type":"string"},"businessName":{"type":"string"},"locationZipcode":{"type":"string"},"totalViolations":{"type":"integer","format":"int64"},"type":{"type":"string"},"inspectionDisposition":{"type":"string"},"inspectionNumber":{"type":"integer","format":"int64"},"basicViolations":{"type":"integer","format":"int64"},"nonCriticalViolationsBefore2013":{"type":"integer","format":"int64"},"id":{"type":"string"},"countyNumber":{"type":"integer","format":"int64"},"licenseNumber":{"type":"integer","format":"int64"},"pdaStatus":{"type":"boolean"},"visitNumber":{"type":"integer","format":"int64"},"inspectionType":{"type":"string"},"inspectionDate":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"highPriorityViolations":{"type":"integer","format":"int64"},"criticalViolationsBefore2013":{"type":"integer","format":"int64"},"district":{"type":"string"}},"additionalProperties":false,"required":["intermediateViolations","locationCity","locationAddress","countyName","licenseTypeCode","businessName","locationZipcode","totalViolations","type","inspectionDisposition","inspectionNumber","basicViolations","nonCriticalViolationsBefore2013","id","countyNumber","licenseNumber","pdaStatus","visitNumber","inspectionType","inspectionDate","violations","highPriorityViolations","criticalViolationsBefore2013","district"]},"InspectionsMeta":{"type":"object","properties":{"parameters":{"$ref":"#/definitions/Response485MetaParameters"}},"additionalProperties":false,"required":["parameters"]},"Response484":{"type":"object","properties":{"meta":{"$ref":"#/definitions/Response484Meta"},"data":{"type":"array","items":{"$ref":"#/definitions/County"}}},"additionalProperties":false,"required":["meta","data"]},"Response484Meta":{"type":"object","additionalProperties":false},"Response485":{"type":"object","properties":{"meta":{"$ref":"#/definitions/InspectionsMeta"},"data":{"type":"array","items":{"$ref":"#/definitions/Inspection"}}},"additionalProperties":false,"required":["meta","data"]},"Response485MetaParameters":{"type":"object","properties":{"zipCodes":{"type":"string"},"businessName":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"districtCode":{"type":"string"},"countyNumber":{"type":"integer","format":"int64"},"perPage":{"type":"integer","format":"int64"},"page":{"type":"integer","format":"int64"}},"additionalProperties":false,"required":["zipCodes","businessName","startDate","endDate","districtCode","countyNumber","perPage","page"]},"Response486":{"type":"object","properties":{"meta":{"$ref":"#/definitions/Response486Meta"},"data":{"type":"array","items":{"$ref":"#/definitions/InspectionDetail"}}},"additionalProperties":false,"required":["meta","data"]},"Response486Meta":{"type":"object","additionalProperties":false},"Response487":{"type":"object","properties":{"meta":{"$ref":"#/definitions/BusinessMeta"},"data":{"type":"array","items":{"$ref":"#/definitions/Business"}}},"additionalProperties":false,"required":["meta","data"]},"Response487MetaParameters":{"type":"object","properties":{"zipCodes":{"type":"string"},"countyNumber":{"type":"integer","format":"int64"},"perPage":{"type":"integer","format":"int64"},"page":{"type":"integer","format":"int64"}},"additionalProperties":false,"required":["zipCodes","countyNumber","perPage","page"]},"Response488":{"type":"object","properties":{"meta":{"$ref":"#/definitions/Response488Meta"},"data":{"type":"array","items":{"$ref":"#/definitions/Business"}}},"additionalProperties":false,"required":["meta","data"]},"Response488Meta":{"type":"object","additionalProperties":false},"Response489":{"type":"object","properties":{"meta":{"$ref":"#/definitions/Response489Meta"},"data":{"type":"array","items":{"$ref":"#/definitions/Violation"}}},"additionalProperties":false,"required":["meta","data"]},"Response489Meta":{"type":"object","additionalProperties":false},"UnprocessableError":{"type":"object","properties":{"code":{"type":"integer","format":"int64"},"title":{"type":"string"},"detail":{"type":"string"},"source":{"$ref":"#/definitions/UnprocessableErrorSource"}},"additionalProperties":false,"required":["code","title","detail","source"]},"UnprocessableErrorSource":{"type":"object","properties":{"parameter":{"type":"string"}},"additionalProperties":false,"required":["parameter"]},"Violation":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"description":{"type":"string"},"is_risk_factor":{"type":"boolean"},"is_primary_concern":{"type":"boolean"}},"additionalProperties":false,"required":["id","description","is_risk_factor","is_primary_concern"]}}}