{"info":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","description":"

Welcome to the Streamline API Getting Started Guide. This guide provides a set of API endpoints to support collecting inspection and property information from Streamline Automation. The APIs are sectioned out into public and custom(private). Depending on the access you have been given you may or may not have access to all listed APIs.

Key Features:

Authenticate and get Tokens.
\n
Access detailed information on properties in your installaion.
\n
Access detailed information on property inspections in your installaion.
\n

Support - We're here to help.

Please submit your support request to: support@streamlineas.com. An API support tech will be happy to assist you.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42656329","collectionId":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","publishedId":"2sB2j3DCd6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0483DE"},"publishDate":"2025-08-07T16:19:36.000Z"},"item":[{"name":"Authentication","item":[{"name":"JWT Token Retrieval","id":"e5b4c434-112c-41ea-a55a-f6851caf068c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"outputtype\": \"Json\"\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/REST/AccountService/LoginAndGetJWTToken","description":"\n

This endpoint is used to authenticate and obtain a JWT token for accessing the system. The request should be sent as an HTTP POST to the specified URL.

Request Body

userName (string) - The username of the account.
\n
password (string) - The password of the account.
\n
outputtype (string) - The type of output expected, in this case, it is \"Json\".
\n

Response

Upon a successful request, the server will respond with a status code of 200 and a content type of \"text/Json\". The response body will contain the JWT token under the key \"LoginAndGetJWTTokenResult\".

Example Response:

{\"LoginAndGetJWTTokenResult\":\"<JWT Token>\"}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

This is a result of an incorrect username or password. Please review the credentials in your Welcome Email to ensure you have the correct values.

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

\n","urlObject":{"protocol":"https","path":["Primary","REST","AccountService","LoginAndGetJWTToken"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"8a64f6a3-ee5d-4d8d-8277-0630d3827f9c","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"outputtype\": \"Json\"\r\n}"},"url":"https://process-dev.firerecoveryusa.com/Primary/REST/AccountService/LoginAndGetJWTToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/Json"},{"key":"Date","value":"Tue, 29 Apr 2025 23:27:02 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Content-Encoding","value":"br"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=2592000"},{"key":"X-PlatformServerID","value":"FireRecoveryDev"},{"key":"X-ClusteringMode","value":"False"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://beta.therecoveryhub.com"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"JS-Client-Event-Session-Id","value":"01JT1Y05FXMR5MNYWJ1X3XV79B"}],"cookie":[],"responseTime":null,"body":"{\n \"LoginAndGetJWTTokenResult\": \"\"\n}"},{"id":"7afe90de-bffb-4ff5-b259-80bd041e06cb","name":"401 Not Authorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"outputtype\": \"Json\"\r\n}"},"url":"https://process-dev.firerecoveryusa.com/Primary/REST/AccountService/LoginAndGetJWTToken"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 29 Apr 2025 23:26:10 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-PlatformServerID","value":"FireRecoveryDev"},{"key":"X-ClusteringMode","value":"False"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://beta.therecoveryhub.com"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Done\": {\r\n \"code\": \"401\",\r\n \"error\": \"Username/Password is invalid.\"\r\n }\r\n}\r\n\r\n"},{"id":"fac940c3-fded-46e3-8c65-ba5ca970af50","name":"500 General Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"outputtype\": \"Json\"\r\n}"},"url":"https://process-dev.firerecoveryusa.com/Primary/REST/AccountService/LoginAndGetJWTToken"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"500\",\r\n \t\"error\": \"An unexpected error occurred. Please try again later.\"\r\n\t}\r\n}\r\n"}],"_postman_id":"e5b4c434-112c-41ea-a55a-f6851caf068c"}],"id":"20a0ec03-356b-44cf-9b48-b20379b6562c","description":"

Bearer Token Authentication is used for authentication when accessing methods. To generate a token, the developer will access Generate JWT Token method using Basic Auth providing username \\ password. Developer credentials are sent in the Welcome Message when provided access. Tokens expire in 7 days. It is recommended to generate a token prior to each method call to ensure the token is not expired.

\n","_postman_id":"20a0ec03-356b-44cf-9b48-b20379b6562c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Streamline Inspections API","item":[{"name":"General API","item":[{"name":"Occupancy","item":[{"name":"Get Commercial Occupancies","event":[{"listen":"prerequest","script":{"id":"176a230b-6dca-4c14-bdde-17b3fe52b86e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"01514f99-3651-48d4-af60-00f559196fed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetCommercialOccupancies","description":"

This endpoint makes an HTTP POST request to retrieve commercial occupancies. The request body should include the \"outputtype\" parameter set to \"Json\", \"IsDeleted\" parameter set to \"false\", and \"IsVacantOccupancy\" parameter set to \"false\".

The response of this request can be documented as a JSON schema.

outputtype (string): Specifies the output type for the response.
\n
IsDeleted (boolean): Indicates whether the occupancy is deleted or not.
\n
IsVacantOccupancy (boolean): Indicates whether the occupancy is vacant or not.
\n

Upon successful execution, the API will respond with the relevant commercial occupancy data in the specified output type.

Potential Errors:

Error Response: 401 Unauthorized

Description:

This error indicates the user is not authorized to access the requested resource. This typically occurs when the user has not provided a valid subscription key, Client ID or the provided token is invalid or expired.

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Primary","restapi","","SLI","GeneralAPI","Occupancy","GetCommercialOccupancies"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"afb6514b-c095-4f06-a5cd-3f14c11c2510","name":"Success","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Success","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Done\": {\r\n \"API Response\": {\r\n \"Description\": null,\r\n \"ErrorCode\": null,\r\n \"Status\": 1,\r\n \"Message\": \"Success\"\r\n },\r\n \"CommercialOccupanciesList\": [\r\n {\r\n \"APN\": \"\",\r\n \"TenantId\": \"XX\",\r\n \"RoofCoveringCode\": \"9\",\r\n \"AHJText\": \"10242 - Fire Rescue\",\r\n \"BuildingClassText\": \"000 - Building code occupancy type not applicable\",\r\n \"DistrictText\": \"4 - Inspection District 4\",\r\n \"StructureTypeText\": \"1 - Enclosed building\",\r\n \"BuildingStatusText\": \"2 - In normal use\",\r\n \"MixedUseCode\": \"20\",\r\n \"InspectionDistrictCode\": \"4\",\r\n \"PropertyOwnershipCode\": \"3\",\r\n \"InspectionDistrictText\": null,\r\n \"Latitude\": 26.000000,\r\n \"DetectorTypeCode\": \"\",\r\n \"OccupancyCategoryText\": \"Commercial Property\",\r\n \"StreetSuffix\": \"\",\r\n \"StructureTypeCode\": \"1\",\r\n \"AutomaticExtinguishingText\": null,\r\n \"StreetName\": \"71st\",\r\n \"AutomaticExtinguishingCode\": \"\",\r\n \"StationCode\": \"104\",\r\n \"ComplexMainId\": null,\r\n \"Address2\": \"BLDG 2\",\r\n \"StreetNumber\": \"1234\",\r\n \"DetectorTypeText\": null,\r\n \"isDeletedOccupancy\": false,\r\n \"OccupancyId\": 12345,\r\n \"City\": \"City\",\r\n \"BuildingClassCode\": \"000\",\r\n \"StreetPrefix\": \"SW\",\r\n \"AutomaticExtinguishingNumberOfHeads\": 0,\r\n \"BusinessPermit\": \"\",\r\n \"ConstructionTypeCode\": \"3\",\r\n \"DetectorPresentCode\": \"0\",\r\n \"OccupancyCategoryId\": 1,\r\n \"DistrictCode\": \"4\",\r\n \"DetectorPowerCode\": \"\",\r\n \"StationText\": \"104 - Station 104\",\r\n \"ConstructionCompletedDate\": null,\r\n \"AHJCode\": \"10242\",\r\n \"LastInspectionId\": 2268190,\r\n \"NumberOfUnits\": 50,\r\n \"OccupancyCreationDate\": \"2015-06-09T22:47:52.74\",\r\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\r\n \"DetectorPowerText\": null,\r\n \"RoofCoveringText\": \"9 - Roof Covering Not Class\",\r\n \"ClientPropertyId\": \"000027\",\r\n \"OccupancyNotes\": \"\",\r\n \"DefaultInspectionTypeText\": null,\r\n \"StreetType\": \"Ter\",\r\n \"isMergedOccupancy\": false,\r\n \"OccupancyOccupantLoad\": 50,\r\n \"OccupancySquarefoot\": 5362,\r\n \"PropertyOwnershipText\": \"3 - County or parish\",\r\n \"FloorsBelowGround\": 0,\r\n \"BuildingStatusCode\": \"2\",\r\n \"Longitude\": -80.000000,\r\n \"OccupancyName\": \"Occupancy Name\",\r\n \"FixedPropertyUseText\": \"241 - Adult education center, college classroom\",\r\n \"ZipCode\": \"Zip Code\",\r\n \"FixedPropertyUseCode\": \"241\",\r\n \"FloorsAboveGround\": 6,\r\n \"ConstructionTypeText\": \"3 - Protected Non-combustible\",\r\n \"MixedUseText\": \"20 - Educational use\",\r\n \"ZoneText\": \"1045 - 1045\",\r\n \"DefaultInspectionTypeCode\": null,\r\n \"LastInspectionDate\": \"2024-04-09T15:14:20.12\",\r\n \"AutomaticExtinguishingTypeCode\": \"1\",\r\n \"ZoneCode\": \"1045\",\r\n \"DetectorPresentText\": \"0 - None Present\",\r\n \"isVacantOccupancy\": false,\r\n \"State\": \"XX\"\r\n }\r\n ]\r\n }\r\n}\r\n "},{"id":"c64eaf6e-48c9-4250-b076-9e3487086829","name":"401 Unauthorized Key","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Unauthorized Key","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"401\",\r\n \t\"error\": \"Invalid Subscription Key\"\r\n\t}\r\n}\r\n"},{"id":"047c91ef-8f90-47f1-b2ac-d86c2fb60628","name":"401 Unauthorized Client ID","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Done\": {\r\n \"API Response\": {\r\n \"Description\": null,\r\n \"ErrorCode\": \"401\",\r\n \"Status\": 0,\r\n \"Message\": \"Invalid Client Id\"\r\n },\r\n \"CommercialOccupancy\": []\r\n }\r\n}"},{"id":"05b137ec-e9b3-403c-a558-422ccbe27150","name":"401 Unauthorized JWT","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Unauthorized JWT","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"401\",\r\n \t\"error\": \"Could not validate JWT\"\r\n\t}\r\n}\r\n"},{"id":"9e56af0b-918a-4eaa-8770-15b12bc9ca98","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"500\",\r\n \t\"error\": \"An unexpected error occurred. Please try again later.\"\r\n\t}\r\n}\r\n"}],"_postman_id":"01514f99-3651-48d4-af60-00f559196fed"},{"name":"Get Commercial Occupancy","event":[{"listen":"prerequest","script":{"id":"eaffce45-ae21-471d-a075-38dac5557339","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8966c855-d7a0-487d-a489-0a88dc95a060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"OccupancyId\": 319350\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occuancy/GetCommercialOccupancy","description":"

This endpoint makes an HTTP POST request to {{collectionSchemaUrl}}/SLI/GeneralAPI/Occuancy/GetCommercialOccupancy to retrieve commercial occupancy data. The request body should be in raw format and include the \"outputtype\" parameter set to \"Json\" and the \"OccupancyId\" parameter set to the desired value.

Request Body

outputtype: (string) The type of output, set to \"Json\".
\n
OccupancyId: (number) The ID of the occupancy, set to 0.
\n

Response

Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the following structure:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": \"\",\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"CommercialOccupancy\": []\n    }\n}\n\n

Done: Indicates the completion of the API call.
\n
API Response: Contains information about the API response, including the description, error code, status, and message.
\n
CommercialOccupancy: An array containing the commercial occupancy data retrieved.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Primary","restapi","","SLI","GeneralAPI","Occuancy","GetCommercialOccupancy"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"37ba7b9b-941b-4440-ae2b-33052f239c1a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"OccupancyId\": 000027\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occuancy/GetCommercialOccupancy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Done\": {\r\n \"API Response\": {\r\n \"Description\": null,\r\n \"ErrorCode\": null,\r\n \"Status\": 1,\r\n \"Message\": \"Success\"\r\n },\r\n \"CommercialOccupancy\": [\r\n {\r\n \"TenantId\": 99,\r\n \"DetectorPowerCode\": \"\",\r\n \"FloorsAboveGround\": 6,\r\n \"DetectorPresentCode\": \"0\",\r\n \"AutomaticExtinguishingNumberOfHeads\": 0,\r\n \"FixedPropertyUseCode\": \"241\",\r\n \"APN\": \"\",\r\n \"DetectorTypeText\": null,\r\n \"City\": \"City\",\r\n \"State\": \"XX\",\r\n \"AutomaticExtinguishingTypeCode\": \"1\",\r\n \"MixedUseText\": \"20 - Educational use\",\r\n \"DistrictText\": \"4 - Inspection District 4\",\r\n \"InspectionDistrictCode\": \"4\",\r\n \"DetectorPresentText\": \"0 - None Present\",\r\n \"StationText\": \"104 - Station 104\",\r\n \"ZipCode\": \"33314-1107\",\r\n \"OccupancyCategoryText\": \"Commercial Property\",\r\n \"ConstructionTypeText\": \"3 - Protected Non-combustible\",\r\n \"OccupancySquarefoot\": 5362,\r\n \"AutomaticExtinguishingText\": null,\r\n \"OccupancyId\": 30362,\r\n \"isMergedOccupancy\": false,\r\n \"AHJCode\": \"10242\",\r\n \"DetectorTypeCode\": \"\",\r\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\r\n \"LastInspectionDate\": \"2024-04-09T15:14:20.12\",\r\n \"PropertyOwnershipText\": \"3 - County or parish\",\r\n \"BusinessPermit\": \"\",\r\n \"BuildingClassCode\": \"000\",\r\n \"ConstructionTypeCode\": \"3\",\r\n \"FloorsBelowGround\": 0,\r\n \"ConstructionCompletedDate\": null,\r\n \"StreetName\": \"71st\",\r\n \"OccupancyOccupantLoad\": 50,\r\n \"LastInspectionId\": 2268190,\r\n \"Address2\": \"BLDG 2\",\r\n \"StreetNumber\": \"1234\",\r\n \"DetectorPowerText\": null,\r\n \"StreetType\": \"Ter\",\r\n \"StreetPrefix\": \"SW\",\r\n \"MixedUseCode\": \"20\",\r\n \"AutomaticExtinguishingCode\": \"\",\r\n \"OccupancyName\": \"Occupancy Name\",\r\n \"DistrictCode\": \"4\",\r\n \"isVacantOccupancy\": false,\r\n \"FixedPropertyUseText\": \"241 - Adult education center, college classroom\",\r\n \"RoofCoveringCode\": \"9\",\r\n \"DefaultInspectionTypeCode\": null,\r\n \"StructureTypeText\": \"1 - Enclosed building\",\r\n \"DefaultInspectionTypeText\": null,\r\n \"OccupancyCategoryId\": 1,\r\n \"Longitude\": -80.0000000,\r\n \"BuildingStatusText\": \"2 - In normal use\",\r\n \"NumberOfUnits\": 50,\r\n \"StructureTypeCode\": \"1\",\r\n \"InspectionDistrictText\": null,\r\n \"ClientPropertyId\": \"000027\",\r\n \"PropertyOwnershipCode\": \"3\",\r\n \"StationCode\": \"104\",\r\n \"OccupancyNotes\": \"Occupancy Notes\",\r\n \"ZoneCode\": \"1045\",\r\n \"AHJText\": \"10242 - Fire Rescue\",\r\n \"ZoneText\": \"1045 - 1045\",\r\n \"StreetSuffix\": \"\",\r\n \"Latitude\": 26.087668,\r\n \"BuildingClassText\": \"000 - Building code occupancy type not applicable\",\r\n \"ComplexMainId\": null,\r\n \"RoofCoveringText\": \"9 - Roof Covering Not Class\",\r\n \"OccupancyCreationDate\": \"2015-06-09T22:47:52.74\",\r\n \"BuildingStatusCode\": \"2\",\r\n \"isDeletedOccupancy\": false\r\n }\r\n ]\r\n }\r\n}"},{"id":"b3035cf5-2a98-4041-9686-e6d5160ac437","name":"401 Unauthorized Key","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancy"},"status":"Unauthorized Key","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"401\",\r\n \t\"error\": \"Invalid Subscription Key\"\r\n\t}\r\n}\r\n"},{"id":"2f8161bc-fc93-4e29-a678-c231289af129","name":"401 Unauthorized Client ID","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancy"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Done\": {\r\n \"API Response\": {\r\n \"Description\": null,\r\n \"ErrorCode\": \"401\",\r\n \"Status\": 0,\r\n \"Message\": \"Invalid Client Id\"\r\n },\r\n \"CommercialOccupancy\": []\r\n }\r\n}"},{"id":"3c4b166d-8fb7-4d46-b4e6-43ae1015efd0","name":"401 Unauthorized JWT","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancy"},"status":"Unauthorized JWT","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"401\",\r\n \t\"error\": \"Could not validate JWT\"\r\n\t}\r\n}\r\n"},{"id":"9b94588e-5e4c-4226-a4ec-32f092e1d13d","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacantOccupancy\": false\r\n}"},"url":"{{collectionSchemaUrl}}/SLI/GeneralAPI/Occupancy/GetCommercialOccupancies"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"Done\": \r\n {\r\n \t\"code\": \"500\",\r\n \t\"error\": \"An unexpected error occurred. Please try again later.\"\r\n\t}\r\n}\r\n"}],"_postman_id":"8966c855-d7a0-487d-a489-0a88dc95a060"},{"name":"Get Residential Occupancies","event":[{"listen":"prerequest","script":{"id":"36281c50-180f-41de-9f21-a619b346789a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3bd092bb-b5b4-40ff-aa35-79502efb269d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsVacant\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetResidentialOccupancies","description":"

Get Residential Occupancies

This endpoint makes an HTTP POST request to retrieve residential occupancies.

Request Body

outputtype (text): Specifies the output type.
\n
IsDeleted (text): Indicates if the occupancy is deleted.
\n
IsVacant (text): Indicates if the occupancy is vacant.
\n

Response

The response is in JSON format and has the following schema:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": \"\",\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"ResidentialOccupanciesList\": []\n    }\n}\n\n

This endpoint makes an HTTP POST request to retrieve residential occupancies.

Request Body

outputtype: (text) The type of output required, in this case, set to \"Json\".
\n
IsDeleted: (text) A boolean flag indicating whether the occupancy is deleted.
\n
IsVacant: (text) A boolean flag indicating whether the occupancy is vacant.
\n

Response

Upon successful execution, the response will have a status code of 200 and a content type of application/json. The response body will contain the following structure:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": \"\",\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"ResidentialOccupanciesList\": []\n    }\n}\n\n

The ResidentialOccupanciesList array will contain the list of residential occupancies retrieved based on the provided criteria.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This endpoint makes an HTTP POST request to retrieve residential occupancy information. The request should include the \"outputtype\" parameter with the value \"Json\" and the \"OccupancyId\" parameter with the desired occupancy ID.

Request Body

outputtype (string): The desired output type, should be set to \"Json\".
\n
OccupancyId (integer): The ID of the occupancy for which information is requested.
\n

Response Body

The response will contain the relevant residential occupancy information.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Method endpoints for Commercial and Residential Occupancy information.

\n","_postman_id":"82466515-6cee-4789-b954-938979827bb1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Complex","item":[{"name":"Get Complexes","event":[{"listen":"prerequest","script":{"id":"7bb242a4-7cd0-4967-a1bc-1bfd7328ad90","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7a0a65b7-19bd-4e0a-b64c-d83d3e58ce00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Complex/GetComplexes","description":"

This endpoint makes an HTTP POST request to retrieve a list of complexes. The request payload includes the \"outputtype\" parameter set to \"Json\" and the \"IsDeleted\" parameter set to \"false\".

Response

The response of this request is a JSON schema representing the data structure of the complexes. The schema will define the properties and their data types for the complex objects returned by the API.

outputtype: (string) Specifies the type of output required, in this case, it should be set to \"Json\".
\n
IsDeleted: (boolean) Indicates whether the complex has been deleted, with a value of \"false\" to retrieve active complexes.
\n

The response will contain the relevant information about the complexes based on the provided request parameters.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Get Complex API

This API endpoint makes an HTTP POST request to retrieve complex information. The request should include the clientId and subscriptionkey as query parameters.

Request Body

outputtype: The type of output required, in this case, it is set to \"Json\".
\n
ComplexId: The ID of the complex for which information is requested.
\n

Response

The response will include the details of the complex in the specified format.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Method endpoints for Building Complex information.

\n","_postman_id":"8868e0de-8929-4d2f-97c1-0b4216394ca5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Inspections","item":[{"name":"Get Commercial Occupancy Inspections","event":[{"listen":"prerequest","script":{"id":"08a2e388-895d-4cc5-9067-fbd0c70f7666","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"190e9e5b-5712-45ef-bfec-f8a6d4c78d57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"CommercialOccupancyInspectionsRequest\": {\r\n \"FiscalYearId\": 0,\r\n \"OccupancyId\": 0,\r\n \"InspectionSeriesId\": 0,\r\n \"InspectionStatusId\": [ \r\n 3\r\n ],\r\n \"IsDeleted\": false,\r\n \"IsVacant\": false\r\n }\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Inspection/GetCommercialOccupancyInspections","description":"

Get Commercial Occupancy Inspections

This endpoint is used to retrieve commercial occupancy inspections based on the provided criteria.

Request Body

outputtype (string) - The type of output required, in this case, it is \"Json\".
\n
CommercialOccupancyInspectionsRequest (object) - The request object containing the following parameters:
\n
- FiscalYearId (integer) - The fiscal year ID for filtering inspections.
  \n
- OccupancyId (integer) - The occupancy ID for filtering inspections.
  \n
- InspectionSeriesId (integer) - The inspection series ID for filtering inspections.
  \n
- InspectionStatusId (array) - An array of inspection status IDs for filtering inspections.
  \n
- IsDeleted (boolean) - Indicates if the inspection is deleted or not.
  \n
- IsVacant (boolean) - Indicates if the occupancy is vacant or not.
  \n
\n

Response

The response will contain the following fields:

Done (object) - The status of the API response.
\n
- API Response (object) - Details of the API response.
  \n
  - Description (string) - Description of the response.
    \n
  - ErrorCode (string) - Error code, if any.
    \n
  - Status (integer) - The status of the response.
    \n
  - Message (string) - Any additional message related to the response.
    \n
  \n
- Result (array) - An array of inspection details.
  \n
  - PreviousInspectionId (integer) - The previous inspection ID.
    \n
  - InspectionReportSent (boolean) - Indicates if the inspection report is sent.
    \n
  - InspectionStartDate (string) - The start date of the inspection.
    \n
  - ... (other inspection details)
    \n
  \n
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Example Response

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"Result\": [\n            {\n                \"PreviousInspectionId\": 0,\n                \"InspectionReportSent\": true,\n                \"InspectionStartDate\": \"\",\n                \"FiscalYearId\": 0,\n                \"InspectionCategoryId\": 0,\n                \"ContactId\": 0,\n                \"InspectionSeriesId\": 0,\n                \"InspectionStatusText\": \"\",\n                \"InspectionBillingYear\": null,\n                \"InspectionCompletedDate\": \"\",\n                \"InspectionNumber\": 0,\n                \"InspectionId\": 0,\n                \"InspectionTime\": 0,\n                \"ComplexId\": null,\n                \"InspectorFirstName\": \"\",\n                \"InspectionTotalFee\": 0,\n                \"InspectionScheduledDate\": \"\",\n                \"InspectionDeleted\": true,\n                \"TenantId\": 0,\n                \"InspectorLastName\": \"\",\n                \"InspectionApprovalUserAccountId\": 0,\n                \"InspectionOriginalScheduledDate\": \"\",\n                \"InspectionComplexResponsible\": true,\n                \"InspectionReceivedDate\": \"\",\n                \"InspectionSignedBy\": \"\",\n                \"FiscalYearText\": \"\",\n                \"OccupancyIdId\": 0,\n                \"InspectionTypeId\": 0,\n                \"InspectorId\": 0,\n                \"InspectionTypeText\": \"\",\n                \"InspectionAccountId\": 0,\n                \"InspectionRequireEntry\": true,\n                \"InspectionCategoryText\": \"\",\n                \"InspectionStatusId\": 0,\n                \"InspectionTemplateId\": 0,\n                \"InspectionNumberOfUnits\": 0,\n                \"InspectionNote\": \"\",\n                \"InspectionReviewTime\": 0,\n                \"InspectionFee\": 0,\n                \"InspectionSqft\": 0,\n                \"InspectionTemplateText\": \"\",\n                \"InspectionIsVacant\": true,\n                \"ComplexInspectionId\": null,\n                \"InspectionNeedsApproval\": true,\n                \"InspectionAccountText\": \"\",\n                \"ClientPropertyId\": \"\"\n            }\n        ]\n    }\n}\n\n

Get Commercial Occupancy Inspections

This endpoint is used to retrieve commercial occupancy inspections based on the provided criteria.

Request Body

outputtype (string) - The type of output required, in this case, it is \"Json\".
\n
CommercialOccupancyInspectionsRequest (object) - The request object containing the following parameters:
\n
- OccupancyId (integer) - The occupancy ID for filtering inspections.
\n

Response

The response will contain the following fields:

Done (object) - The status of the API response.
\n
- API Response (object) - Details of the API response.
  \n
  - Description (string) - Description of the response.
    \n
  - ErrorCode (string) - Error code, if any.
    \n
  - Status (integer) - The status of the response.
    \n
  - Message (string) - Any additional message related to the response.
    \n
  \n
- Result (array) - An array of inspection details.
  \n
  - PreviousInspectionId (integer) - The previous inspection ID.
    \n
  - InspectionReportSent (boolean) - Indicates if the inspection report is sent.
    \n
  - InspectionStartDate (string) - The start date of the inspection.
    \n
  - ... (other inspection details)
    \n
  \n
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Example Response

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"Result\": [\n            {\n                \"PreviousInspectionId\": 0,\n                \"InspectionReportSent\": true,\n                \"InspectionStartDate\": \"\",\n                \"FiscalYearId\": 0,\n                \"InspectionCategoryId\": 0,\n                \"ContactId\": 0,\n                \"InspectionSeriesId\": 0,\n                \"InspectionStatusText\": \"\",\n                \"InspectionBillingYear\": null,\n                \"InspectionCompletedDate\": \"\",\n                \"InspectionNumber\": 0,\n                \"InspectionId\": 0,\n                \"InspectionTime\": 0,\n                \"ComplexId\": null,\n                \"InspectorFirstName\": \"\",\n                \"InspectionTotalFee\": 0,\n                \"InspectionScheduledDate\": \"\",\n                \"InspectionDeleted\": true,\n                \"TenantId\": 0,\n                \"InspectorLastName\": \"\",\n                \"InspectionApprovalUserAccountId\": 0,\n                \"InspectionOriginalScheduledDate\": \"\",\n                \"InspectionComplexResponsible\": true,\n                \"InspectionReceivedDate\": \"\",\n                \"InspectionSignedBy\": \"\",\n                \"FiscalYearText\": \"\",\n                \"OccupancyIdId\": 0,\n                \"InspectionTypeId\": 0,\n                \"InspectorId\": 0,\n                \"InspectionTypeText\": \"\",\n                \"InspectionAccountId\": 0,\n                \"InspectionRequireEntry\": true,\n                \"InspectionCategoryText\": \"\",\n                \"InspectionStatusId\": 0,\n                \"InspectionTemplateId\": 0,\n                \"InspectionNumberOfUnits\": 0,\n                \"InspectionNote\": \"\",\n                \"InspectionReviewTime\": 0,\n                \"InspectionFee\": 0,\n                \"InspectionSqft\": 0,\n                \"InspectionTemplateText\": \"\",\n                \"InspectionIsVacant\": true,\n                \"ComplexInspectionId\": null,\n                \"InspectionNeedsApproval\": true,\n                \"InspectionAccountText\": \"\",\n                \"ClientPropertyId\": \"\"\n            }\n        ]\n    }\n}\n\n

The valid values for Inspection Status Id Array are as follows:

1 (Not Assigned)
\n
2 (Not Completed or Scheduled)
\n
3 (Completed)
\n
4 (In progress)
\n
5 (Closed Out)
\n
Return an empty array to return all statuses
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Get Commercial Occupancy Inspections By Date

This endpoint allows you to retrieve commercial occupancy inspections within a specified date range.

Request Body

outputtype: The format in which the output is required (e.g. \"Json\").
\n
Request: The request object containing:
\n
- StartDate: The start date for the inspections (e.g. \"{{DateFrom}}\").
  \n
- EndDate: The end date for the inspections (e.g. \"{{DateTo}}\").
  \n
- InspectionStatusId: An array of inspection status IDs to filter the inspections (e.g. [3]).
  \n
\n

Response

The response will include:

Done: Indicates the completion status of the API response.
\n
API Response: Contains the description, error code, status, and message of the API response.
\n
CommercialOccupancyInspections: An array of commercial occupancy inspections, each containing detailed information such as inspection ID, status, completion date, inspector details, and more.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Example response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"CommercialOccupancyInspections\": [\n      {\n        \"InspectionNeedsApproval\": true,\n        \"InspectionCategoryId\": 0,\n        \"FiscalYearId\": 0,\n        \"InspectionId\": 0,\n        \"InspectionNote\": \"\",\n        ...\n        // Additional inspection details\n      }\n    ]\n  }\n}\n\n

Get Complex Inspection

This endpoint allows you to retrieve complex inspection details.

Request Body

outputtype (string) - The type of output required.
\n
InspectionId (number) - The ID of the inspection.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is a JSON object with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ComplexInspectionList\": [\n      {\n        \"PreviousInspectionId\": 0,\n        \"ComplexId\": 0,\n        \"InspectionScheduled\": \"\",\n        \"InspectionFee\": 0,\n        \"InspectionCompleted\": \"\",\n        \"InspectorId\": 0,\n        \"InspectionNumberOfUnits\": 0,\n        \"InspectionAccountText\": \"\",\n        \"InspectionStatusText\": \"\",\n        \"InspectionAccountId\": 0,\n        \"InspectionSeriesId\": 0,\n        \"InvoiceTotalFee\": null,\n        \"InspectionBillingYear\": \"\",\n        \"InspectionReceived\": \"\",\n        \"InspectionStatusId\": 0,\n        \"ContactId\": 0,\n        \"FiscalYearId\": 0,\n        \"TenantId\": 0,\n        \"InspectionDeleted\": true,\n        \"InspectionId\": 0,\n        \"InspectionNote\": \"\",\n        \"InspectionNumber\": 0,\n        \"FiscalYearText\": \"\",\n        \"InspectorLastName\": \"\",\n        \"InspectorFirstName\": \"\"\n      }\n    ]\n  }\n}\n\n

Get Complex Inspections By Date

This endpoint allows you to retrieve complex inspections based on a specified date range.

Request Body

outputtype (text) - The type of output required, in this case \"Json\".
\n
Request (text) - The request object containing:
\n
- InspectionStatusId (text) - An array of inspection status IDs.
  \n
- StartDate (text) - The start date for the inspection search.
  \n
- EndDate (text) - The end date for the inspection search.
  \n
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be in JSON format and will include the following fields:

Done (object) - The status of the API response.
\n
- API Response (object) - Details of the API response.
  \n
  - Description (null) - Description of the response.
    \n
  - ErrorCode (null) - Error code, if any.
    \n
  - Status (number) - The status of the response.
    \n
  - Message (text) - Any additional message related to the response.
    \n
  \n
- ComplexInspectionList (array) - List of complex inspections with the following properties:
  \n
  - PreviousInspectionId (number) - ID of the previous inspection.
    \n
  - ComplexId (number) - ID of the complex.
    \n
  - InspectionScheduled (text) - Scheduled date for inspection.
    \n
  - InspectionFee (number) - Fee for the inspection.
    \n
  - InspectionCompleted (text) - Date when the inspection was completed.
    \n
  - InspectorId (number) - ID of the inspector.
    \n
  - InspectionNumberOfUnits (number) - Number of units for inspection.
    \n
  - InspectionAccountText (text) - Text related to inspection account.
    \n
  - InspectionStatusText (text) - Text related to inspection status.
    \n
  - InspectionAccountId (number) - ID of the inspection account.
    \n
  - InspectionSeriesId (number) - ID of the inspection series.
    \n
  - InvoiceTotalFee (null) - Total fee in the invoice.
    \n
  - InspectionBillingYear (text) - Billing year for the inspection.
    \n
  - InspectionReceived (text) - Date when the inspection was received.
    \n
  - InspectionStatusId (number) - ID of the inspection status.
    \n
  - ContactId (number) - ID of the contact.
    \n
  - FiscalYearId (number) - ID of the fiscal year.
    \n
  - TenantId (number) - ID of the tenant.
    \n
  - InspectionDeleted (boolean) - Indicates if the inspection is deleted.
    \n
  - InspectionId (number) - ID of the inspection.
    \n
  - InspectionNote (text) - Note related to the inspection.
    \n
  - InspectionNumber (number) - Inspection number.
    \n
  - FiscalYearText (text) - Text related to fiscal year.
    \n
  - InspectorLastName (text) - Last name of the inspector.
    \n
  - InspectorFirstName (text) - First name of the inspector.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ComplexInspectionList\": [\n      {\n        \"PreviousInspectionId\": 0,\n        \"ComplexId\": 0,\n        \"InspectionScheduled\": \"\",\n        \"InspectionFee\": 0,\n        \"InspectionCompleted\": \"\",\n        \"InspectorId\": 0,\n        \"InspectionNumberOfUnits\": 0,\n        \"InspectionAccountText\": \"\",\n        \"InspectionStatusText\": \"\",\n        \"InspectionAccountId\": 0,\n        \"InspectionSeriesId\": 0,\n        \"InvoiceTotalFee\": null,\n        \"InspectionBillingYear\": \"\",\n        \"InspectionReceived\": \"\",\n        \"InspectionStatusId\": 0,\n        \"ContactId\": 0,\n        \"FiscalYearId\": 0,\n        \"TenantId\": 0,\n        \"InspectionDeleted\": true,\n        \"InspectionId\": 0,\n        \"InspectionNote\": \"\",\n        \"InspectionNumber\": 0,\n        \"FiscalYearText\": \"\",\n        \"InspectorLastName\": \"\",\n        \"InspectorFirstName\": \"\"\n      }\n    ]\n  }\n}\n\n

Get Complex Inspections

This endpoint is used to retrieve complex inspections based on the provided parameters.

Request Body

outputtype (string) - The type of output required.
\n
Request (object)
\n
- ComplexId (number) - The ID of the complex for which inspections are to be retrieved.
  \n
- InspectionSeriesId (number) - The ID of the inspection series.
  \n
- InspectionStatusId (array) - An array of inspection status IDs.
  \n
- FiscalYearId (number) - The fiscal year ID.
  \n
- IsDeleted (boolean) - Indicates if the inspection is deleted or not.
  \n
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be in JSON format with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ComplexInspectionList\": [\n      {\n        \"PreviousInspectionId\": 0,\n        \"ComplexId\": 0,\n        \"InspectionScheduled\": \"\",\n        \"InspectionFee\": 0,\n        \"InspectionCompleted\": \"\",\n        \"InspectorId\": 0,\n        \"InspectionNumberOfUnits\": 0,\n        \"InspectionAccountText\": \"\",\n        \"InspectionStatusText\": \"\",\n        \"InspectionAccountId\": 0,\n        \"InspectionSeriesId\": 0,\n        \"InvoiceTotalFee\": 0,\n        \"InspectionBillingYear\": \"\",\n        \"InspectionReceived\": \"\",\n        \"InspectionStatusId\": 0,\n        \"ContactId\": 0,\n        \"FiscalYearId\": 0,\n        \"TenantId\": 0,\n        \"InspectionDeleted\": true,\n        \"InspectionId\": 0,\n        \"InspectionNote\": \"\",\n        \"InspectionNumber\": 0,\n        \"FiscalYearText\": \"\",\n        \"InspectorLastName\": \"\",\n        \"InspectorFirstName\": \"\"\n      }\n    ]\n  }\n}\n\n

Method endpoints for Commercial and Building Complex inspections.

\n","_postman_id":"fdfb1ad8-e931-4020-ace6-bca31c4cd3fc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Permits","item":[],"id":"b0a67b4d-a67d-43bc-957f-7b8cf17ce341","description":"

Method endpoints for Commercial Occupancy permits.

Currently under construction.

\n","_postman_id":"b0a67b4d-a67d-43bc-957f-7b8cf17ce341","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Risk Management","item":[{"name":"Backup Power Systems","item":[{"name":"Get BackupPowerSystems","event":[{"listen":"prerequest","script":{"id":"b01af7d0-adb5-4a84-85e5-792084151940","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a88b3bb0-250a-4be4-be8f-9d92041e188a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetBackupsPowerSystems","description":"

POST /SLI/GeneralAPI/Risk/GetBackupsPowerSystems

This endpoint is used to retrieve backup power systems related information.

Request Body

outputtype (text, required): The type of output, in this case \"Json\".
\n
IsDeleted (text, required): Indicates whether the backup power system is deleted, in this case \"false\".
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is in JSON format and follows the schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Done\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"API Response\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"Description\": { \"type\": \"null\" },\n            \"ErrorCode\": { \"type\": \"null\" },\n            \"Status\": { \"type\": \"number\" },\n            \"Message\": { \"type\": \"string\" }\n          }\n        },\n        \"BackupPowerList\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"BackupPowerTransferTypeCode\": { \"type\": \"string\" },\n              \"BackupPowerTypeText\": { \"type\": \"string\" },\n              \"BackupPowerFuelTypeCode\": { \"type\": \"string\" },\n              \"BackupPowerFuelTypeText\": { \"type\": \"string\" },\n              \"BackupPowerTypeCode\": { \"type\": \"string\" },\n              \"BackupPowerId\": { \"type\": \"number\" },\n              \"BackupPowerTransferTypeText\": { \"type\": \"string\" },\n              \"BackupPowerNote\": { \"type\": \"string\" },\n              \"OccupancyId\": { \"type\": \"number\" },\n              \"BackupPowerDeleted\": { \"type\": \"boolean\" },\n              \"TenantId\": { \"type\": \"number\" },\n              \"BackupPowerText\": { \"type\": \"string\" }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n\n

Get Backup Power System

This API endpoint makes an HTTP POST request to retrieve backup power system information.

Request Body

outputtype (text): Specifies the type of output required.
\n
OccupancyId (text): The ID of the occupancy for which backup power system information is requested.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The API returns a JSON object with the following structure:

Done (object)
\n
- API Response (object)
  \n
  - Description (null): Description of the API response.
    \n
  - ErrorCode (null): Error code, if any.
    \n
  - Status (0): Status of the response.
    \n
  - Message (\"\"): Additional message, if any.
    \n
  \n
- BackupPowerList (array)
  \n
  - BackupPowerTransferTypeCode (string): Code for backup power transfer type.
    \n
  - BackupPowerTypeText (string): Text description of backup power type.
    \n
  - BackupPowerFuelTypeCode (string): Code for backup power fuel type.
    \n
  - BackupPowerFuelTypeText (string): Text description of backup power fuel type.
    \n
  - BackupPowerTypeCode (string): Code for backup power type.
    \n
  - BackupPowerId (number): ID of the backup power system.
    \n
  - BackupPowerTransferTypeText (string): Text description of backup power transfer type.
    \n
  - BackupPowerNote (string): Additional notes for the backup power system.
    \n
  - OccupancyId (number): ID of the occupancy.
    \n
  - BackupPowerDeleted (boolean): Indicates if the backup power system is deleted.
    \n
  - TenantId (number): ID of the tenant.
    \n
  - BackupPowerText (string): Text description of the backup power system.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"BackupPowerList\": [\n      {\n        \"BackupPowerTransferTypeCode\": \"\",\n        \"BackupPowerTypeText\": \"\",\n        \"BackupPowerFuelTypeCode\": \"\",\n        \"BackupPowerFuelTypeText\": \"\",\n        \"BackupPowerTypeCode\": \"\",\n        \"BackupPowerId\": 0,\n        \"BackupPowerTransferTypeText\": \"\",\n        \"BackupPowerNote\": \"\",\n        \"OccupancyId\": 0,\n        \"BackupPowerDeleted\": true,\n        \"TenantId\": 0,\n        \"BackupPowerText\": \"\"\n      }\n    ]\n  }\n}\n\n

Method endpoints for Commercial Occupancy Backup Power Systems.

\n","_postman_id":"008f381e-af85-446c-82c4-f7e23524baac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Building System","item":[{"name":"Get Building Systems","event":[{"listen":"prerequest","script":{"id":"60722b57-b895-470b-9c20-fc36ca3c5e28","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ab488fcb-e2be-475a-b43c-4ca20ccab330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetBuildingSystems","description":"

Get Building Systems

This endpoint is used to retrieve a list of building systems.

Request

Method: POST
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetBuildingSystems
\n
Body:
\n
- outputtype (text): The type of output required, in this case, \"Json\".
  \n
- IsDeleted (text): Indicates whether the building system is deleted, in this case, \"false\".
  \n
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be a JSON object with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"BuildingSystemList\": [\n      {\n        \"BuildingSystemText\": \"\",\n        \"BuildingSystemTypeId\": 0,\n        \"BuildingSystemTypeText\": \"\",\n        \"BuildingSystemId\": 0,\n        \"BuildingSystemInformationNote\": \"\",\n        \"BuildingSystemOperationNote\": \"\",\n        \"TenantId\": 0,\n        \"BuildingSystemDeleted\": true,\n        \"OccupancyId\": 0\n      }\n    ]\n  }\n}\n\n

Get Building System

This endpoint is used to retrieve building system information based on the provided occupancy ID.

Request Body

outputtype (text): The type of output required, in this case, it is \"Json\".
\n
OccupancyId (text): The ID of the occupancy for which the building system information is requested.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Done (object)
\n
- API Response (object)
  \n
  - Description (text): Description of the response.
    \n
  - ErrorCode (text): Error code, if any.
    \n
  - Status (number): Status of the response.
    \n
  - Message (text): Additional message, if any.
    \n
  \n
- BuildingSystemList (array)
  \n
  - BuildingSystemText (text): Text related to the building system.
    \n
  - BuildingSystemTypeId (number): ID of the building system type.
    \n
  - BuildingSystemTypeText (text): Text related to the building system type.
    \n
  - BuildingSystemId (number): ID of the building system.
    \n
  - BuildingSystemInformationNote (text): Note related to building system information.
    \n
  - BuildingSystemOperationNote (text): Note related to building system operation.
    \n
  - TenantId (number): ID of the tenant.
    \n
  - BuildingSystemDeleted (boolean): Indicates if the building system is deleted.
    \n
  - OccupancyId (number): ID of the occupancy.
    \n
  \n
\n

Example

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"BuildingSystemList\": [\n            {\n                \"BuildingSystemText\": \"\",\n                \"BuildingSystemTypeId\": 0,\n                \"BuildingSystemTypeText\": \"\",\n                \"BuildingSystemId\": 0,\n                \"BuildingSystemInformationNote\": \"\",\n                \"BuildingSystemOperationNote\": \"\",\n                \"TenantId\": 0,\n                \"BuildingSystemDeleted\": true,\n                \"OccupancyId\": 0\n            }\n        ]\n    }\n}\n\n

Method endpoints for Commercial Occupancy Building Systems.

\n","_postman_id":"1c3691ce-bd3f-4712-bb9d-d2c3be126d0b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Access","item":[{"name":"Get Department Accesses","event":[{"listen":"prerequest","script":{"id":"aebabfdd-424c-4e7e-bbeb-63d210b3d2ae","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d00bb143-1574-4985-9088-bd1954dd23d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetDepartmentAccesses","description":"

Get Department Accesses

This endpoint makes an HTTP POST request to retrieve department accesses. The request body should be sent in JSON format.

Request Body

outputtype (string): Specifies the type of output required.
\n
IsDeleted (boolean): Indicates whether the department access is deleted or not.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Example request body:

{\n    \"outputtype\": \"Json\",\n    \"IsDeleted\": false\n}\n\n

Response

Done (object)
\n
- API Response (object)
  \n
  - Description (string): Description of the API response.
    \n
  - ErrorCode (string): Error code, if any.
    \n
  - Status (integer): Status of the response.
    \n
  - Message (string): Additional message, if any.
    \n
  \n
- DepartmentAccessList (array)
  \n
  - TenantId (integer): ID of the tenant.
    \n
  - DepartmentAccessText (string): Text for department access.
    \n
  - DepartmentAccessNote (string): Note for department access.
    \n
  - DepartmentAccessEntryCode (string): Entry code for department access.
    \n
  - OccupancyId (integer): ID of the occupancy.
    \n
  - DepartmentAccessDeleted (boolean): Indicates whether the department access is deleted.
    \n
  - DepartmentAccessId (integer): ID of the department access.
    \n
  \n
\n

Example response:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"DepartmentAccessList\": [\n            {\n                \"TenantId\": 0,\n                \"DepartmentAccessText\": \"\",\n                \"DepartmentAccessNote\": \"\",\n                \"DepartmentAccessEntryCode\": \"\",\n                \"OccupancyId\": 0,\n                \"DepartmentAccessDeleted\": true,\n                \"DepartmentAccessId\": 0\n            }\n        ]\n    }\n}\n\n

Get Department Access

This endpoint allows you to retrieve department access information based on the provided OccupancyId.

Request Body

outputtype (text): The type of output required, in this case, it is \"Json\".
\n
OccupancyId (text): The ID of the occupancy for which department access information is requested.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon a successful execution, the response will include:

Done (object)
\n
- API Response (object)
  \n
  - Description (null): Description of the API response.
    \n
  - ErrorCode (null): Error code, if any.
    \n
  - Status (0): Status of the response.
    \n
  - Message (\"\"): Any additional message.
    \n
  \n
- DepartmentAccessList (array)
  \n
  - TenantId (number): ID of the tenant.
    \n
  - DepartmentAccessText (text): Text related to department access.
    \n
  - DepartmentAccessNote (text): Additional notes for department access.
    \n
  - DepartmentAccessEntryCode (text): Entry code for department access.
    \n
  - OccupancyId (number): ID of the occupancy.
    \n
  - DepartmentAccessDeleted (boolean): Indicates if department access is deleted.
    \n
  - DepartmentAccessId (number): ID of the department access.
    \n
  \n
\n

In case of an error, an appropriate error code and message will be included in the response.

Example

Request:

{\n  \"outputtype\": \"Json\",\n  \"OccupancyId\": 32067\n}\n\n

Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"DepartmentAccessList\": [\n      {\n        \"TenantId\": 0,\n        \"DepartmentAccessText\": \"\",\n        \"DepartmentAccessNote\": \"\",\n        \"DepartmentAccessEntryCode\": \"\",\n        \"OccupancyId\": 0,\n        \"DepartmentAccessDeleted\": true,\n        \"DepartmentAccessId\": 0\n      }\n    ]\n  }\n}\n\n

Method endpoints for Commercial Occupancy Department Access.

\n","_postman_id":"0c4182ff-7521-4c3f-95db-80b3b35d11cb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Extinguishing","item":[{"name":"Get Extinguishing System","event":[{"listen":"prerequest","script":{"id":"66e40b9f-42c4-4510-a4ac-bbf7f2ddba0b","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0c85206c-be66-4122-a47a-8821ea94c633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"OccupancyId\": 34889,\r\n \"IsDeleted\": false,\r\n \"IsPortable\": false,\r\n \"IsNonWaterBased\": false,\r\n \"IsSprinkler\": false,\r\n \"IsStandPipe\": false,\r\n \"HasBackFlowPreventor\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetExtinguishingSystem","description":"

Get Extinguishing System

This endpoint makes an HTTP POST request to retrieve information about the extinguishing system based on the provided occupancy ID.

Request Body

outputtype (string) - The type of output required (e.g. Json).
\n
OccupancyId (integer) - The ID of the occupancy for which the extinguishing system information is requested.
\n
IsDeleted (boolean) - Indicates whether the extinguishing system is deleted.
\n
IsPortable (boolean) - Indicates whether the extinguishing system is portable.
\n
IsNonWaterBased (boolean) - Indicates whether the extinguishing system is non-water based.
\n
IsSprinkler (boolean) - Indicates whether the extinguishing system is a sprinkler system.
\n
IsStandPipe (boolean) - Indicates whether the extinguishing system has a standpipe.
\n
HasBackFlowPreventor (boolean) - Indicates whether the extinguishing system has a backflow preventer.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon successful execution, the response will contain the following details:

Status (integer) - The status of the API response.
\n
Message (string) - Any additional message related to the API response.
\n
ExtinguishingList (array) - An array of extinguishing system details including various attributes such as type, presence of pressure reducers, tank details, portable system details, sprinkler system details, standpipe details, backflow preventer details, etc.
\n

Example Response:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"ExtinguishingList\": [\n            {\n                \"ExtinguishingStandPipeTypeText\": null,\n                \"ExtinguishingHasPressureReducers\": true,\n                \"ExtinguishingStandPipeTypeCode\": null,\n                \"ExtinguishingThreadTypeCode\": null,\n                \"ExtinguishingNumberOfTanks\": 0,\n                \"ExtinguishingId\": 0,\n                \"ExtinguishingTankLocation\": null,\n                \"ExtinguishingIsPortable\": true,\n                \"ExtinguishingStandPipeClassText\": null,\n                \"ExtinguishingWaterSupply\": \"\",\n                \"ExtinguishingTankPresent\": true,\n                \"ExtinguishingFDCPresent\": true,\n                \"ExtinguishingPortableTypeCode\": null,\n                \"ExtinguishingIsPartialCoverage\": true,\n                \"OccupancyId\": 0,\n                \"ExtinguishingPressureReducerNumberofFloors\": 0,\n                \"ExtinguishingNfirsTypeCode\": \"\",\n                \"ExtinguishingNumberOfHeads\": 0,\n                \"ExtinguishingNote\": \"\",\n                \"ExtinguishingDeleted\": true,\n                \"ExtinguishingIsDomestic\": true,\n                \"ExtinguishingIsStandPipe\": true,\n                \"ExtinguishingPortableSize\": 0,\n                \"ExtinguishingRiaserLocation\": \"\",\n                \"ExtinguishingStandPipeClassCode\": null,\n                \"TenantId\": 0,\n                \"ExtinguishingNfirsTypeText\": \"\",\n                \"ExtinguishingIsNonWaterBased\": true,\n                \"ExtinguishingCoversNote\": null,\n                \"ExtinguishingPortableTypeText\": null,\n                \"ExtinguishingIsSprinkler\": true,\n                \"ExtinguishingThreadTypeText\": null,\n                \"ExtinguishingHasBackFlowPreventor\": true,\n                \"ExtinguishingText\": \"\",\n                \"ExtinguishingFDCLocation\": \"\",\n                \"ExtinguishingIsMonitored\": true\n            }\n        ]\n    }\n}\n\n

Request Description

This endpoint makes an HTTP POST request to retrieve information about extinguishing systems. The request body should be in JSON format and include the following parameters:

outputtype (string): Specifies the type of output required.
\n
IsDeleted (boolean): Indicates whether the extinguishing system is deleted.
\n
IsPortable (boolean): Indicates whether the extinguishing system is portable.
\n
IsNonWaterBased (boolean): Indicates whether the extinguishing system is non-water based.
\n
IsSprinkler (boolean): Indicates whether the extinguishing system is a sprinkler system.
\n
IsStandPipe (boolean): Indicates whether the extinguishing system has a standpipe.
\n
HasBackFlowPreventor (boolean): Indicates whether the extinguishing system has a backflow preventer.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is in JSON format and includes the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ExtinguishingList\": [\n      {\n        \"ExtinguishingStandPipeTypeText\": null,\n        \"ExtinguishingHasPressureReducers\": true,\n        \"ExtinguishingStandPipeTypeCode\": null,\n        \"ExtinguishingThreadTypeCode\": null,\n        \"ExtinguishingNumberOfTanks\": 0,\n        \"ExtinguishingId\": 0,\n        \"ExtinguishingTankLocation\": null,\n        \"ExtinguishingIsPortable\": true,\n        \"ExtinguishingStandPipeClassText\": null,\n        \"ExtinguishingWaterSupply\": \"\",\n        \"ExtinguishingTankPresent\": true,\n        \"ExtinguishingFDCPresent\": true,\n        \"ExtinguishingPortableTypeCode\": null,\n        \"ExtinguishingIsPartialCoverage\": true,\n        \"OccupancyId\": 0,\n        \"ExtinguishingPressureReducerNumberofFloors\": 0,\n        \"ExtinguishingNfirsTypeCode\": \"\",\n        \"ExtinguishingNumberOfHeads\": 0,\n        \"ExtinguishingNote\": \"\",\n        \"ExtinguishingDeleted\": true,\n        \"ExtinguishingIsDomestic\": true,\n        \"ExtinguishingIsStandPipe\": true,\n        \"ExtinguishingPortableSize\": 0,\n        \"ExtinguishingRiaserLocation\": \"\",\n        \"ExtinguishingStandPipeClassCode\": null,\n        \"TenantId\": 0,\n        \"ExtinguishingNfirsTypeText\": \"\",\n        \"ExtinguishingIsNonWaterBased\": true,\n        \"ExtinguishingCoversNote\": null,\n        \"ExtinguishingPortableTypeText\": null,\n        \"ExtinguishingIsSprinkler\": true,\n        \"ExtinguishingThreadTypeText\": null,\n        \"ExtinguishingHasBackFlowPreventor\": true,\n        \"ExtinguishingText\": \"\",\n        \"ExtinguishingFDCLocation\": \"\",\n        \"ExtinguishingIsMonitored\": true\n      }\n    ]\n  }\n}\n\n

Method endpoints for Commercial Occupancy Extinguishing Systems.

\n","_postman_id":"b660c6b8-cbfc-4676-9ce2-c93882bb01fe","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Alarm","item":[{"name":"Get FireAlarm Systems","event":[{"listen":"prerequest","script":{"id":"85b3c389-b8f4-4e1f-b829-cd6a2c8a3f4a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4666e487-c8ae-4071-a7c5-10e09a88fab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false,\r\n \"IsPrimarySystem\": false,\r\n \"IsMonitored\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Risk/GetFireAlarmSystems","description":"

Get Fire Alarm Systems

This endpoint is used to retrieve fire alarm systems based on the provided criteria.

Request Body

outputtype (string): The type of output required.
\n
IsDeleted (boolean): Indicates whether the fire alarm system is deleted.
\n
IsPrimarySystem (boolean): Indicates whether the fire alarm system is the primary system.
\n
IsMonitored (boolean): Indicates whether the fire alarm system is monitored.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will include a list of fire alarm systems with the following properties:

OccupancyId (integer): The ID of the occupancy.
\n
FireAlarmNotificationTypeText (string): The text for fire alarm notification type.
\n
FireAlarmResetCode (string): The reset code for the fire alarm.
\n
AlarmCompanyId (integer): The ID of the alarm company.
\n
FireAlarmId (integer): The ID of the fire alarm.
\n
FireAlarmText (string): The text description of the fire alarm.
\n
AlarmCompanyBusinessPhone (string): The business phone number of the alarm company.
\n
AlarmCompanyName (string): The name of the alarm company.
\n
FireAlarmDeleted (boolean): Indicates whether the fire alarm is deleted.
\n
FireAlarmNote (string): Additional notes for the fire alarm.
\n
FireAlarmIsPrimary (boolean): Indicates whether the fire alarm is the primary alarm.
\n
AlarmCompanyAddress (string): The address of the alarm company.
\n
AlarmCompanyCity (string): The city of the alarm company.
\n
TenantId (integer): The ID of the tenant.
\n
AlarmCompanyEmergencyPhone (string): The emergency phone number of the alarm company.
\n
AlarmCompanyIsDeleted (boolean): Indicates whether the alarm company is deleted.
\n
AlarmCompanyState (string): The state of the alarm company.
\n
FireAlarmIsMonitored (boolean): Indicates whether the fire alarm is monitored.
\n
AlarmCompanyAddress2 (string): Additional address information for the alarm company.
\n
AlarmCompanyZip (string): The ZIP code of the alarm company.
\n
FireAlarmNotificationTypeCode (string): The code for fire alarm notification type.
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"FireAlarmList\": [\n      {\n        \"OccupancyId\": 0,\n        \"FireAlarmNotificationTypeText\": \"\",\n        \"FireAlarmResetCode\": \"\",\n        \"AlarmCompanyId\": 0,\n        \"FireAlarmId\": 0,\n        \"FireAlarmText\": \"\",\n        \"AlarmCompanyBusinessPhone\": null,\n        \"AlarmCompanyName\": null,\n        \"FireAlarmDeleted\": true,\n        \"FireAlarmNote\": null,\n        \"FireAlarmIsPrimary\": true,\n        \"AlarmCompanyAddress\": null,\n        \"AlarmCompanyCity\": null,\n        \"TenantId\": 0,\n        \"AlarmCompanyEmergencyPhone\": null,\n        \"AlarmCompanyIsDeleted\": null,\n        \"AlarmCompanyState\": null,\n        \"FireAlarmIsMonitored\": true,\n        \"AlarmCompanyAddress2\": null,\n        \"AlarmCompanyZip\": null,\n        \"FireAlarmNotificationTypeCode\": \"\"\n      }\n    ]\n  }\n}\n\n

Get Fire Alarm System

This endpoint is used to retrieve the fire alarm system details based on the provided OccupancyId.

Request Body

outputtype (string): The type of output required, in this case \"Json\".
\n
OccupancyId (integer): The unique identifier for the occupancy.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be a JSON object with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"FireAlarmList\": [\n      {\n        \"OccupancyId\": 0,\n        \"FireAlarmNotificationTypeText\": \"\",\n        \"FireAlarmResetCode\": \"\",\n        \"AlarmCompanyId\": 0,\n        \"FireAlarmId\": 0,\n        \"FireAlarmText\": \"\",\n        \"AlarmCompanyBusinessPhone\": null,\n        \"AlarmCompanyName\": null,\n        \"FireAlarmDeleted\": true,\n        \"FireAlarmNote\": null,\n        \"FireAlarmIsPrimary\": true,\n        \"AlarmCompanyAddress\": null,\n        \"AlarmCompanyCity\": null,\n        \"TenantId\": 0,\n        \"AlarmCompanyEmergencyPhone\": null,\n        \"AlarmCompanyIsDeleted\": null,\n        \"AlarmCompanyState\": null,\n        \"FireAlarmIsMonitored\": true,\n        \"AlarmCompanyAddress2\": null,\n        \"AlarmCompanyZip\": null,\n        \"FireAlarmNotificationTypeCode\": \"\"\n      }\n    ]\n  }\n}\n\n

The FireAlarmList array contains the details of the fire alarm system for the specified OccupancyId.

Method endpoints for Commercial Occupancy Alarm Systems.

\n","_postman_id":"838389e6-2016-44cf-8771-0487b8c90eb0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Chemicals","item":[{"name":"Get Chemical","event":[{"listen":"prerequest","script":{"id":"b23e9f54-46c4-4442-9fad-cd0cd7f00de2","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9da34429-e631-45ab-85b2-e92202ff21c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"OccupancyId\": 35392\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetChemical","description":"

Get Chemical Occupancy Information

This endpoint allows you to retrieve chemical occupancy information by providing the occupancy ID.

Request Body

outputtype: The type of output required (e.g. Json)
\n
OccupancyId: The ID of the occupancy for which chemical information is requested
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon a successful request, the response will include a list of chemical details for the specified occupancy. Each chemical entry in the list contains various attributes such as ChemicalNoaaNumber, ChemicalName, ActualAmount, ChemicalStorageTemperature, ChemicalStoragePressuere, and more.

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ChemicalList\": [\n      {\n        \"ChemicalText\": null,\n        \"ChemicalNoaaNumber\": \"\",\n        \"ChemicalName\": \"\",\n        \"ActualAmount\": 0,\n        \"TenantId\": 0,\n        \"ChemicalStorageTemperature\": \"\",\n        \"ChemicalStoragePressuere\": \"\",\n        \"hazplacard\": \"\",\n        \"FlashPoint\": null,\n        \"reactive\": true,\n        \"acute\": true,\n        \"ChemicalDaysOnHand\": 0,\n        \"FlashPointRange\": null,\n        \"ChemicalNotes\": \"\",\n        \"ChemicalNumber\": \"\",\n        \"ChemicalIsSolid\": true,\n        \"ChemicalMSDSOnFile\": true,\n        \"OccupancyChemicalId\": 0,\n        \"HazordClassText\": null,\n        \"ChemicalNfpaHealth\": \"\",\n        \"ChemicalIsMixture\": true,\n        \"AmountUnit\": \"\",\n        \"ChemicalStorageLocation\": \"\",\n        \"chronic\": true,\n        \"ChemicalDeleted\": true,\n        \"pressure\": true,\n        \"ChemicalIsPure\": true,\n        \"ChemicalLocation\": \"\",\n        \"ChemicalNfpaSpecial\": \"\",\n        \"fire\": true,\n        \"hazcat\": null,\n        \"ChemicalNfpaFire\": \"\",\n        \"ChemicalId\": 0,\n        \"ChemicalUNNumber\": \"\",\n        \"ChemicalIsLiquid\": true,\n        \"MaximumAmount\": \"\",\n        \"ObservedAmount\": 0,\n        \"ChemicalCasNumber\": \"\",\n        \"ChemicalIsGas\": true,\n        \"ChemicalStorageType\": \"\",\n        \"OccupancyId\": 0,\n        \"ChemicalNfpaReactivity\": \"\",\n        \"AverageAmount\": \"\",\n        \"HazordClassCode\": \"\"\n      }\n    ]\n  }\n}\n\n

Endpoint Description

This endpoint makes an HTTP POST request to retrieve a list of chemicals related to occupancy.

Request Body

outputtype (text) - Specifies the output type for the request.
\n
IsDeleted (text) - Indicates whether the item is deleted.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is in JSON format and includes the following fields:

Done (object) - Indicates the status of the API response.
\n
- API Response (object) - Contains information about the API response.
  \n
  - Description (string) - Description of the response.
    \n
  - ErrorCode (string) - Error code, if any.
    \n
  - Status (integer) - Status of the response.
    \n
  - Message (string) - Message related to the response.
    \n
  \n
- ChemicalList (array) - List of chemicals with the following attributes:
  \n
  - ChemicalText (string) - Text related to the chemical.
    \n
  - ChemicalNoaaNumber (string) - NOAA number of the chemical.
    \n
  - ChemicalName (string) - Name of the chemical.
    \n
  - ActualAmount (integer) - Actual amount of the chemical.
    \n
  - TenantId (integer) - ID of the tenant.
    \n
  - ChemicalStorageTemperature (string) - Storage temperature of the chemical.
    \n
  - ChemicalStoragePressure (string) - Storage pressure of the chemical.
    \n
  - hazplacard (string) - Hazard placard information.
    \n
  - FlashPoint (string) - Flash point of the chemical.
    \n
  - reactive (boolean) - Indicates if the chemical is reactive.
    \n
  - acute (boolean) - Indicates if the chemical is acute.
    \n
  - ChemicalDaysOnHand (integer) - Number of days the chemical is on hand.
    \n
  - FlashPointRange (string) - Range of flash point.
    \n
  - ChemicalNotes (string) - Notes related to the chemical.
    \n
  - ChemicalNumber (string) - Number associated with the chemical.
    \n
  - ChemicalIsSolid (boolean) - Indicates if the chemical is solid.
    \n
  - ChemicalMSDSOnFile (boolean) - Indicates if the chemical's MSDS is on file.
    \n
  - OccupancyChemicalId (integer) - ID of the occupancy chemical.
    \n
  - HazordClassText (string) - Text related to the hazard class.
    \n
  - ChemicalNfpaHealth (string) - NFPA health information of the chemical.
    \n
  - ChemicalIsMixture (boolean) - Indicates if the chemical is a mixture.
    \n
  - AmountUnit (string) - Unit of the amount.
    \n
  - ChemicalStorageLocation (string) - Storage location of the chemical.
    \n
  - chronic (boolean) - Indicates if the chemical is chronic.
    \n
  - ChemicalDeleted (boolean) - Indicates if the chemical is deleted.
    \n
  - pressure (boolean) - Indicates if the chemical is under pressure.
    \n
  - ChemicalIsPure (boolean) - Indicates if the chemical is pure.
    \n
  - ChemicalLocation (string) - Location of the chemical.
    \n
  - ChemicalNfpaSpecial (string) - Special NFPA information of the chemical.
    \n
  - fire (boolean) - Indicates if the chemical is flammable.
    \n
  - hazcat (string) - Hazard category of the chemical.
    \n
  - ChemicalNfpaFire (string) - NFPA fire information of the chemical.
    \n
  - ChemicalId (integer) - ID of the chemical.
    \n
  - ChemicalUNNumber (string) - UN number of the chemical.
    \n
  - ChemicalIsLiquid (boolean) - Indicates if the chemical is liquid.
    \n
  - MaximumAmount (string) - Maximum amount of the chemical.
    \n
  - ObservedAmount (integer) - Observed amount of the chemical.
    \n
  - ChemicalCasNumber (string) - CAS number of the chemical.
    \n
  - ChemicalIsGas (boolean) - Indicates if the chemical is a gas.
    \n
  - ChemicalStorageType (string) - Storage type of the chemical.
    \n
  - OccupancyId (integer) - ID of the occupancy.
    \n
  - ChemicalNfpaReactivity (string) - NFPA reactivity information of the chemical.
    \n
  - AverageAmount (string) - Average amount of the chemical.
    \n
  - HazordClassCode (string) - Code related to the hazard class.
    \n
  \n
\n

Method endpoints for Commercial Occupancy chemicals on site.

\n","_postman_id":"4bc4833f-0e68-404e-bde9-7c01b15383a8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Informational Items","item":[{"name":"Get Informational Items","event":[{"listen":"prerequest","script":{"id":"02e27751-104b-49f3-a9b6-179a393e8e68","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c53db403-5079-4f88-974a-938ee7773233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetInformationalItems","description":"

Get Informational Items

This endpoint allows you to retrieve informational items related to occupancy.

Request Body

outputtype (string): The type of output required, e.g., \"Json\".
\n
IsDeleted (boolean): Indicates whether the item is deleted.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon successful execution, the response will include:

Done (object): Indicates the completion status of the API response.
\n
- API Response (object): Contains the description, error code, status, and message.
  \n
- InformationalItemList (array): Contains the list of informational items.
  \n
\n

In case of a successful request, the status code 200 will be returned with a Content-Type of application/json.

Occupancy Information Retrieval

This endpoint allows you to retrieve informational items related to a specific occupancy.

Request Body

outputtype (text): Specifies the type of output required, e.g., \"Json\".
\n
OccupancyId (text): The ID of the occupancy for which the informational items are to be retrieved.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon successful execution, the response will include:

Done (object): Indicates the status of the API response.
\n
- API Response (object): Contains information about the API response.
  \n
  - Description (text): Description of the response.
    \n
  - ErrorCode (text): Error code, if any.
    \n
  - Status (number): Status code of the response.
    \n
  - Message (text): Additional message, if any.
    \n
  \n
\n
InformationalItemList (array): List of informational items related to the specified occupancy.
\n

Method endpoints for Commercial Occupancy Informational Items.

\n","_postman_id":"4222730f-88f2-45da-a778-54691fef0d4e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Fire Flow","item":[{"name":"Get Fireflow For Occupancy","event":[{"listen":"prerequest","script":{"id":"7364d4f6-f4f2-4f35-bd5e-adbd54166edd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e80213ac-664d-4a3a-9717-ff43fcfad80a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"OccupancyId\": 321026\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetFireflowForOccupancy","description":"

Occupancy Fireflow Data Retrieval

This endpoint allows you to retrieve fireflow data for a specific occupancy.

Request Body

outputtype (string): The format of the output data.
\n
OccupancyId (integer): The unique identifier of the occupancy for which fireflow data is to be retrieved.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be in JSON format with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"FireFlowList\": [\n      {\n        \"TrueGPMNeeded\": 0,\n        \"Class4GPMNeeded\": 0,\n        \"Class1GPMNeeded\": 0,\n        \"BuildingLength\": 0,\n        \"OccupancyId\": 0,\n        \"CalculatedSQFT\": 0,\n        \"Side4Exposure\": \"\",\n        \"Class3GPMNeeded\": 0,\n        \"BuildingWidth\": 0,\n        \"CombustibilityText\": \"\",\n        \"Side1Exposure\": \"\",\n        \"BuildingNumberOfFloors\": 0,\n        \"Side3Exposure\": \"\",\n        \"TenantId\": 0,\n        \"FireFlowId\": 0,\n        \"Class2GPMNeeded\": 0,\n        \"Side2Exposure\": \"\"\n      }\n    ]\n  }\n}\n\n

Get Fire Flow Occupancy Data

This API endpoint is used to retrieve fire flow occupancy data.

Request Body

outputtype: (string) The type of output required.
\n
FireFlowId: (number) The ID of the fire flow.
\n

Example:

{\n    \"outputtype\": \"Json\",\n    \"FireFlowId\": 427\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Done: (object) Indicates if the API call was successful.
\n
- API Response: (object) Details of the API response.
  \n
  - Description: (string) Description of the response.
    \n
  - ErrorCode: (string) Error code, if any.
    \n
  - Status: (number) Status of the response.
    \n
  - Message: (string) Additional message, if any.
    \n
  \n
- FireFlowList: (array) List of fire flow occupancy data.
  \n
  - TrueGPMNeeded: (number) True GPM needed.
    \n
  - Class4GPMNeeded: (number) GPM needed for Class 4.
    \n
  - Class1GPMNeeded: (number) GPM needed for Class 1.
    \n
  - BuildingLength: (number) Length of the building.
    \n
  - OccupancyId: (number) ID of the occupancy.
    \n
  - CalculatedSQFT: (number) Calculated square footage.
    \n
  - Side4Exposure: (string) Exposure on side 4.
    \n
  - Class3GPMNeeded: (number) GPM needed for Class 3.
    \n
  - BuildingWidth: (number) Width of the building.
    \n
  - CombustibilityText: (string) Text describing combustibility.
    \n
  - Side1Exposure: (string) Exposure on side 1.
    \n
  - BuildingNumberOfFloors: (number) Number of floors in the building.
    \n
  - Side3Exposure: (string) Exposure on side 3.
    \n
  - TenantId: (number) ID of the tenant.
    \n
  - FireFlowId: (number) ID of the fire flow.
    \n
  - Class2GPMNeeded: (number) GPM needed for Class 2.
    \n
  - Side2Exposure: (string) Exposure on side 2.
    \n
  \n
\n

Example Response:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"FireFlowList\": [\n            {\n                \"TrueGPMNeeded\": 0,\n                \"Class4GPMNeeded\": 0,\n                \"Class1GPMNeeded\": 0,\n                \"BuildingLength\": 0,\n                \"OccupancyId\": 0,\n                \"CalculatedSQFT\": 0,\n                \"Side4Exposure\": \"\",\n                \"Class3GPMNeeded\": 0,\n                \"BuildingWidth\": 0,\n                \"CombustibilityText\": \"\",\n                \"Side1Exposure\": \"\",\n                \"BuildingNumberOfFloors\": 0,\n                \"Side3Exposure\": \"\",\n                \"TenantId\": 0,\n                \"FireFlowId\": 0,\n                \"Class2GPMNeeded\": 0,\n                \"Side2Exposure\": \"\"\n            }\n        ]\n    }\n}\n\n

This endpoint allows you to make an HTTP POST request to retrieve fire flow information related to occupancy. The request should include a payload with the raw request body type, containing the \"outputtype\" parameter set to \"Json\".

Request Body

outputtype (string): Specifies the type of output required, in this case set to \"Json\".

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon successful execution, the response will have a status code of 200 and a content type of \"application/json\". The response body will contain an \"API Response\" object with \"Description\", \"ErrorCode\", \"Status\", and \"Message\" fields, as well as a \"FireFlowList\" array containing fire flow information for different parameters such as TrueGPMNeeded, Class4GPMNeeded, BuildingLength, and more.

Example Response:

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"FireFlowList\": [\n            {\n                \"TrueGPMNeeded\": 0,\n                \"Class4GPMNeeded\": 0,\n                \"Class1GPMNeeded\": 0,\n                \"BuildingLength\": 0,\n                \"OccupancyId\": 0,\n                \"CalculatedSQFT\": 0,\n                \"Side4Exposure\": \"\",\n                \"Class3GPMNeeded\": 0,\n                \"BuildingWidth\": 0,\n                \"CombustibilityText\": \"\",\n                \"Side1Exposure\": \"\",\n                \"BuildingNumberOfFloors\": 0,\n                \"Side3Exposure\": \"\",\n                \"TenantId\": 0,\n                \"FireFlowId\": 0,\n                \"Class2GPMNeeded\": 0,\n                \"Side2Exposure\": \"\"\n            }\n        ]\n    }\n}\n\n

Method endpoints for Commercial Occupancy Fire Flow requirements.

\n","_postman_id":"0ccb62a9-993b-482f-93e5-6372612961a5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Tanks","item":[{"name":"Get Tanks","event":[{"listen":"prerequest","script":{"id":"de64bf42-300c-422b-b562-ab42dc3442d8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c5abe541-eece-4f65-9571-be4cf28b8053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"IsDeleted\": false\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetTanks","description":"

Get Tanks Occupancy

This API endpoint makes an HTTP POST request to retrieve the list of tanks occupancy.

Request

Method: POST
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Occupancy/GetTanks
\n
{ \"outputtype\": \"Json\", \"IsDeleted\": false}
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is in the form of a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Done\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"API Response\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"Description\": {\n              \"type\": \"string\"\n            },\n            \"ErrorCode\": {\n              \"type\": \"string\"\n            },\n            \"Status\": {\n              \"type\": \"integer\"\n            },\n            \"Message\": {\n              \"type\": \"string\"\n            }\n          }\n        },\n        \"OccupancyTankList\": {\n          \"type\": \"array\",\n          \"items\": {}\n        }\n      }\n    }\n  }\n}\n\n

Endpoint Description

This endpoint allows users to retrieve tank occupancy information by making an HTTP POST request to the specified URL.

Request Body

outputtype (text): Specifies the type of output required.
\n
OccupancyId (text): Represents the ID of the occupancy for which tank information is requested.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response is in the form of a JSON schema and includes the following fields:

Done (object): Contains the API response and occupancy tank list.
\n
- API Response (object): Provides information about the API response, including description, error code, status, and message.
  \n
  - Description (text): Description of the API response.
    \n
  - ErrorCode (text): Code indicating any error that occurred.
    \n
  - Status (number): Status of the response.
    \n
  - Message (text): Additional message related to the response.
    \n
  \n
- OccupancyTankList (array): List of tank occupancy information.
  \n
\n

The response returned a status code of 200 and the content type was application/json.

Method endpoints for Commercial Occupancy tanks on site.

\n","_postman_id":"83801a98-600f-4178-ae13-bef59e727e4c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}}],"id":"2af8fba9-3159-4b9d-94fe-9c7bd865f1f5","description":"

Method endpoints for Commercial Occupancy Risk Management information.

\n","_postman_id":"2af8fba9-3159-4b9d-94fe-9c7bd865f1f5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"General Department Information","item":[{"name":"Get Contractor","event":[{"listen":"prerequest","script":{"id":"87db4407-c98a-4047-a595-bb8362f9d497","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b5ff8ad7-5be4-4dd6-a66d-13867928a1eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{subscriptionkey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"ContractorId\": \"732\"\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi//SLI/GeneralAPI/Department/GetContractor","description":"

Get Contractor Department Information

This endpoint allows you to retrieve contractor department information.

Request Body

outputtype (string): The type of output required (e.g., \"Json\").
\n
ContractorId (string): The ID of the contractor.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The API returns a JSON object with the following fields:

Done (object)
\n
- API Response (object)
  \n
  - Description (string): Description of the response.
    \n
  - ErrorCode (string): Error code, if any.
    \n
  - Status (integer): Status of the response.
    \n
  - Message (string): Additional message, if any.
    \n
  \n
- Contractor (object)
  \n
  - ContractorFirstName (string): First name of the contractor.
    \n
  - ContractorId (integer): ID of the contractor.
    \n
  - ContractorBusinessName (string): Business name of the contractor.
    \n
  - ContractorTitle (string): Title of the contractor.
    \n
  - ContractorAddress2 (string): Secondary address of the contractor.
    \n
  - ContractorLastName (string): Last name of the contractor.
    \n
  - ContractorState (string): State of the contractor.
    \n
  - ContractorTypeCode (string): Type code of the contractor.
    \n
  - ContractorAddress (string): Address of the contractor.
    \n
  - ContractorEmail (string): Email of the contractor.
    \n
  - ContractorCity (string): City of the contractor.
    \n
  - ContractorNote (string): Note for the contractor.
    \n
  - ContractorDeleted (boolean): Indicates if the contractor is deleted.
    \n
  - TenantId (integer): ID of the tenant.
    \n
  - ContractorTypeText (string): Type text of the contractor.
    \n
  - ContractorZipCode (string): Zip code of the contractor.
    \n
  - ContractorMiddleName (string): Middle name of the contractor.
    \n
  \n
\n

Example

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"Contractor\": {\n            \"ContractorFirstName\": \"\",\n            \"ContractorId\": 0,\n            \"ContractorBusinessName\": \"\",\n            \"ContractorTitle\": \"\",\n            \"ContractorAddress2\": \"\",\n            \"ContractorLastName\": \"\",\n            \"ContractorState\": \"\",\n            \"ContractorTypeCode\": \"\",\n            \"ContractorAddress\": \"\",\n            \"ContractorEmail\": \"\",\n            \"ContractorCity\": \"\",\n            \"ContractorNote\": \"\",\n            \"ContractorDeleted\": true,\n            \"TenantId\": 0,\n            \"ContractorTypeText\": \"\",\n            \"ContractorZipCode\": \"\",\n            \"ContractorMiddleName\": \"\"\n        }\n    }\n}\n\n

Request Description

This endpoint makes an HTTP POST request to retrieve a list of contractors from the Department API. The request body should be in raw format with the payload containing the \"outputtype\" and \"IsDeleted\" parameters.

Request Body

outputtype (string): Specifies the output type for the response.
\n
IsDeleted (string): Indicates whether the contractors are deleted or not.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

The response will be in JSON format with the following schema:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Contractors\": [\n      {\n        \"ContractorFirstName\": \"\",\n        \"ContractorId\": 0,\n        \"ContractorBusinessName\": \"\",\n        \"ContractorTitle\": \"\",\n        \"ContractorAddress2\": \"\",\n        \"ContractorLastName\": \"\",\n        \"ContractorState\": \"\",\n        \"ContractorTypeCode\": \"\",\n        \"ContractorAddress\": \"\",\n        \"ContractorEmail\": \"\",\n        \"ContractorCity\": \"\",\n        \"ContractorNote\": \"\",\n        \"ContractorDeleted\": true,\n        \"TenantId\": 0,\n        \"ContractorTypeText\": \"\",\n        \"ContractorZipCode\": \"\",\n        \"ContractorMiddleName\": \"\"\n      }\n    ]\n  }\n}\n\n

The \"Contractors\" array contains information about each contractor, including their first name, ID, business name, title, address, email, and more.

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Contractors\": [\n      {\n        \"ContractorFirstName\": \"\",\n        \"ContractorId\": 0,\n        \"ContractorBusinessName\": \"\",\n        \"ContractorTitle\": \"\",\n        \"ContractorAddress2\": \"\",\n        \"ContractorLastName\": \"\",\n        \"ContractorState\": \"\",\n        \"ContractorTypeCode\": \"\",\n        \"ContractorAddress\": \"\",\n        \"ContractorEmail\": \"\",\n        \"ContractorCity\": \"\",\n        \"ContractorNote\": \"\",\n        \"ContractorDeleted\": true,\n        \"TenantId\": 0,\n        \"ContractorTypeText\": \"\",\n        \"ContractorZipCode\": \"\",\n        \"ContractorMiddleName\": \"\"\n      }\n    ]\n  }\n}\n\n

Primary View Department Client API

This endpoint allows you to retrieve the main client view for a department.

Request Body

outputtype (string) - Specifies the type of output required. Set to \"Json\".

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Status - 200 OK
\n
Content-Type - application/json
\n
Done (object)
\n
- API Response (object)
  \n
  - Description (string) - Description of the response.
    \n
  - ErrorCode (string) - Error code, if any.
    \n
  - Status (integer) - Status of the response.
    \n
  - Message (string) - Additional message, if any.
    \n
  \n
- ClientMainViewList (array)
  \n
  - TenantId (integer) - ID of the tenant.
    \n
  - StreetNumber (string) - Street number.
    \n
  - logourl (string) - URL for the logo.
    \n
  - Street (string) - Street name.
    \n
  - Address2 (string) - Additional address information.
    \n
  - StreetType (string) - Type of street.
    \n
  - StreetPrefix (string) - Prefix for the street.
    \n
  - FaxNumber (string) - Fax number.
    \n
  - Suite (string) - Suite information.
    \n
  - ClientName (string) - Name of the client.
    \n
  - IsFireRecoveryBilling (boolean) - Indicates if FireRecovery billing is enabled.
    \n
  - StreetSuffix (string) - Suffix for the street.
    \n
  - State (string) - State information.
    \n
  - ClientLogo (string) - Client's logo.
    \n
  - City (string) - City information.
    \n
  - PhoneNumber (string) - Phone number.
    \n
  - ZipCode (string) - Zip code.
    \n
  \n
\n

Example Response

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"ClientMainViewList\": [\n            {\n                \"TenantId\": 0,\n                \"StreetNumber\": \"\",\n                \"logourl\": \"\",\n                \"Street\": \"\",\n                \"Address2\": \"\",\n                \"StreetType\": \"\",\n                \"StreetPrefix\": \"\",\n                \"FaxNumber\": \"\",\n                \"Suite\": \"\",\n                \"ClientName\": \"\",\n                \"IsFireRecoveryBilling\": true,\n                \"StreetSuffix\": \"\",\n                \"State\": \"\",\n                \"ClientLogo\": \"\",\n                \"City\": \"\",\n                \"PhoneNumber\": \"\",\n                \"ZipCode\": \"\"\n            }\n        ]\n    }\n}\n\n

Get Client User Accounts

This endpoint makes an HTTP POST request to retrieve client user accounts. The request payload should be in JSON format with the \"outputtype\" key specifying the output format and \"IsEnabled\" key indicating whether the accounts are enabled.

Request Body:

outputtype (string): Specifies the output format, e.g., \"Json\"
\n
IsEnabled (boolean): Indicates whether the accounts are enabled
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response:

Status: 200
\n
Content-Type: application/json
\n

The response contains an object \"Done\" with \"API Response\" providing details about the response status. The \"ClientUserAccounts\" array includes information about each client user account, such as role, account ID, shift ID, inspection report permissions, last login, email, tenant ID, and account status.

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"ClientUserAccounts\": [\n      {\n        \"UserRoleText\": \"\",\n        \"ClientUserAccountId\": 0,\n        \"UserShiftId\": 0,\n        \"CCUserInspectionReport\": true,\n        \"UserAccountLastLogin\": null,\n        \"UserRankId\": 0,\n        \"Enabled\": true,\n        \"ClientUserEmail\": \"\",\n        \"AlternateEmail\": null,\n        \"TenantId\": 0,\n        \"IsLoginEmailUsed\": true,\n        \"IncludeInspectorPhone\": true,\n        \"ClientUserLastName\": \"\",\n        \"UserStationText\": \"\",\n        \"IncludeInspectorEmail\": true,\n        \"UserStationId\": 0,\n        \"UserAcountIsEnabled\": true,\n        \"UserShiftText\": \"\",\n        \"UserPhoneNumberExtension\": null,\n        \"UserRankText\": \"\",\n        \"ClientUserFirstName\": \"\",\n        \"UserPhoneNumber\": null,\n        \"UserRoleId\": 0\n      }\n    ]\n  }\n}\n\n

Get Client User Account

This endpoint allows you to retrieve the details of a client user account.

Request Body

outputtype (string): The type of output required, in this case, it is \"Json\".
\n
ClientuserAccountId (number): The unique identifier of the client user account for which the details are to be retrieved.
\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Response

Upon a successful request, the server will respond with a status code of 200 and a JSON object containing the details of the client user account. The response includes the following fields:

UserRoleText (string): The role of the client user.
\n
ClientUserAccountId (number): The unique identifier of the client user account.
\n
UserShiftId (number): The shift ID of the user.
\n
CCUserInspectionReport (boolean): Indicates whether the user can inspect reports.
\n
UserAccountLastLogin (string): The date and time of the user's last login.
\n
Enabled (boolean): Indicates whether the user account is enabled.
\n
ClientUserEmail (string): The email address of the client user.
\n
AlternateEmail (string): An alternate email address for the user.
\n
TenantId (number): The ID of the tenant.
\n
IsLoginEmailUsed (boolean): Indicates if the login email is used.
\n
IncludeInspectorPhone (boolean): Indicates whether the inspector's phone is included.
\n
ClientUserLastName (string): The last name of the client user.
\n
UserStationText (string): The text related to the user's station.
\n
IncludeInspectorEmail (boolean): Indicates whether the inspector's email is included.
\n
UserStationId (number): The ID of the user's station.
\n
UserAcountIsEnabled (boolean): Indicates whether the user account is enabled.
\n
UserShiftText (string): The text related to the user's shift.
\n
UserPhoneNumberExtension (string): The phone number extension of the user.
\n
UserRankText (string): The text related to the user's rank.
\n
ClientUserFirstName (string): The first name of the client user.
\n
UserPhoneNumber (string): The phone number of the user.
\n
UserRoleId (number): The role ID of the user.
\n

Example

{\n    \"Done\": {\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        },\n        \"ClientUserAccount\": {\n            \"UserRoleText\": \"\",\n            \"ClientUserAccountId\": 0,\n            \"UserShiftId\": 0,\n            \"CCUserInspectionReport\": true,\n            \"UserAccountLastLogin\": null,\n            \"Enabled\": true,\n            \"ClientUserEmail\": \"\",\n            \"AlternateEmail\": null,\n            \"TenantId\": 0,\n            \"IsLoginEmailUsed\": true,\n            \"IncludeInspectorPhone\": true,\n            \"ClientUserLastName\": \"\",\n            \"UserStationText\": \"\",\n            \"IncludeInspectorEmail\": true,\n            \"UserStationId\": 0,\n            \"UserAcountIsEnabled\": true,\n            \"UserShiftText\": \"\",\n            \"UserPhoneNumberExtension\": null,\n            \"UserRankText\": \"\",\n            \"ClientUserFirstName\": \"\",\n            \"UserPhoneNumber\": null,\n            \"UserRoleId\": 0\n        }\n    }\n}\n\n

Method endpoints for general department information.

\n","_postman_id":"83dd862e-1283-47fb-a6ac-8d8009e89651","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}}],"id":"60b8357f-de4f-42df-ac3e-c233e591b8b8","description":"

Provides general API endpoints that are available when provided access to the general API product. Methods are separated in folders that represent the areas they apply.

\n","_postman_id":"60b8357f-de4f-42df-ac3e-c233e591b8b8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Billing","item":[{"name":"Get All Standalone Inspections For Billing","id":"1695e942-6e5a-4d2b-b88a-97296c32600a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{BrowardSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://process.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/billing/getallstandaloneinspectionsforbilling","description":"

Get All Standalone Inspections for Billing

This endpoint retrieves all standalone inspections related to billing. It is particularly useful for clients who need to fetch inspection details that are not tied to any specific billing cycle or invoice.

Request

Method: POST
\n
URL: {{BaseUrl}}/Primary/restapi/slipublicapi/productscustom/billing/getallstandaloneinspectionsforbilling
\n

Request Body

The request body must be in JSON format and should include the following parameter:

outputtype (string): Specifies the desired output format. Currently, the only accepted value is \"Json\".

Example Request Body:

{\n  \"outputtype\": \"Json\"\n}\n\n

Expected Response

The response will be in JSON format and will contain the following structure:

Done (object): An object that encapsulates the API response.
\n
- API Response (object): Contains metadata about the API call.
  \n
  - Description (string or null): A description of the response (if any).
    \n
  - ErrorCode (integer or null): An error code indicating the status of the request (if any).
    \n
  - Status (integer): A status code indicating the success of the API call. A value of 0 typically indicates success.
    \n
  - Message (string): A message providing additional information about the response.
    \n
  \n
\n
GetStandaloneInspectionsForBillings (array): An array of objects, each representing a standalone inspection. Each object may contain the following fields:
\n
- LastModifiedDate (string): The date when the inspection was last modified.
  \n
- FiscalYearId (integer): The ID of the fiscal year associated with the inspection.
  \n
- ClientId (integer): The ID of the client associated with the inspection.
  \n
- OccupancyId (integer): The ID related to occupancy.
  \n
- BillingExportId (integer): The ID representing the billing export of the inspection.
  \n
- IsFeeScheduleNoCharge (boolean): Indicates whether the fee schedule has no charge.
  \n
- ManualOverrideFee (boolean): Indicates whether there is a manual override for the fee.
  \n
- SeriesId (integer): The ID of the series associated with the inspection.
  \n
- InspectionId (integer): The unique identifier for the inspection.
  \n
- BillingStatusNote (string or null): Any notes related to the billing status (if any).
  \n
- billingyear (string): The year associated with the billing.
  \n
- LastModifiedById (string): The ID of the user who last modified the inspection.
  \n
- InspectionAccountId (string): The account ID related to the inspection.
  \n
- AccountName (string): The name associated with the account.
  \n
\n

Status Codes

200 OK: The request was successful, and the response contains the requested data.
\n
Other Status Codes: Depending on the implementation, other status codes may indicate errors or issues with the request.
\n

This endpoint is essential for clients needing to aggregate billing-related inspections efficiently.

API Endpoint: Get All Complex Inspections for Billing

Request Method

POST

Endpoint

{{BaseUrl}}/Primary/restapi/slipublicapi/productscustom/billing/getallcomplexinspectionsforbilling

Request Body

The request requires a JSON payload with the following parameter:

outputtype (string): Specifies the format of the output. In this case, it should be set to \"Json\".

Expected Response

The API responds with a JSON object that contains the following structure:

Done (object): Contains the overall status of the API response.
\n
- API Response (object): Provides details about the response status.
  \n
  - Description (string|null): A description of the response, if available.
    \n
  - ErrorCode (integer|null): An error code indicating the status of the request, if any.
    \n
  - Status (integer): Indicates the success or failure of the API call (0 for success).
    \n
  - Message (string): A message related to the API response, if applicable.
    \n
  \n
\n
GetComplexInspectionsForBillings (array): An array of complex inspection billing details, where each object contains:
\n
- ClientId (integer): The ID of the client associated with the inspection.
  \n
- BillingStatusId (integer): The ID representing the billing status.
  \n
- FiscalYearId (integer): The ID for the fiscal year.
  \n
- ComplexInspectionId (integer): The unique ID for the complex inspection.
  \n
- SeriesId (integer): The ID for the series associated with the inspection.
  \n
- ComplexId (integer): The ID for the complex.
  \n
- BillingStatusNote (string|null): Any notes related to the billing status.
  \n
- LastModifiedDate (string): The date when the record was last modified.
  \n
- f_frusa_user_id (string|null): The user ID associated with the record.
  \n
- ManualOverrideFee (boolean): Indicates if there is a manual override fee.
  \n
- IsFeeScheduleNoCharge (boolean): Indicates if the fee schedule has no charge.
  \n
\n

Notes

Ensure that the request body is correctly formatted as JSON and includes the required parameter to receive the expected response. The API provides a structured response that allows users to easily interpret the billing inspection data. This endpoint is useful for retrieving comprehensive details about complex inspections related to billing, including their status and any associated client information.

Endpoint: Get Occupancy Accounting

This endpoint retrieves occupancy accounting information based on a specified occupancy ID. It is designed to return details about the occupancy, including related property account settings.

Request

Method: POST
URL: {{BaseUrl}}/Primary/restapi/slipublicapi/productscustom/billing/getoccupancyaccounting

Request Body:
The request body must be in JSON format and include the following parameters:

outputtype (string): Specifies the format of the output. In this case, it should be set to \"Json\".
\n
OccupancyId (integer): The unique identifier for the occupancy for which accounting information is being requested.
\n

Example Request Body:

{\n  \"outputtype\": \"Json\",\n  \"OccupancyId\": 321057\n}\n\n

Response

Upon a successful request, the API will return a JSON response containing the following structure:

Done (object): This object contains the overall status of the API response.
\n
- API Response (object): Provides details about the response status.
  \n
  - Description (string): A description of the response (may be null).
    \n
  - ErrorCode (integer): An error code if applicable (may be null).
    \n
  - Status (integer): The status code of the request (0 indicates success).
    \n
  - Message (string): A message related to the response (may be empty).
    \n
  \n
\n
GetOccupancyAccountList (array): An array of objects containing details about the occupancy accounts.
\n
- PropertyAccountId (integer): The identifier for the property account.
  \n
- ClientID (integer): The identifier for the client.
  \n
- OccupancyId (integer): The occupancy identifier.
  \n
- SettingsType (string): The type of settings associated with the occupancy.
  \n
- SettingsValue (string): The value of the settings.
  \n
- SettingsComments (string): Any comments related to the settings.
  \n
\n

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"GetOccupancyAccountList\": [\n      {\n        \"PropertyAccountId\": 0,\n        \"ClientID\": 0,\n        \"OccupancyId\": 0,\n        \"SettingsType\": \"\",\n        \"SettingsValue\": \"\",\n        \"SettingsComments\": \"\"\n      }\n    ]\n  }\n}\n\n

Notes

Ensure that the OccupancyId provided in the request body is valid to receive the correct occupancy accounting details.
\n
The response may contain null values for certain fields if no data is available.
\n

Get Complex Accounting

This endpoint retrieves complex accounting details based on the provided Complex ID. It is useful for obtaining specific accounting information related to a complex.

Request

Method: POST
URL: {{BaseUrl}}/Primary/restapi/slipublicapi/productscustom/billing/getcomplexaccounting

Request Body: The request body must be in JSON format and include the following parameters:

outputtype (string): Specifies the format of the response. In this case, it should be set to \"Json\".
\n
ComplexId (integer): The unique identifier for the complex whose accounting details are being requested.
\n

Example Request Body:

{\n  \"outputtype\": \"Json\",\n  \"ComplexId\": 1573\n}\n\n

Response

The response will be in JSON format and will contain the following structure:

Done: An object that indicates the status of the API response.
\n
- API Response: Contains details about the response.
  \n
  - Description: A description of the response (nullable).
    \n
  - ErrorCode: An error code if applicable (nullable).
    \n
  - Status: An integer representing the status of the request (0 indicates success).
    \n
  - Message: A message related to the response (can be empty).
    \n
  \n
- PublicAPI_GetComplexAccounting_Result: An array of objects containing the accounting details for the specified complex.
  \n
  - ComplexAccountId (integer): The unique identifier for the complex account.
    \n
  - ClientID (integer): The identifier for the client associated with the complex.
    \n
  - ComplexId (integer): The identifier for the complex.
    \n
  - SettingsType (string): The type of settings associated with the complex account.
    \n
  - SettingsValue (string): The value of the settings.
    \n
  - SettingsComments (string): Any comments related to the settings.
    \n
  \n
\n

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"PublicAPI_GetComplexAccounting_Result\": [\n      {\n        \"ComplexAccountId\": 0,\n        \"ClientID\": 0,\n        \"ComplexId\": 0,\n        \"SettingsType\": \"\",\n        \"SettingsValue\": \"\",\n        \"SettingsComments\": \"\"\n      }\n    ]\n  }\n}\n\n

Get Additional Line Items

This endpoint retrieves additional line items related to a specific inspection. It is particularly useful for obtaining detailed billing information associated with a given inspection ID.

Purpose

The purpose of this request is to fetch additional billing line items that are linked to a specified inspection. This is essential for users needing to review or process billing details for inspections.

Request

Method

POST

URL

{{BaseUrl}}/Primary/restapi/slipublicapi/productscustom/billing/getadditionallineitems

Request Body

The request body must be in JSON format and should include the following parameters:

outputtype (string): Specifies the format of the output. In this case, it should be set to \"Json\".
\n
InspectionId (integer): The unique identifier for the inspection for which additional line items are being requested.
\n

Example Request Body

{\n  \"outputtype\": \"Json\",\n  \"InspectionId\": 2613387\n}\n\n

Response

Status Code

200 OK

Content-Type

application/json

Response Body

The response will contain a JSON object with the following structure:

Done (object): Contains the overall status of the API response.
\n
- API Response (object): Provides metadata about the response.
  \n
  - Description (string): A description of the response (may be null).
    \n
  - ErrorCode (integer): An error code indicating the status of the request (may be null).
    \n
  - Status (integer): The status of the API call (0 indicates success).
    \n
  - Message (string): A message related to the response (may be empty).
    \n
  \n
- GetAdditionalLineItems (array): An array of additional line items related to the inspection. Each item in the array includes:
  \n
  - LineItemNote (string): Notes associated with the line item.
    \n
  - PermitId (integer): The ID of the permit associated with the line item.
    \n
  - AdditionalLineItemId (integer): The unique ID for the additional line item.
    \n
  - LineItemFee (number): The fee associated with the line item.
    \n
  - LineItemTypeText (string): Text describing the type of line item.
    \n
  - InspectionId (integer): The ID of the inspection related to the line item.
    \n
  - LineItemDate (string): The date associated with the line item.
    \n
  - LineItemText (string): Text describing the line item.
    \n
  - ClientId (integer): The ID of the client associated with the line item.
    \n
  - LineItemExpirationDate (string): The expiration date of the line item.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"GetAdditionalLineItems\": [\n      {\n        \"LineItemNote\": \"\",\n        \"PermitId\": 0,\n        \"AdditionalLineItemId\": 0,\n        \"LineItemFee\": 0,\n        \"LineItemTypeText\": \"\",\n        \"InspectionId\": 0,\n        \"LineItemDate\": \"\",\n        \"LineItemText\": \"\",\n        \"ClientId\": 0,\n        \"LineItemExpirationDate\": \"\"\n      }\n    ]\n  }\n}\n\n

Notes

Ensure that the InspectionId provided in the request is valid to receive the corresponding additional line items.
\n
The response may contain multiple line items, or it may be empty if no additional line items are found for the specified inspection.
\n

Endpoint Description

This endpoint is used to mark inspections for billing export in the system. It allows users to submit a list of billing export IDs, which the API processes to update the status of the inspections accordingly.

Request

Method: POST
URL: https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/billing/markinspectionsforbillingexported

Request Body

The request body must be in JSON format and should include the following parameters:

outputtype (string): Specifies the desired output format. For this request, it should be set to \"Json\".
\n
MarkInspectionsBillingExportRequest (object): Contains the details for marking inspections.
\n
- BillingExportIdList (array of integers): A list of billing export IDs that need to be marked for billing.
\n

Example Request Body:

{\n  \"outputtype\": \"Json\",\n  \"MarkInspectionsBillingExportRequest\": {\n    \"BillingExportIdList\": [889889]\n  }\n}\n\n

Response

The response will be returned in JSON format and contains the following structure:

Done (object): Indicates the completion status of the request.
\n
- API Response (object): Provides details about the API's processing of the request.
  \n
  - Description (string): A description of the response (may be empty).
    \n
  - ErrorCode (string): An error code indicating the result of the operation (may be empty).
    \n
  - Status (integer): A status code representing the outcome of the request (0 indicates success).
    \n
  - Message (string): A message providing additional information (may be empty).
    \n
  \n
\n

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": \"\",\n      \"ErrorCode\": \"\",\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

Notes

A successful response will have a Status of 0, indicating that the request was processed without errors.
\n
If there are any issues, the ErrorCode and Message fields will provide further details.
\n

Provides Billing API endpoints that are available when provided access to the Billing API product.

\n","_postman_id":"e23a621e-129b-45f9-9508-761c25b43483","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}}],"id":"b5e07f9b-8e06-49bd-8ed6-b72a2c2df907","description":"

Provides a set of API endpoints to support collecting inspection and property information from Streamline Automation.

\n","_postman_id":"b5e07f9b-8e06-49bd-8ed6-b72a2c2df907","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Custom APIs","item":[{"name":"Dallas Fire and Rescue","item":[{"name":"Get All Occupancies","event":[{"listen":"prerequest","script":{"id":"1de86dbf-869a-4d1b-9bf8-64633bf61477","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"69a44eee-6c8d-46f4-9bf1-12f5e18d1263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DallasSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PageNumber\":1,\r\n \"RowsPerPage\":100\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://process.firerecoveryusa.com/Primary/restapi/Tenant72/GetOccupancies?outputtype=Json","description":"

Get Occupancies

This POST endpoint retrieves a list of occupancies.

Request Body

Supply a JSON request body with the following parameters:

PageNumber (integer): The page number of occupancies to return.
RowsPerPage (integer): The number of occupancy records to return per page.

Example request body:

{\n  \"PageNumber\": 1,\n  \"RowsPerPage\": 100\n}\n

Response Body

The response will be in JSON format and will contain the following fields:

Done: An object containing the list of occupancies with various details such as last modified date, occupancy ID, occupancy name, city, state, latitude, longitude, and more.
API Response: An object containing the description, error code, status, and message.

Example response:

{\n  \"Done\": {\n    \"Occupancies\": [\n      {\n        \"LastModifiedDate\": \"\",\n        \"LastInspectionDate\": \"\",\n        \"ClientOccupancyId\": \"\",\n        \"DistrictCode\": \"\",\n        \"...\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n

Potential Errors

401 Unauthorized

This error indicates the user is not authorized to access the requested resource. This typically occurs when the user has not provided a valid subscription key, Client ID, or the provided token is invalid or expired.

500 Internal Server Error

Something internally errored during the processing of your request. Please try again and, if the issue persists, contact support.

Get Occupancy by ID

This endpoint retrieves occupancy details by providing the Occupancy ID as a query parameter.

Request

Endpoint

GET https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant72/GetOccupancyById

Query Parameters

outputtype (string, required): The type of output, set to \"Json\".
\n
OccupancyId (integer, required): The unique identifier for the occupancy.
\n

Response

Upon a successful request, the server returns a JSON object with the following properties:

Done (object): Contains occupancy details.
\n
- Occupancy (object): Details of the occupancy including various property attributes.
  \n
- API Response (object): Additional information about the API response.
  \n
  - Description (string): Description of the response.
    \n
  - ErrorCode (string): Error code if applicable.
    \n
  - Status (integer): Status code of the response.
    \n
  - Message (string): Any accompanying message.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"Occupancy\": {\n      \"APN\": \"\",\n      \"BuildingStatusText\": \"\",\n      \"City\": \"\",\n      \"isVacantProperty\": true,\n      ...\n    },\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Get Inspection Series Responses

This endpoint makes an HTTP GET request to retrieve a list of inspection responses for a specific Inspection Series.

Request

Method: GET
\n
Endpoint: https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant72/GetInspectionSeriesReponses
\n
Query Parameters:
\n
- outputtype=Json
  \n
- InspectionSeriesId=251446
  \n
\n

Response

Upon a successful execution, the endpoint returns a JSON response with the following structure:

{\n  \"Done\": {\n    \"Responses\": [\n      {\n        \"ResponseId\": 0,\n        \"passed\": true,\n        \"SeriesId\": 0,\n        \"FieldId\": 0,\n        \"FieldType\": \"\",\n        \"FieldHidden\": true,\n        \"Response\": \"\",\n        \"FieldNotApplicable\": true,\n        \"Note\": \"\",\n        \"Question\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

The Done object contains an array of inspection responses, while the API Response object provides additional information about the API response.

Example

{\n  \"Done\": {\n    \"Responses\": [\n      {\n        \"ResponseId\": 0,\n        \"passed\": true,\n        \"SeriesId\": 0,\n        \"FieldId\": 0,\n        \"FieldType\": \"\",\n        \"FieldHidden\": true,\n        \"Response\": \"\",\n        \"FieldNotApplicable\": true,\n        \"Note\": \"\",\n        \"Question\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Get Violations By Date Found

This endpoint retrieves violations within a specified date range.

Request

Endpoint

GET https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant72/GetViolationsByDateFound

Query Parameters

outputtype: Json
\n
DateFrom (required): Start date for the search
\n
DateTo (required): End date for the search
\n

Response

Status: 200 OK

Content-Type: application/json

{\n    \"Done\": {\n        \"Violations\": [\n            {\n                \"IsSelfCertified\": true,\n                \"ViolationNote\": \"\",\n                \"ViolationRepairDate\": \"\",\n                \"InspectionViolationId\": 0,\n                \"ChecklistQuestionId\": 0,\n                \"ChecklistQuestionResponseId\": null,\n                \"ViolationFoundDate\": \"\",\n                \"OccupancyId\": 0,\n                \"FoundInInspectionId\": 0,\n                \"InspectionSeriesId\": 0,\n                \"TenantId\": 0,\n                \"ViolationRepaired\": true,\n                \"ViolationCodeId\": 0,\n                \"RepairedInInspectionId\": 0\n            }\n        ],\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        }\n    }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

GET /Primary/restapi/Tenant72/GetViolationByCodeId

This endpoint retrieves violation information based on the violation code ID.

Request

Method: GET
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant72/GetViolationByCodeId
\n
Query Parameters:
\n
- outputtype: Json
  \n
- ViolationCodeId: (integer) The ID of the violation code
  \n
\n

Response

The response for this request can be represented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Done\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"Violation\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"ViolationCodeId\": { \"type\": \"integer\" },\n            \"TenantId\": { \"type\": \"integer\" },\n            \"ViolationText\": { \"type\": \"string\" },\n            \"ViolationCodeSetId\": { \"type\": \"integer\" },\n            \"ViolationCodeText\": { \"type\": \"string\" },\n            \"ViolationChapter\": { \"type\": \"string\" },\n            \"ViolationCode\": { \"type\": \"string\" }\n          }\n        },\n        \"API Response\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"Description\": { \"type\": \"string\" },\n            \"ErrorCode\": { \"type\": \"string\" },\n            \"Status\": { \"type\": \"integer\" },\n            \"Message\": { \"type\": \"string\" }\n          }\n        }\n      }\n    }\n  }\n}\n\n

The response contains the \"Done\" object with \"Violation\" and \"API Response\" properties. The \"Violation\" object includes details about the violation, while the \"API Response\" object provides additional information about the API response.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

GET /Primary/restapi/Tenant72/GetSmokeDetectorInstallsByDate

This endpoint retrieves smoke detector installations within a specified date range.

Request

Method: GET
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant72/GetSmokeDetectorInstallsByDate
\n
Query Parameters:
\n
- outputtype: Json
  \n
- DateFrom (Date): The start date for the search.
  \n
- DateTo (Date): The end date for the search.
  \n
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"Done\": {\n    \"SmokeDetectorInstalls\": [\n      {\n        \"InspectionCompletedDate\": \"\",\n        \"TenantId\": 0,\n        \"isHidden\": true,\n        \"InspectionScheduleDate\": \"\",\n        \"OccupancyId\": 0,\n        \"InspectionId\": 0,\n        \"FieldType\": \"\",\n        \"isNotApplicable\": true,\n        \"InspectionSeriesId\": 0,\n        \"FieldTypeText\": \"\",\n        \"ResponseValue\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

The Done object contains an array of SmokeDetectorInstalls with various properties, and the API Response object provides additional information about the response status.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

Get Permits by Issue Date

This endpoint retrieves permits based on the issue date within a specified date range.

Request Parameters

outputtype: Specifies the output type, set to Json.
\n
DateFrom: Start date for filtering permits.
\n
DateTo: End date for filtering permits.
\n

Response

The response will contain an array of permits with the following fields:

PermitInvoiceId
\n
OccupancyId
\n
PermitRenewedId
\n
PermitFee
\n
PermitTypeId
\n
PermitRenewed
\n
OccupantLoad
\n
IssuedDate
\n
PermitStatusText
\n
InspectionSeriesId
\n
PermitNumber
\n
InspectionId
\n
PermitPaidDate
\n
PermitRenewedDate
\n
LastModifiedDate
\n
SquareFoot
\n
InspectorId
\n
PermitTypeText
\n
ExpirationDate
\n
PermitNote
\n
TenantId
\n
PermitId
\n
PermitStatusId
\n
EffectiveDate
\n

The API response object includes:

Description: Description of the API response.
\n
ErrorCode: Error code, if any.
\n
Status: Status of the response.
\n
Message: Additional message related to the response.
\n

Example Response:

{\n  \"Done\": {\n    \"Permits\": [\n      {\n        \"PermitInvoiceId\": \"\",\n        \"OccupancyId\": 0,\n        \"PermitRenewedId\": null,\n        \"PermitFee\": 0,\n        \"PermitTypeId\": 0,\n        \"PermitRenewed\": true,\n        \"OccupantLoad\": 0,\n        \"IssuedDate\": \"\",\n        \"PermitStatusText\": \"\",\n        \"InspectionSeriesId\": 0,\n        \"PermitNumber\": \"\",\n        \"InspectionId\": 0,\n        \"PermitPaidDate\": null,\n        \"PermitRenewedDate\": null,\n        \"LastModifiedDate\": \"\",\n        \"SquareFoot\": 0,\n        \"InspectorId\": \"\",\n        \"PermitTypeText\": \"\",\n        \"ExpirationDate\": \"\",\n        \"PermitNote\": \"\",\n        \"TenantId\": 0,\n        \"PermitId\": 0,\n        \"PermitStatusId\": 0,\n        \"EffectiveDate\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

API Request Description

This API endpoint makes an HTTP GET request to retrieve completed inspections within a specified date range. The request URL is https://process.firerecoveryusa.com/Primary/restapi/Tenant72/GetCompletedInspectionsByDate, and it expects the following query parameters:

outputtype (string): Specifies the format of the response. Should be set to \"Json\".
\n
DateFrom (string): The start date for the inspections to be retrieved.
\n
DateTo (string): The end date for the inspections to be retrieved.
\n

Request Body

This request does not contain a request body.

Response Body

The response will be in JSON format with a status code of 200. The response body includes the following structure:

Done (object): Contains the overall result of the API call.
\n
- API Response (object): Provides information about the API call status.
  \n
  - Description (string): A description of the API response (may be null).
    \n
  - ErrorCode (integer): An error code indicating the status of the request (may be null).
    \n
  - Status (integer): Indicates the status of the API response (0 for success).
    \n
  - Message (string): A message related to the API response (may be empty).
    \n
  \n
- CompletedInspections (array): An array of completed inspections, each containing:
  \n
  - ClientPropertyId (string): Identifier for the client property.
    \n
  - InspectionYearText (string): Text representation of the inspection year.
    \n
  - OccupancyId (integer): Identifier for the occupancy type.
    \n
  - ComplexInspectionId (string|null): Identifier for complex inspections (may be null).
    \n
  - InspectionYearId (integer): Identifier for the inspection year.
    \n
  - InspectionStartDate (string): The start date of the inspection.
    \n
  - PreviousInspectionId (integer): Identifier for the previous inspection.
    \n
  - InspectionTemplateId (integer): Identifier for the inspection template.
    \n
  - InspectionFee (integer): The fee associated with the inspection.
    \n
  - PropertyDeleted (boolean): Indicates if the property has been deleted.
    \n
  - NumberOfUnitsInspected (integer): Number of units inspected during the inspection.
    \n
  - InspectorId (string): Identifier for the inspector.
    \n
  - InspectionDeleted (boolean): Indicates if the inspection has been deleted.
    \n
  - InspectionTypeId (integer): Identifier for the type of inspection.
    \n
  - IsVacantInspection (boolean): Indicates if the inspection is for a vacant property.
    \n
  - InspectionStatusId (integer): Identifier for the inspection status.
    \n
  - InspectionCategoryText (string): Text description of the inspection category.
    \n
  - InspectionCompletedDate (string): The date when the inspection was completed.
    \n
  - PropertyMerged (boolean): Indicates if the property has been merged.
    \n
  - InspectionCategory (integer): Identifier for the inspection category.
    \n
  - ComplexResponsible (boolean): Indicates if the complex is responsible for the inspection.
    \n
  - TenantId (integer): Identifier for the tenant.
    \n
  - ComplexId (string|null): Identifier for the complex (may be null).
    \n
  - CustomerSignature (string): Customer's signature for the inspection.
    \n
  - InspectionAccountId (integer): Identifier for the inspection account.
    \n
  - InspectionReceivedDate (string): The date when the inspection was received.
    \n
  - InspectionTypeText (string): Text description of the inspection type.
    \n
  - InspectionReportSent (boolean): Indicates if the inspection report has been sent.
    \n
  - InspectionOriginalScheduleDate (string): The original scheduled date for the inspection.
    \n
  - SquareFootInspected (integer|null): The square footage inspected (may be null).
    \n
  - InspectionSeriesId (integer): Identifier for the inspection series.
    \n
  - VisitNumber (integer): The visit number of the inspection.
    \n
  - InspectionScheduledDate (string): The scheduled date for the inspection.
    \n
  - InspectionId (integer): Identifier for the inspection.
    \n
  - ComplexSectionId (string|null): Identifier for the complex section (may be null).
    \n
  - ContactId (integer): Identifier for the contact.
    \n
  - InspectionNote (string): Any notes related to the inspection.
    \n
  \n
\n

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"CompletedInspections\": [\n      {\n        \"ClientPropertyId\": \"\",\n        \"InspectionYearText\": \"\",\n        \"OccupancyId\": 0,\n        \"ComplexInspectionId\": null,\n        \"InspectionYearId\": 0,\n        \"InspectionStartDate\": \"\",\n        \"PreviousInspectionId\": 0,\n        \"InspectionTemplateId\": 0,\n        \"InspectionFee\": 0,\n        \"PropertyDeleted\": true,\n        \"NumberOfUnitsInspected\": 0,\n        \"InspectorId\": \"\",\n        \"InspectionDeleted\": true,\n        \"InspectionTypeId\": 0,\n        \"IsVacantInspection\": true,\n        \"InspectionStatusId\": 0,\n        \"InspectionCategoryText\": \"\",\n        \"InspectionCompletedDate\": \"\",\n        \"PropertyMerged\": true,\n        \"InspectionCategory\": 0,\n        \"ComplexResponsible\": true,\n        \"TenantId\": 0,\n        \"ComplexId\": null,\n        \"CustomerSignature\": \"\",\n        \"InspectionAccountId\": 0,\n        \"InspectionReceivedDate\": \"\",\n        \"InspectionTypeText\": \"\",\n        \"InspectionReportSent\": true,\n        \"InspectionOriginalScheduleDate\": \"\",\n        \"SquareFootInspected\": null,\n        \"InspectionSeriesId\": 0,\n        \"VisitNumber\": 0,\n        \"InspectionScheduledDate\": \"\",\n        \"InspectionId\": 0,\n        \"ComplexSectionId\": null,\n        \"ContactId\": 0,\n        \"InspectionNote\": \"\"\n      }\n    ]\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized
\n
- Description: This error indicates the user is not authorized to access the requested resource. This typically occurs when the user has not provided a valid subscription key, Client ID, or the provided token is invalid or expired.
\n
Error Response: 500 Internal Server Error
\n
- Description: Something internally has errored during the processing of your request. Please try again and if the issue persists, please contact our support.
\n

Purpose

The purpose of this request is to obtain a list of completed inspections that fall within the provided date range, allowing users to review inspection details and statuses.

Request Parameters

outputtype: A string parameter that specifies the format of the output. It should be set to \"Json\".
\n
DateFrom: A string parameter representing the start date for the inspection records to be retrieved.
\n
DateTo: A string parameter representing the end date for the inspection records to be retrieved.
\n

Expected Response Format

The response will be in JSON format with a status code of 200. The response body includes an object with the following structure:

Done: An object containing:
\n
- API Response: An object with details about the API call, including:
  \n
  - Description: A description of the API response (may be null).
    \n
  - ErrorCode: An error code if any issue occurred (may be null).
    \n
  - Status: An integer indicating the status of the API call.
    \n
  - Message: A message related to the API response (may be empty).
    \n
  \n
- CompletedInspections: An array of objects, each representing a completed inspection with the following fields:
  \n
  - ClientPropertyId: The ID of the client property.
    \n
  - InspectionYearText: Text representation of the inspection year.
    \n
  - OccupancyId: The ID representing the occupancy.
    \n
  - InspectionStartDate: The date when the inspection started.
    \n
  - InspectionCompletedDate: The date when the inspection was completed.
    \n
  - InspectionId: The unique identifier for the inspection.
    \n
  - InspectionStatusId: The status ID of the inspection.
    \n
  - IsVacantInspection: A boolean indicating if the inspection was for a vacant property.
    \n
  - Additional fields related to the inspection details.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"CompletedInspections\": [\n      {\n        \"ClientPropertyId\": \"\",\n        \"InspectionYearText\": \"\",\n        \"OccupancyId\": 0,\n        \"InspectionStartDate\": \"\",\n        \"InspectionCompletedDate\": \"\",\n        \"InspectionId\": 0,\n        \"InspectionStatusId\": 0,\n        \"IsVacantInspection\": true,\n        ...\n      }\n    ]\n  }\n}\n\n

Potential Errors

Error Response: 401 Unauthorized
\n
- Description: This error indicates the user is not authorized to access the requested resource. This typically occurs when the user has not provided a valid subscription key, Client ID, or the provided token is invalid or expired.
\n
Error Response: 500 Internal Server Error
\n
- Description: Something internally has errored during the processing of your request. Please try again, and if the issue persists, please contact our support.
\n

Request Description

This endpoint retrieves completed Community Risk Reduction (CRR) inspections that fall within a specified date range. The request is made using the HTTP GET method and requires two query parameters: DateFrom and DateTo, which define the start and end dates for filtering the inspections.

Request URL

GET https://process.firerecoveryusa.com/Primary/restapi/Tenant72/GetCompletedCRRInspectionsByDate?outputtype=Json&DateFrom={{DateFrom}}&DateTo={{DateTo}}\n\n

Expected Request Parameters

DateFrom (string): The start date for the inspection records to retrieve.
\n
DateTo (string): The end date for the inspection records to retrieve.
\n

Response Format

The response is returned in JSON format and includes the following structure:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"GetCompletedCRRInspectionsByDateV1_Result\": [\n      {\n        \"VisitNumber\": 0,\n        \"ClientPropertyId\": \"\",\n        \"PreviousInspectionId\": 0,\n        \"InspectionSeriesId\": 0,\n        \"OccupancyId\": 0,\n        \"InspectionId\": 0,\n        \"InspectionStatusId\": 0,\n        \"TenantId\": 0,\n        \"InspectionAccountId\": 0,\n        \"InspectionStartDate\": \"\",\n        \"InspectionTemplateId\": 0,\n        \"SquareFootInspected\": null,\n        \"PropertyMerged\": true,\n        \"NumberOfUnitsInspected\": 0,\n        \"RaceCode\": \"\",\n        \"InspectionFee\": 0,\n        \"HowToTestSmoke\": true,\n        \"DidTestSmoke\": true,\n        \"DidGiveEducationalInformation\": true,\n        \"InspectionReportSent\": true,\n        \"InspectionCategoryText\": \"\",\n        \"InspectionReceivedDate\": \"\",\n        \"NumberWorkingSmoke\": 0,\n        \"ContactId\": 0,\n        \"NumberSmokeInstalled\": 0,\n        \"InspectorId\": \"\",\n        \"InspectionNote\": \"\",\n        \"IsVacantInspection\": true,\n        \"PropertyDeleted\": true,\n        \"InspectionDeleted\": true,\n        \"InspectionYearId\": 0,\n        \"CustomerSignature\": \"\",\n        \"InspectionTypeId\": 0,\n        \"DidApproveInstall\": true,\n        \"NumberNonworkingSmoke\": 0,\n        \"InspectionCompletedDate\": \"\",\n        \"DoNotRemoveBattery\": true,\n        \"InspectionTypeText\": \"\",\n        \"InspectionOriginalScheduleDate\": \"\",\n        \"InspectionScheduledDate\": \"\",\n        \"InspectionYearText\": \"\",\n        \"InspectionCategory\": 0\n      }\n    ]\n  }\n}\n\n

Response Properties

Done: An object that contains the results of the API call.
\n
- API Response: Provides metadata about the API call.
  \n
  - Description: Additional information about the response (if any).
    \n
  - ErrorCode: Code indicating the error type (if any).
    \n
  - Status: Status code of the response.
    \n
  - Message: Message related to the API response.
    \n
  \n
- GetCompletedCRRInspectionsByDateV1_Result: An array of objects representing the completed CRR inspections.
  \n
  - Each object includes various properties such as VisitNumber, ClientPropertyId, InspectionId, and more, detailing the specifics of each inspection.
  \n
\n

Potential Errors

Error Response: 401 Unauthorized
\n
- Indicates that the user is not authorized to access the requested resource due to invalid or missing credentials.
\n
Error Response: 500 Internal Server Error
\n
- Indicates that an internal error occurred while processing the request. Users are advised to try again or contact support if the issue persists.
\n

This detailed description outlines the purpose of the request, the expected request parameters, and the structure of the response, making it easier for users to understand how to interact with the API.

API Endpoint: Get Commercial Occupancies

Method

POST

Endpoint

https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant72/getcommercialoccupancies

Description

This endpoint retrieves commercial occupancy data based on the specified pagination parameters. The request allows the user to define the output format and control the amount of data returned by specifying the page index and page count.

Request Parameters

The request body should be formatted as JSON and include the following parameters:

outputtype (string): Specifies the format of the output. For this endpoint, it should be set to \"Json\".
\n
PageIndex (integer): Indicates the index of the page to retrieve. This is useful for paginating through large sets of data.
\n
PageCount (integer): Specifies the number of records to return per page.
\n

Example Request Body

{\n  \"outputtype\": \"Json\",\n  \"PageIndex\": 1,\n  \"PageCount\": 100\n}\n\n

Response Format

Upon a successful request, the API will return a JSON response with the following structure:

Done (object): Contains the overall status of the API response.
\n
- API Response (object): Provides details about the API call.
  \n
  - Description (string): A description of the API response (if any).
    \n
  - ErrorCode (integer): An error code indicating the status of the request (0 indicates success).
    \n
  - Status (integer): The status of the API call (0 for success).
    \n
  - Message (string): A message related to the API response (if any).
    \n
  \n
\n
Occupancies (array): A list of occupancy objects, each containing various details about the commercial occupancies, including but not limited to:
\n
- OccupancyId (integer): Unique identifier for the occupancy.
  \n
- OccupancyName (string): Name of the occupancy.
  \n
- Address (string): Address details of the occupancy.
  \n
- isVacantProperty (boolean): Indicates if the property is vacant.
  \n
- LastInspectionDate (string): Date of the last inspection.
  \n
- OccupancySquarefoot (integer): Total square footage of the occupancy.
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Occupancies\": [\n      {\n        \"OccupancyId\": 0,\n        \"OccupancyName\": \"\",\n        \"Address\": \"\",\n        \"isVacantProperty\": true,\n        \"LastInspectionDate\": \"\",\n        \"OccupancySquarefoot\": 0\n      }\n    ]\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Primary","restapi","slipublicapi","productscustom","tenant72","getcommercialoccupancies"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"736d9cf4-9511-4a09-8e59-5df44b9b109b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DallasSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"PageIndex\":1,\r\n \"PageCount\":100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant72/getcommercialoccupancies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 23 Jul 2025 17:21:03 GMT"},{"key":"Server","value":"MyServer"},{"key":"Content-Encoding","value":"br"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-PlatformServerID","value":"FireRecoveryDev"},{"key":"X-ClusteringMode","value":"False"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; default-src 'self'; script-src https://beta.therecoveryhub.com https://*.firerecoveryusa.com https://process-dev.firerecoveryusa.com 'nonce-{nonce-value}' 'unsafe-eval'; img-src 'self' 'unsafe-inline' data:; style-src 'self' 'unsafe-inline' 'unsafe-eval'; font-src 'self' data:; worker-src 'self' 'unsafe-inline' blob:"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Permissions-Policy","value":"accelerometer=()"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains;preload"}],"cookie":[],"responseTime":null,"body":"{\n \"Done\": {\n \"API Response\": {\n \"Description\": null,\n \"ErrorCode\": null,\n \"Status\": 1,\n \"Message\": \"Success\"\n },\n \"Occupancies\": [\n {\n \"ConstructionTypeDriscription\": \"6 - III-B:Unprotected Combustible\",\n \"InspectionDistrictCode\": \"\",\n \"StructureTypeText\": null,\n \"NumberOfUnits\": 0,\n \"TenantId\": 72,\n \"OccupancySquarefoot\": 14982,\n \"DetectorPowerText\": null,\n \"LastInspectionId\": 377562,\n \"ClientOccupancyId\": \"6000113160\",\n \"DefaultInspectionTypeCode\": null,\n \"AHJText\": \"01 - Dallas\",\n \"LastModifiedDate\": \"2025-01-21T16:23:09.9650639\",\n \"City\": \"DALLAS\",\n \"InspectionDistrictText\": null,\n \"DefaultInspectionTypeDescrition\": null,\n \"StructureTypeCode\": \"\",\n \"Longitude\": -96.882994,\n \"BuildingStatusCode\": \"2\",\n \"OccupancyOwnershipCode\": \"\",\n \"FixedPropertyUseText\": \"579 - Motor vehicle or boat sales, services, repair\",\n \"PropertyCreationDate\": \"2018-01-27T19:41:17.71\",\n \"State\": \"TX\",\n \"AHJCode\": \"01\",\n \"BuildingClassCode\": \"B\",\n \"isVacantProperty\": false,\n \"Latitude\": 32.879383,\n \"AutomaticExtinguishingCode\": \"N\",\n \"DetectorPresentCode\": \"\",\n \"RoofCoveringCode\": \"\",\n \"StreetPrefix\": \"\",\n \"DetectorPowerCode\": \"\",\n \"FixedPropertyUseCode\": \"579\",\n \"BuildingClassText\": \"B - B-Building/occupancy for offices, professional or service use. Ambulatory care, bank, barber shop, education for students over 12th grade\",\n \"BusinessPermit\": \"\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"FloorsBelowGround\": 0,\n \"ZoneCode\": \"430099\",\n \"AutomaticExtingushingTypeText\": null,\n \"OccupancyOwnershipText\": null,\n \"Address2\": \"\",\n \"ZipCode\": \"75220\",\n \"AutomaticExtinguishingTypeCode\": \"\",\n \"RoofCoveringText\": null,\n \"OccupancyName\": \"Forless Autohaus\",\n \"AutomaticExtinguishingText\": \"N - None Present\",\n \"PropertyCategory\": \"Commercial\",\n \"ConstructionTypeCode\": \"6\",\n \"StreetName\": \"LADYBIRD\",\n \"StreetNumber\": \"2815\",\n \"ConstructionCompletedDate\": null,\n \"StationText\": \"43-2 - STATION 43\",\n \"ZoneText\": \"430099 - 430099\",\n \"LastInspectionDate\": \"2020-03-26T20:05:05.753\",\n \"OccupancyOccupantLoad\": 0,\n \"NextInspectionDate\": null,\n \"AutomaticExtinguishingNumberOfHeads\": 0,\n \"DistrictCode\": \"7\",\n \"MixedUseText\": \"58 - Business and residential use\",\n \"DetectorTypeText\": null,\n \"FloorsAboveGround\": 1,\n \"StreetSuffix\": \"\",\n \"APN\": \"\",\n \"DistrictText\": \"7 - FIRE DISTRICT 7\",\n \"DetectorTypeCode\": \"\",\n \"DetectorPresentText\": null,\n \"ComplexMainId\": null,\n \"MixedUseCode\": \"58\",\n \"StreetType\": \"LN\",\n \"PropertyNote\": \"CO #1712211109\",\n \"OccupancyId\": 327414,\n \"StationCode\": \"43-2\"\n },\n {\n \"ConstructionTypeDriscription\": \"5 - III-A:Protected Combustible\",\n \"InspectionDistrictCode\": \"5\",\n \"StructureTypeText\": \"1 - Enclosed building\",\n \"NumberOfUnits\": 0,\n \"TenantId\": 72,\n \"OccupancySquarefoot\": 26859,\n \"DetectorPowerText\": \"1 - Battery only\",\n \"LastInspectionId\": 633577,\n \"ClientOccupancyId\": \"6000317989\",\n \"DefaultInspectionTypeCode\": null,\n \"AHJText\": \"01 - Dallas\",\n \"LastModifiedDate\": \"2025-05-15T14:23:28.0299097\",\n \"City\": \"DALLAS\",\n \"InspectionDistrictText\": null,\n \"DefaultInspectionTypeDescrition\": null,\n \"StructureTypeCode\": \"1\",\n \"Longitude\": -96.768393,\n \"BuildingStatusCode\": \"2\",\n \"OccupancyOwnershipCode\": \"1\",\n \"FixedPropertyUseText\": \"311 - 24-hour care Nursing homes, 4 or more persons\",\n \"PropertyCreationDate\": \"2018-01-27T19:41:17.71\",\n \"State\": \"TX\",\n \"AHJCode\": \"01\",\n \"BuildingClassCode\": \"R4\",\n \"isVacantProperty\": false,\n \"Latitude\": 32.769404,\n \"AutomaticExtinguishingCode\": \"1\",\n \"DetectorPresentCode\": \"1\",\n \"RoofCoveringCode\": \"0\",\n \"StreetPrefix\": \"\",\n \"DetectorPowerCode\": \"1\",\n \"FixedPropertyUseCode\": \"311\",\n \"BuildingClassText\": \"R4 - R4-Buidling/occupancy 24 hr care for more than 5 but less than 16 persons\",\n \"BusinessPermit\": \"Health Care\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"FloorsBelowGround\": 0,\n \"ZoneCode\": \"60036\",\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\n \"OccupancyOwnershipText\": \"1 - Private\",\n \"Address2\": \"\",\n \"ZipCode\": \"75215\",\n \"AutomaticExtinguishingTypeCode\": \"1\",\n \"RoofCoveringText\": \"0 - Roof Covering Undetermined/Not Reported\",\n \"OccupancyName\": \"FAIR PARK HEALTH AND REHABILITATION\",\n \"AutomaticExtinguishingText\": \"1 - Present\",\n \"PropertyCategory\": \"Commercial\",\n \"ConstructionTypeCode\": \"5\",\n \"StreetName\": \"MARTIN LUTHER KING JR\",\n \"StreetNumber\": \"2815\",\n \"ConstructionCompletedDate\": null,\n \"StationText\": \"06-3 - STATION 6\",\n \"ZoneText\": \"60036 - 60036\",\n \"LastInspectionDate\": \"2025-05-13T16:50:02.523\",\n \"OccupancyOccupantLoad\": 0,\n \"NextInspectionDate\": \"2025-05-13T16:50:02.523\",\n \"AutomaticExtinguishingNumberOfHeads\": 0,\n \"DistrictCode\": \"5\",\n \"MixedUseText\": null,\n \"DetectorTypeText\": \"1 - Smoke\",\n \"FloorsAboveGround\": 1,\n \"StreetSuffix\": \"\",\n \"APN\": \"\",\n \"DistrictText\": \"5 - FIRE DISTRICT 5\",\n \"DetectorTypeCode\": \"1\",\n \"DetectorPresentText\": \"1 - Present\",\n \"ComplexMainId\": null,\n \"MixedUseCode\": \"\",\n \"StreetType\": \"BLVD\",\n \"PropertyNote\": \"10/25/2022- received permit #1246119 from financial services bureau. This location obtained their permit on 10/18/2022. Permit uploaded into Streamline this date. - Lt. Page\",\n \"OccupancyId\": 327419,\n \"StationCode\": \"06-3\"\n }\n ]\n }\n}"}],"_postman_id":"f5df4b85-5b80-49d0-941b-0151375e21e9"},{"name":"Get CRR Occupancies","id":"a4a89b8f-e0b6-4f2d-a470-fa2b5d76a690","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DallasSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"PageIndex\":1,\r\n \"PageCount\":100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://process.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant72/getcrroccupancies","description":"

API Endpoint: Get CRR Occupancies

Method

POST

URL

https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant72/getcrroccupancies

Description

This endpoint retrieves occupancy information based on the provided pagination parameters. It is designed to return a list of occupancies along with their associated details.

Request Parameters

The request body should be in JSON format and include the following parameters:

outputtype (string): Specifies the format of the output. For this endpoint, it should be set to \"Json\".
\n
PageIndex (integer): Indicates the current page index for pagination. The default value is 1.
\n
PageCount (integer): Defines the number of records to be returned per page. The default value is 100.
\n

Example Request Body

{\n  \"outputtype\": \"Json\",\n  \"PageIndex\": 1,\n  \"PageCount\": 100\n}\n\n

Response Format

Upon a successful request, the response will return a JSON object with the following structure:

Done (object): Contains the API response metadata.
\n
- API Response (object): Includes details about the response.
  \n
  - Description (string): A description of the response (may be null).
    \n
  - ErrorCode (integer): An error code if applicable (may be null).
    \n
  - Status (integer): The status of the response (0 indicates success).
    \n
  - Message (string): A message regarding the response (may be empty).
    \n
  \n
\n
Occupancies (array): An array of occupancy objects, each containing details such as:
\n
- ConstructionTypeDriscription (string): Description of the construction type.
  \n
- TenantId (integer): Identifier for the tenant.
  \n
- OccupancySquarefoot (integer): The square footage of the occupancy.
  \n
- isVacantProperty (boolean): Indicates if the property is vacant.
  \n
- Additional fields related to occupancy details.
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Occupancies\": [\n      {\n        \"ConstructionTypeDriscription\": \"\",\n        \"TenantId\": 0,\n        \"OccupancySquarefoot\": 0,\n        \"isVacantProperty\": true,\n        // Additional occupancy details...\n      }\n    ]\n  }\n}\n\n

Notes

Ensure to handle pagination correctly by adjusting the PageIndex and PageCount parameters as needed.
\n
The response may contain multiple occupancy objects, each with various attributes related to the occupancy details.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Primary","restapi","slipublicapi","productscustom","tenant72","getcrroccupancies"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"9c24e622-5e07-45c5-9789-98c1674a8a08","name":"Success","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DallasSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"PageIndex\":1,\r\n \"PageCount\":100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant72/getcrroccupancies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 23 Jul 2025 17:22:33 GMT"},{"key":"Server","value":"MyServer"},{"key":"Content-Encoding","value":"br"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-PlatformServerID","value":"FireRecoveryDev"},{"key":"X-ClusteringMode","value":"False"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; default-src 'self'; script-src https://beta.therecoveryhub.com https://*.firerecoveryusa.com https://process-dev.firerecoveryusa.com 'nonce-{nonce-value}' 'unsafe-eval'; img-src 'self' 'unsafe-inline' data:; style-src 'self' 'unsafe-inline' 'unsafe-eval'; font-src 'self' data:; worker-src 'self' 'unsafe-inline' blob:"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Permissions-Policy","value":"accelerometer=()"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000;includeSubDomains;preload"}],"cookie":[],"responseTime":null,"body":"{\n \"Done\": {\n \"API Response\": {\n \"Description\": null,\n \"ErrorCode\": null,\n \"Status\": 1,\n \"Message\": \"Success\"\n },\n \"Occupancies\": [\n {\n \"ConstructionTypeDriscription\": \"8 - V-B:Unprotected Wood Frame\",\n \"InspectionDistrictCode\": \"\",\n \"StructureTypeText\": null,\n \"NumberOfUnits\": null,\n \"TenantId\": 72,\n \"OccupancySquarefoot\": 1330,\n \"DetectorPowerText\": null,\n \"LastInspectionId\": 426481,\n \"ClientOccupancyId\": \"6000177983\",\n \"DefaultInspectionTypeCode\": null,\n \"AHJText\": \"01 - Dallas\",\n \"LastModifiedDate\": \"2022-12-13T10:21:36.5314349\",\n \"City\": \"DALLAS\",\n \"InspectionDistrictText\": null,\n \"DefaultInspectionTypeDescrition\": null,\n \"StructureTypeCode\": \"\",\n \"Longitude\": -96.896248,\n \"BuildingStatusCode\": \"2\",\n \"OccupancyOwnershipCode\": \"1\",\n \"FixedPropertyUseText\": null,\n \"PropertyCreationDate\": \"2018-01-27T19:41:17.71\",\n \"State\": \"TX\",\n \"AHJCode\": \"01\",\n \"BuildingClassCode\": \"\",\n \"isVacantProperty\": false,\n \"Latitude\": 32.787438,\n \"AutomaticExtinguishingCode\": \"\",\n \"DetectorPresentCode\": \"\",\n \"RoofCoveringCode\": \"\",\n \"StreetPrefix\": \"\",\n \"DetectorPowerCode\": \"\",\n \"FixedPropertyUseCode\": \"\",\n \"BuildingClassText\": null,\n \"BusinessPermit\": \"\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"FloorsBelowGround\": 0,\n \"ZoneCode\": \"160137\",\n \"AutomaticExtingushingTypeText\": null,\n \"OccupancyOwnershipText\": \"1 - Private\",\n \"Address2\": \"\",\n \"ZipCode\": \"75212\",\n \"AutomaticExtinguishingTypeCode\": \"\",\n \"RoofCoveringText\": null,\n \"OccupancyName\": \"4621 Bernal Dr\",\n \"AutomaticExtinguishingText\": null,\n \"PropertyCategory\": \"Community Risk\",\n \"ConstructionTypeCode\": \"8\",\n \"StreetName\": \"BERNAL\",\n \"StreetNumber\": \"4621\",\n \"ConstructionCompletedDate\": null,\n \"StationText\": \"16-2 - STATION 16\",\n \"ZoneText\": \"160137 - 160137\",\n \"LastInspectionDate\": \"2020-05-18T14:43:17.677\",\n \"OccupancyOccupantLoad\": 0,\n \"NextInspectionDate\": null,\n \"AutomaticExtinguishingNumberOfHeads\": 0,\n \"DistrictCode\": \"9\",\n \"MixedUseText\": null,\n \"DetectorTypeText\": null,\n \"FloorsAboveGround\": 2,\n \"StreetSuffix\": \"\",\n \"APN\": \"\",\n \"DistrictText\": \"9 - FIRE DISTRICT 9\",\n \"DetectorTypeCode\": \"\",\n \"DetectorPresentText\": null,\n \"ComplexMainId\": null,\n \"MixedUseCode\": \"\",\n \"StreetType\": \"DR\",\n \"PropertyNote\": \"\",\n \"OccupancyId\": 369778,\n \"StationCode\": \"16-2\"\n },\n {\n \"ConstructionTypeDriscription\": null,\n \"InspectionDistrictCode\": \"\",\n \"StructureTypeText\": null,\n \"NumberOfUnits\": 0,\n \"TenantId\": 72,\n \"OccupancySquarefoot\": 0,\n \"DetectorPowerText\": null,\n \"LastInspectionId\": null,\n \"ClientOccupancyId\": \"386267\",\n \"DefaultInspectionTypeCode\": null,\n \"AHJText\": null,\n \"LastModifiedDate\": \"2022-12-13T10:21:36.5314349\",\n \"City\": \"DALLAS\",\n \"InspectionDistrictText\": null,\n \"DefaultInspectionTypeDescrition\": null,\n \"StructureTypeCode\": \"\",\n \"Longitude\": -96.705812,\n \"BuildingStatusCode\": \"\",\n \"OccupancyOwnershipCode\": \"\",\n \"FixedPropertyUseText\": null,\n \"PropertyCreationDate\": \"2018-11-02T13:38:32.98\",\n \"State\": \"TX\",\n \"AHJCode\": null,\n \"BuildingClassCode\": \"\",\n \"isVacantProperty\": false,\n \"Latitude\": 32.715312,\n \"AutomaticExtinguishingCode\": \"\",\n \"DetectorPresentCode\": \"\",\n \"RoofCoveringCode\": \"\",\n \"StreetPrefix\": \"\",\n \"DetectorPowerCode\": \"\",\n \"FixedPropertyUseCode\": \"\",\n \"BuildingClassText\": null,\n \"BusinessPermit\": \"\",\n \"BuildingStatusText\": null,\n \"FloorsBelowGround\": 0,\n \"ZoneCode\": \"\",\n \"AutomaticExtingushingTypeText\": null,\n \"OccupancyOwnershipText\": null,\n \"Address2\": \"\",\n \"ZipCode\": \"75217\",\n \"AutomaticExtinguishingTypeCode\": \"\",\n \"RoofCoveringText\": null,\n \"OccupancyName\": \"6723 ATHA DR\",\n \"AutomaticExtinguishingText\": null,\n \"PropertyCategory\": \"Community Risk\",\n \"ConstructionTypeCode\": \"\",\n \"StreetName\": \"ATHA\",\n \"StreetNumber\": \"6723\",\n \"ConstructionCompletedDate\": null,\n \"StationText\": \"34-3 - STATION 34\",\n \"ZoneText\": \" - \",\n \"LastInspectionDate\": null,\n \"OccupancyOccupantLoad\": 0,\n \"NextInspectionDate\": null,\n \"AutomaticExtinguishingNumberOfHeads\": 0,\n \"DistrictCode\": \"8\",\n \"MixedUseText\": null,\n \"DetectorTypeText\": null,\n \"FloorsAboveGround\": 0,\n \"StreetSuffix\": \"\",\n \"APN\": \"\",\n \"DistrictText\": \"8 - FIRE DISTRICT 8\",\n \"DetectorTypeCode\": \"\",\n \"DetectorPresentText\": null,\n \"ComplexMainId\": null,\n \"MixedUseCode\": \"\",\n \"StreetType\": \"DR\",\n \"PropertyNote\": \"\",\n \"OccupancyId\": 386267,\n \"StationCode\": \"34-3\"\n }\n ]\n }\n}"}],"_postman_id":"a4a89b8f-e0b6-4f2d-a470-fa2b5d76a690"}],"id":"c296a1e0-4a15-4cce-a7a9-313e58210fba","description":"

This section describes the API end points for Dallas Fire-Rescue.

\n","event":[{"listen":"prerequest","script":{"id":"cf1732d5-6a47-4d24-ba88-25b7f8abd513","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"5423d479-4386-4166-8d76-4266a06b833d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"c296a1e0-4a15-4cce-a7a9-313e58210fba","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Heartland Fire and Rescue","item":[{"name":"Get Completed Inspections by Date","event":[{"listen":"prerequest","script":{"id":"b8290e9f-fbca-4988-8061-41ce5f40a468","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bfab201a-9287-43e6-85a0-5cbcec24582b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{HeartSubscriptionKey}}","type":"text"}],"url":"https://process.firerecoveryusa.com/Primary/restapi/SLI/Tenant60/GetInspectionsByDate?outputtype=Json&DateFrom={{DateFrom}}&DateTo={{DateTo}}","description":"

Get Inspections by Date

This endpoint retrieves a list of completed inspections within a specified date range for a specific tenant.

Request

Endpoint

GET https://process-dev.firerecoveryusa.com/Primary/restapi/SLI/Tenant60/GetInspectionsByDate

Query Parameters

outputtype: Json
\n
DateFrom: The start date for the inspection search.
\n
DateTo: The end date for the inspection search.
\n

Response

Upon a successful request, the server will respond with a status code of 200 and a JSON object containing the list of completed inspections and an API response object.

Response Body

{\n    \"Done\": {\n        \"CompletedInspections\": [\n            {\n                \"ScheduledDate\": \"\",\n                \"OccupancyCity\": \"\",\n                \"longitude\": 0,\n                \"PropertyId\": \"\",\n                \"InspectionType\": \"\",\n                \"CompletedDate\": \"\",\n                \"TypeOfVisit\": \"\",\n                \"InspectionNumber\": 0,\n                \"OccupancyName\": \"\",\n                \"latitude\": 0,\n                \"InspectionAccount\": \"\",\n                \"BuildingClassCode\": \"\",\n                \"Inspector\": \"\",\n                \"BuildingClassText\": \"\"\n            }\n        ],\n        \"API Response\": {\n            \"Description\": null,\n            \"ErrorCode\": null,\n            \"Status\": 0,\n            \"Message\": \"\"\n        }\n    }\n}\n\n

The response includes an array of completed inspections with details such as scheduled date, occupancy city, longitude, property ID, inspection type, completed date, type of visit, inspection number, occupancy name, latitude, inspection account, building class code, inspector, and building class text. Additionally, the API response object provides information about the status of the request, any error codes, and a message.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

The endpoint https://process-dev.firerecoveryusa.com/Primary/restapi/SLI/Tenant60/GetInspectionsByDate is a POST request that retrieves inspections based on a specified date range.

Request Body

outputtype (string): Specifies the output type as JSON.
\n
DateFrom (string): Represents the start date for the inspections.
\n
DateTo (string): Represents the end date for the inspections.
\n

Response

The response is a JSON object with the following structure:

{\n  \"Done\": {\n    \"CompletedInspections\": [\n      {\n        \"ScheduledDate\": \"\",\n        \"OccupancyCity\": \"\",\n        \"longitude\": 0,\n        \"PropertyId\": \"\",\n        \"InspectionType\": \"\",\n        \"CompletedDate\": \"\",\n        \"TypeOfVisit\": \"\",\n        \"InspectionNumber\": 0,\n        \"OccupancyName\": \"\",\n        \"latitude\": 0,\n        \"InspectionAccount\": \"\",\n        \"BuildingClassCode\": \"\",\n        \"Inspector\": \"\",\n        \"BuildingClassText\": \"\"\n      }\n    ],\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    }\n  }\n}\n\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Done\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"CompletedInspections\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"ScheduledDate\": { \"type\": \"string\" },\n              \"OccupancyCity\": { \"type\": \"string\" },\n              \"longitude\": { \"type\": \"number\" },\n              \"PropertyId\": { \"type\": \"string\" },\n              \"InspectionType\": { \"type\": \"string\" },\n              \"CompletedDate\": { \"type\": \"string\" },\n              \"TypeOfVisit\": { \"type\": \"string\" },\n              \"InspectionNumber\": { \"type\": \"number\" },\n              \"OccupancyName\": { \"type\": \"string\" },\n              \"latitude\": { \"type\": \"number\" },\n              \"InspectionAccount\": { \"type\": \"string\" },\n              \"BuildingClassCode\": { \"type\": \"string\" },\n              \"Inspector\": { \"type\": \"string\" },\n              \"BuildingClassText\": { \"type\": \"string\" }\n            }\n          }\n        },\n        \"API Response\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"Description\": { \"type\": [\"string\", \"null\"] },\n            \"ErrorCode\": { \"type\": [\"string\", \"null\"] },\n            \"Status\": { \"type\": \"number\" },\n            \"Message\": { \"type\": \"string\" }\n          }\n        }\n      }\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This section describes the API end points for Heartland Fire & Rescue

\n","_postman_id":"cb897f36-a237-4f7d-bd0c-2a71b3a3fcd2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"City of Weston Fire","item":[{"name":"Get Weston Commercial Occupancy Inspections By Date","event":[{"listen":"prerequest","script":{"id":"c344ce24-5471-4d3f-acc6-5476ffa99a99","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8f0e0d03-ea55-4ad5-b474-e83b21a24956","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{WestonSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"Request\": {\r\n \"StartDate\": \"{{DateFrom}}\",\r\n \"EndDate\": \"{{DateTo}}\",\r\n \"InspectionStatusId\": [\r\n 3\r\n ]\r\n }\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi/Tenant41/GetWestonCommercialOccupancyInspectionsByDate","description":"

Get Weston Commercial Occupancy Inspections By Date

This endpoint allows you to retrieve Weston commercial occupancy inspections within a specified date range.

Request

Method: POST
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi/Tenant41/GetWestonCommercialOccupancyInspectionsByDate
\n
Headers:
\n
- Content-Type: application/json
\n
Body:
\n
- outputtype (string): The type of output required (e.g. \"Json\").
  \n
- Request (object): The request object containing the following parameters:
  \n
  - StartDate (string): The start date for the inspections.
    \n
  - EndDate (string): The end date for the inspections.
    \n
  - InspectionStatusId (array of integers): An array of inspection status IDs.
    \n
  \n
\n

Response

The response for this request will be in JSON format, and will follow the schema provided by the user.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This endpoint makes an HTTP POST request to retrieve Weston commercial occupancy inspections for a specific tenant. The request body should be in raw JSON format and include the \"outputtype\" parameter set to \"Json\", along with the \"CommercialOccupancyInspectionsRequest\" object containing various filter criteria such as \"FiscalYearId\", \"OccupancyId\", \"InspectionSeriesId\", \"InspectionStatusId\", \"IsDeleted\", and \"IsVacant\".

The response will include the details of the commercial occupancy inspections based on the provided criteria.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This HTTP POST request is used to retrieve information about a Weston commercial occupancy inspection. The request body should be in raw format with the following parameters:

outputtype: (text) The type of output required, e.g., \"Json\".
\n
InspectionId: (text) The ID of the inspection, e.g., 0.
\n

The response will contain the details of the Weston commercial occupancy inspection.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This endpoint makes an HTTP POST request to retrieve information about Weston commercial occupancies for a specific tenant. The request body should include the \"outputtype\" parameter set to \"Json\", \"IsDeleted\" parameter set to \"false\", and \"IsVacant\" parameter set to \"false\". The response will contain the relevant information about the Weston commercial occupancies.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

The POST request is used to retrieve information about the Weston Commercial Occupancy. The request body should be in raw format and include the following parameters:

outputtype (string): Specifies the type of output required, in this case, it should be set to \"Json\".
\n
OccupancyId (number): Represents the unique identifier for the occupancy, with a default value of 0.
\n

The response will contain the relevant details about the Weston Commercial Occupancy based on the provided OccupancyId.

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This section describes the API end points for the City of Weston Fire

\n","_postman_id":"782e9986-fee6-4450-8e32-ccca6109f432","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"Decatur GIS","item":[{"name":"Get GIS Occupancies","event":[{"listen":"prerequest","script":{"id":"e6bd2322-b7c0-4354-818c-a4c5926f7673","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4fd9a7c9-d91d-456f-a941-d5ad2cf89485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DecaturSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"outputtype\": \"Json\",\r\n \"LastChangeDate\": \"{{DateFrom}}\"\r\n}"},"url":"https://process.firerecoveryusa.com/Primary/restapi/Tenant1764/GetGISOccupancies","description":"

GetGISOccupancies

This endpoint is used to retrieve GIS occupancies for a specific tenant.

Request Body

outputtype (string, required): The type of output required, in this case \"Json\".
\n
LastChangeDate (string, required): The date from which the changes are to be fetched.
\n

Response

The response will be in JSON format and will contain the following fields:

Done (object)
\n
- API Response (object): Contains information about the API response.
  \n
  - Description (string): Description of the response.
    \n
  - ErrorCode (string): Error code, if any.
    \n
  - Status (integer): Status of the response.
    \n
  - Message (string): Additional message, if any.
    \n
  \n
- Response (object): Contains the actual response data.
  \n
  - GISOccupancyList (array): List of GIS occupancies.
    \n
    - LastModifiedDate (string): Date of last modification.
      \n
    - isMerged (boolean): Indicates if the occupancy is merged.
      \n
    - Latitude (number): Latitude of the occupancy location.
      \n
    - ... (other fields with respective data types)
      \n
    \n
  - NewChangeDate (string): Date of the new change.
    \n
  \n
\n

Example Response

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Response\": {\n      \"GISOccupancyList\": [\n        {\n          \"LastModifiedDate\": \"\",\n          \"isMerged\": true,\n          \"Latitude\": 0,\n          ...\n        }\n      ],\n      \"NewChangeDate\": \"\"\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

GetGISInspections

This endpoint is used to retrieve GIS inspections for a specific tenant. It is an HTTP POST request to the specified URL.

Request Body

outputtype (string): Specifies the type of output required, in this case, it is set to \"Json\".
\n
LastChangeDate (string): Represents the date from which the changes are to be fetched. It uses a dynamic value \"{{DateFrom}}\".
\n

Response

The response will have a status code of 200 and a content type of \"application/json\". The response body will contain an array of GIS inspections under the key \"GetGISInspectionList\". Each object in the array represents a GIS inspection with various properties such as \"IsAVacantInspection\", \"InspectionCategoryText\", \"TenantId\", \"InspectionStatusText\", and more. Additionally, the response includes a \"NewChangeDate\" field for tracking changes.

Example Response:

{\n  \"Done\": {\n    \"API Response\": {\n      \"Description\": null,\n      \"ErrorCode\": null,\n      \"Status\": 0,\n      \"Message\": \"\"\n    },\n    \"Response\": {\n      \"GetGISInspectionList\": [\n        {\n          \"IsAVacantInspection\": true,\n          \"InspectionCategoryText\": \"\",\n          \"TenantId\": 0,\n          \"InspectionStatusText\": \"\",\n          ...\n        }\n      ],\n      \"NewChangeDate\": \"\"\n    }\n  }\n}\n\n

Potential Errors:

Error Response: 401 Unauthorized

Description:

Error Response: 500 Internal Server Error

Description:

Something internally has errored during the processing of your request. Please try again and if the issue persist, please contact our support.

This section describes the API end points for Decatur Fire Rescue.

\n","_postman_id":"a23ed5e2-7c1d-4f73-bb78-516d29a87c14","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}},{"name":"City of Durham","item":[{"name":"Get Inspected Occupancies","id":"6514f703-b7eb-43a6-851b-1a0463e39873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DurhamSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"outputtype\": \"Json\",\r\n \"isNeverInspected\": false,\r\n \"InspectedAfterDate\": \"5/25/2025\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://process.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/tenant8/getinspectedoccupancies","description":"

Endpoint Description

This endpoint allows users to retrieve inspected occupancy data for the City of Durham. It is specifically designed to filter the results based on certain criteria, such as whether the properties have been never inspected, as well as to specify a date after which inspections are considered.

Request Format

Method: POST
\n
URL: https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/cityofdurham/getinspectedoccupancies
\n
Request Body: The request must be sent in JSON format with the following parameters:
\n

{\n  \"outputtype\": \"Json\",\n  \"isNeverInspected\": boolean,   // Indicates if the occupancy has never been inspected\n  \"InspectedAfterDate\": string   // The date after which inspections are considered (format: MM/DD/YYYY)\n}\n\n

Response Format

Status Code: 200
\n
Content-Type: application/json
\n
Response Body: The response will return a JSON object containing the following structure:
\n

{\n  \"Done\": {\n    \"API Response\": {\n      \"Message\": string,         // Message related to the API response\n      \"Description\": string,     // Description of the API response\n      \"ErrorCode\": integer|null, // Error code if applicable\n      \"Status\": integer          // Status code of the response\n    },\n    \"CommercialOccupanciesList\": array, // List of commercial occupancies returned\n    \"InspectedAfterDate\": string|null    // Date used for filtering\n  }\n}\n\n

Notes

The CommercialOccupanciesList will contain an array of inspected occupancies based on the provided filters.
\n
The InspectedAfterDate in the response may return null if no specific date filtering was applied or if no results match the criteria.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Primary","restapi","slipublicapi","productscustom","tenant8","getinspectedoccupancies"],"host":["process","firerecoveryusa","com"],"query":[],"variable":[]}},"response":[{"id":"dcd21b71-548f-45e1-a530-a1eef1412175","name":"Success","originalRequest":{"method":"POST","header":[{"key":"ClientID","value":"{{clientId}}","type":"text"},{"key":"SubscriptionKey","value":"{{DurhamSubscriptionKey}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"outputtype\": \"Json\",\r\n \"isNeverInspected\": false,\r\n \"InspectedAfterDate\": \"5/25/2025\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://process-dev.firerecoveryusa.com/Primary/restapi/slipublicapi/productscustom/cityofdurham/getinspectedoccupancies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 11 Jun 2025 16:58:24 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Content-Encoding","value":"br"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-PlatformServerID","value":"FireRecoveryDev"},{"key":"X-ClusteringMode","value":"False"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://beta.therecoveryhub.com"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"Done\": {\n \"API Response\": {\n \"Message\": \"Success\",\n \"Description\": null,\n \"ErrorCode\": null,\n \"Status\": 1\n },\n \"CommercialOccupanciesList\": [\n {\n \"StreetNumber\": \"2543\",\n \"PropertyOwnershipCode\": \"\",\n \"BusinessPermit\": \"\",\n \"OccupancyNotes\": \"\",\n \"FixedPropertyUseCode\": \"142\",\n \"RoofCoveringText\": \"2 - Composition Shingles\",\n \"MixedUseCode\": \"\",\n \"OccupancyCategoryText\": \"Commercial Property\",\n \"isDeletedOccupancy\": false,\n \"ConstructionTypeCode\": \"7\",\n \"DefaultInspectionTypeText\": null,\n \"BuildingClassCode\": \"R-2\",\n \"OccupancyCategoryId\": 1,\n \"DetectorTypeCode\": \"1\",\n \"LastInspectionId\": 2449304,\n \"FloorsBelowGround\": 0,\n \"ZipCode\": \"27713-4217\",\n \"ConstructionCompletedDate\": null,\n \"AutomaticExtinguishingText\": \"1 - Present\",\n \"FloorsAboveGround\": 1,\n \"isMergedOccupancy\": false,\n \"AHJCode\": \"RES\",\n \"RoofCoveringCode\": \"2\",\n \"DetectorPowerCode\": \"5\",\n \"TenantId\": 8,\n \"DetectorTypeText\": \"1 - Smoke\",\n \"DetectorPresentCode\": \"1\",\n \"ComplexMainId\": null,\n \"DistrictText\": \"RES - Residential Inspection District\",\n \"OccupancyName\": \"Heights @ Meridian (club house)\",\n \"StationCode\": \"17\",\n \"InspectionDistrictText\": null,\n \"ConstructionTypeText\": \"7 - Protected Wood Frame\",\n \"ClientPropertyId\": \"0010293\",\n \"NumberOfUnits\": 0,\n \"InspectionDistrictCode\": \"RES\",\n \"StreetPrefix\": \"\",\n \"City\": \"Durham\",\n \"Longitude\": -78.903313,\n \"AutomaticExtinguishingCode\": \"1\",\n \"PropertyOwnershipText\": null,\n \"StructureTypeText\": \"1 - Enclosed building\",\n \"OccupancyOccupantLoad\": 1,\n \"DistrictCode\": \"RES\",\n \"BuildingClassText\": \"R-2 - R-2 (Apartments,Boarding >16,Fraternities)\",\n \"OccupancyCreationDate\": \"2015-04-22T15:09:11.43\",\n \"AutomaticExtinguishingNumberOfHeads\": 50,\n \"AHJText\": \"RES - Residential Inspection District\",\n \"StreetSuffix\": \"\",\n \"StructureTypeCode\": \"1\",\n \"OccupancySquarefoot\": 5000,\n \"APN\": \"\",\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\n \"Latitude\": 35.910809,\n \"OccupancyId\": 16189,\n \"StationText\": \"17 - Station #17\",\n \"StreetName\": \"Meridian\",\n \"BuildingStatusCode\": \"2\",\n \"Address2\": \"club house\",\n \"FixedPropertyUseText\": \"142 - Clubhouse\",\n \"StreetType\": \"Pkwy\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"DetectorPowerText\": \"5 - Plug-in with battery backup\",\n \"isVacantOccupancy\": false,\n \"LastInspectionDate\": \"2025-05-30T23:16:54.493\",\n \"State\": \"NC\",\n \"DefaultInspectionTypeCode\": null,\n \"ZoneCode\": \"ANN\",\n \"DetectorPresentText\": \"1 - Present\",\n \"AutomaticExtinguishingTypeCode\": \"1\",\n \"ZoneText\": \"ANN - Once every year\",\n \"MixedUseText\": null\n },\n {\n \"StreetNumber\": \"749\",\n \"PropertyOwnershipCode\": \"\",\n \"BusinessPermit\": \"\",\n \"OccupancyNotes\": \"\",\n \"FixedPropertyUseCode\": \"429\",\n \"RoofCoveringText\": \"7 - Built-Up\",\n \"MixedUseCode\": \"\",\n \"OccupancyCategoryText\": \"Commercial Property\",\n \"isDeletedOccupancy\": false,\n \"ConstructionTypeCode\": \"5\",\n \"DefaultInspectionTypeText\": null,\n \"BuildingClassCode\": \"R-2\",\n \"OccupancyCategoryId\": 1,\n \"DetectorTypeCode\": \"5\",\n \"LastInspectionId\": 2625650,\n \"FloorsBelowGround\": 0,\n \"ZipCode\": \"27705-4802\",\n \"ConstructionCompletedDate\": null,\n \"AutomaticExtinguishingText\": \"1 - Present\",\n \"FloorsAboveGround\": 3,\n \"isMergedOccupancy\": false,\n \"AHJCode\": \"RES\",\n \"RoofCoveringCode\": \"7\",\n \"DetectorPowerCode\": \"4\",\n \"TenantId\": 8,\n \"DetectorTypeText\": \"5 - More than one type present\",\n \"DetectorPresentCode\": \"1\",\n \"ComplexMainId\": null,\n \"DistrictText\": null,\n \"OccupancyName\": \"Berkshire Ninth\",\n \"StationCode\": \"2\",\n \"InspectionDistrictText\": null,\n \"ConstructionTypeText\": \"5 - Protected Ordinary\",\n \"ClientPropertyId\": \"0010738\",\n \"NumberOfUnits\": 0,\n \"InspectionDistrictCode\": \"\",\n \"StreetPrefix\": \"\",\n \"City\": \"Durham\",\n \"Longitude\": -78.922053,\n \"AutomaticExtinguishingCode\": \"1\",\n \"PropertyOwnershipText\": null,\n \"StructureTypeText\": \"1 - Enclosed building\",\n \"OccupancyOccupantLoad\": 1,\n \"DistrictCode\": \"\",\n \"BuildingClassText\": \"R-2 - R-2 (Apartments,Boarding >16,Fraternities)\",\n \"OccupancyCreationDate\": \"2015-04-22T15:09:11.43\",\n \"AutomaticExtinguishingNumberOfHeads\": 300,\n \"AHJText\": \"RES - Residential Inspection District\",\n \"StreetSuffix\": \"\",\n \"StructureTypeCode\": \"1\",\n \"OccupancySquarefoot\": 10000,\n \"APN\": \"\",\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\n \"Latitude\": 36.010107,\n \"OccupancyId\": 16599,\n \"StationText\": \"2 - Station #2\",\n \"StreetName\": \"9th\",\n \"BuildingStatusCode\": \"2\",\n \"Address2\": \"Bldg.6\",\n \"FixedPropertyUseText\": \"429 - Multifamily dwelling\",\n \"StreetType\": \"St\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"DetectorPowerText\": \"4 - Hardwire with battery backup\",\n \"isVacantOccupancy\": false,\n \"LastInspectionDate\": \"2025-05-30T09:12:47.833\",\n \"State\": \"NC\",\n \"DefaultInspectionTypeCode\": null,\n \"ZoneCode\": \"ANN\",\n \"DetectorPresentText\": \"1 - Present\",\n \"AutomaticExtinguishingTypeCode\": \"1\",\n \"ZoneText\": \"ANN - Once every year\",\n \"MixedUseText\": null\n },\n {\n \"StreetNumber\": \"801\",\n \"PropertyOwnershipCode\": \"\",\n \"BusinessPermit\": \"\",\n \"OccupancyNotes\": \"\",\n \"FixedPropertyUseCode\": \"429\",\n \"RoofCoveringText\": \"2 - Composition Shingles\",\n \"MixedUseCode\": \"\",\n \"OccupancyCategoryText\": \"Commercial Property\",\n \"isDeletedOccupancy\": false,\n \"ConstructionTypeCode\": \"7\",\n \"DefaultInspectionTypeText\": null,\n \"BuildingClassCode\": \"R-2\",\n \"OccupancyCategoryId\": 1,\n \"DetectorTypeCode\": \"\",\n \"LastInspectionId\": 2625651,\n \"FloorsBelowGround\": 0,\n \"ZipCode\": \"27713-8266\",\n \"ConstructionCompletedDate\": null,\n \"AutomaticExtinguishingText\": \"1 - Present\",\n \"FloorsAboveGround\": 2,\n \"isMergedOccupancy\": false,\n \"AHJCode\": \"RES\",\n \"RoofCoveringCode\": \"2\",\n \"DetectorPowerCode\": \"\",\n \"TenantId\": 8,\n \"DetectorTypeText\": null,\n \"DetectorPresentCode\": \"0\",\n \"ComplexMainId\": null,\n \"DistrictText\": null,\n \"OccupancyName\": \"Village @ Auburn Terrace (800)\",\n \"StationCode\": \"HQ\",\n \"InspectionDistrictText\": null,\n \"ConstructionTypeText\": \"7 - Protected Wood Frame\",\n \"ClientPropertyId\": \"0010797\",\n \"NumberOfUnits\": 0,\n \"InspectionDistrictCode\": \"\",\n \"StreetPrefix\": \"E\",\n \"City\": \"Durham\",\n \"Longitude\": -78.91401,\n \"AutomaticExtinguishingCode\": \"1\",\n \"PropertyOwnershipText\": null,\n \"StructureTypeText\": \"1 - Enclosed building\",\n \"OccupancyOccupantLoad\": 1,\n \"DistrictCode\": \"\",\n \"BuildingClassText\": \"R-2 - R-2 (Apartments,Boarding >16,Fraternities)\",\n \"OccupancyCreationDate\": \"2015-04-22T15:09:11.43\",\n \"AutomaticExtinguishingNumberOfHeads\": 100,\n \"AHJText\": \"RES - Residential Inspection District\",\n \"StreetSuffix\": \"\",\n \"StructureTypeCode\": \"1\",\n \"OccupancySquarefoot\": 500,\n \"APN\": \"\",\n \"AutomaticExtingushingTypeText\": \"1 - Wet-pipe sprinkler\",\n \"Latitude\": 35.916872,\n \"OccupancyId\": 16631,\n \"StationText\": \"HQ - Head Quarters\",\n \"StreetName\": \"Woodcroft\",\n \"BuildingStatusCode\": \"2\",\n \"Address2\": \"800\",\n \"FixedPropertyUseText\": \"429 - Multifamily dwelling\",\n \"StreetType\": \"Pkwy\",\n \"BuildingStatusText\": \"2 - In normal use\",\n \"DetectorPowerText\": null,\n \"isVacantOccupancy\": false,\n \"LastInspectionDate\": \"2025-05-30T21:25:27.81\",\n \"State\": \"NC\",\n \"DefaultInspectionTypeCode\": null,\n \"ZoneCode\": \"ANN\",\n \"DetectorPresentText\": \"0 - None Present\",\n \"AutomaticExtinguishingTypeCode\": \"1\",\n \"ZoneText\": \"ANN - Once every year\",\n \"MixedUseText\": null\n }\n ],\n \"InspectedAfterDate\": \"2025-05-31T18:52:28.423\"\n }\n}"}],"_postman_id":"6514f703-b7eb-43a6-851b-1a0463e39873"}],"id":"25476d19-731a-4137-a4bb-2fff2ff1558f","description":"

This section describes the API end points for City of Durham

\n","_postman_id":"25476d19-731a-4137-a4bb-2fff2ff1558f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}}],"id":"997ed145-b75b-4ebd-bcfd-162e7c857cca","description":"

The following section of the API documentation is for any and all custom API endpoints that have been setup for our clients to meet specific needs. Access to these APIs is restricted to those clients only

\n","_postman_id":"997ed145-b75b-4ebd-bcfd-162e7c857cca","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","id":"f302d63a-2a3a-4f88-8129-5afdd03b2d0e","name":"Streamline API Getting Started Guide","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"b5d9858e-eb71-4e89-926c-f1fd0e907bec","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"345af633-8099-4654-b1ac-627737cd6cfd","type":"text/javascript","packages":{},"exec":[""]}}]}

Login and Get JWT Token

Request Body

Response

Request Body

Response

Get Residential Occupancies

Request Body

Response

Request Body

Response

Request Body

Response Body

Response

Get Complex API

Request Body

Response

Get Commercial Occupancy Inspections

Request Body

Response

Example Response

Get Commercial Occupancy Inspections

Request Body

Response

Example Response

Get Commercial Occupancy Inspections By Date

Request Body

Response

Get Complex Inspection

Request Body

Response

Get Complex Inspections By Date

Request Body

Response

Example Response

Get Complex Inspections

Request Body

Response

POST /SLI/GeneralAPI/Risk/GetBackupsPowerSystems

Request Body

Response

Get Backup Power System

Request Body

Response

Example Response

Get Building Systems

Request

Response

Get Building System

Request Body

Response

Example

Get Department Accesses

Request Body

Response

Get Department Access

Request Body

Response

Example

Get Extinguishing System

Request Body

Response

Request Description

Response

Get Fire Alarm Systems

Request Body

Response

Example Response

Get Fire Alarm System

Request Body

Response

Get Chemical Occupancy Information

Request Body

Response

Endpoint Description

Request Body

Response

Get Informational Items

Request Body

Response

Occupancy Information Retrieval