Documentation for "/api/v1/ssts/licensed-businesses":

Documentation score: Route: 0% Fields: 85%

Description:

TODO

Search parameters:

One or more of the following search parameters may be specified when retrieving data:
Parameter nameRequiredDescription
advDesigner Identification of Advanced Designer License Held by Business
advInspector Identification of Advanced Inspector License Held by Business
city mailing address city name
county The county in which the business is located (not the service area)
designer Identification of (Basic) Designer License Held by Business
inspector Identification of (Basic) Inspector License Held by Business
installer Identification of Installer License Held by Business
intDesigner Identification of Intermediate Designer License Held by Business
intInspector Identification of Intermediate Inspector License Held by Business
licenseNumber Business License Number (L####) Also see orgId
licenseStatus status of the license
licensee name of the business's contact person
maintainer Identification of Maintainer License Held by Business
orgId Business's system ID (same as WIMN site_id)
orgName Licensed Business Name
service Identification of Service Provider License Held by Business
advDesignerFlag advanced designer (Y, N)
intDesignerFlag intermediate designer(Y, N)
designerFlag designer (Y, N)
advInspectorFlag advanced inspector(Y, N)
intInspectorFlag intermediate inspector(Y, N)
inspectorFlag inspector (Y, N)
installerFlag installer (Y, N)
maintainerFlag maintainer (Y, N)
serviceFlag service provider (Y, N)
pipelayerFlag pipelayer (Y, N)

Additional parameters:

The following, optional, parameters may be specified:
Parameter nameDescription
format The desired return format. Valid formats are: {json, jsonp, text, csv, xls, ods, and tab}. The default is json.
callback The JSONP callback function name (Note that format needs to be "jsonp").
fields The comma-separated-list of the field names to return from the query. The default is to return all available fields.
nullValue Value to substitute in place of null values. The default is to return null values as "null" (per JSON.org).
limit The number of records to limit the result set to. Behaves like the SQL standard LIMIT clause.
offset Used with Limit-- the record number to start retrieving from. Behaves like the SQL standard OFFSET clause.

Result Set Definitions:

Field nameDescription
address1 Licensed Business's Mailing Address Street Number and Name or PO Box
advDesigner Identification of Advanced Designer License Held by Business
advDesignerExpDate Expiration Date of Advanced Designer License Held by Business
advInspector Identification of Advanced Inspector License Held by Business
advInspectorExpDate Expiration Date of Advanced Inspector License Held by Business
bondCancelDate The date that the business's bond was cancled
bondCo The bonding company that holds the business's bond
bondFlag business holds a valid bond (Y/N)
bondPolicy the bond policy number
city mailing address city name
contactEmail Business contact email
contactPhone Business contact phone number
county The county in which the business is located (not the service area)
designer Identification of (Basic) Designer License Held by Business
designerExpDate Expiration Date of (Basic) Designer License Held by Business
inspector Identification of (Basic) Inspector License Held by Business
inspectorExpDate Expiration Date of (Basic) Inspector License Held by Business
installer Identification of Installer License Held by Business
installerExpDate Expiration Date of Installer License Held by Business
insuranceCo name of the business's insurance company
insuranceExpDate Expiration date of general liability insurance policy held by licensed business
insurancePolicy The business's insurance policy number
insuranceStatus the status of a business's insurance policy
insuranceCoWC name of the business's insurance company that holds the workers' compensation policy
insuranceExpDateWC Expiration Date of workers' compensation insurance policy held by licensed business
insurancePolicyWC The business's workers' compensation insurance policy number
insuranceStatusWC the status of a business's workers' compensation insurance policy
intDesigner Identification of Intermediate Designer License Held by Business
intDesignerExpDate Expiration Date of Intermediate Designer License Held by Business
intInspector Identification of Intermediate Inspector License Held by Business
intInspectorExpDate Expiration Date of Intermediate Inspector License Held by Business
licenseExpDate expiration date of the license
licenseExpReason reason that the license expired
licenseNumber Business License Number (L####) Also see orgId
licenseStatus status of the license
licenseSubmittalDate date the license application was submitted
licensee name of the business's contact person
maintainer Identification of Maintainer License Held by Business
maintainerExpDate Expiration Date of Maintainer License Held by Business
orgId Business's system ID (same as WIMN site_id)
orgName Licensed Business Name
phone Licensed Business phone number
service Identification of Service Provider License Held by Business
serviceExpDate Expiration Date of Service Provider License Held by Business
staffCount Number of certified staff employed
staff1 Name of Designated Certified Individual (employee)
staff1Cert Certification Number of Designated Certified Individual (employee)
staff2 Name of Designated Certified Individual (employee)
staff2Cert Certification Number of Designated Certified Individual (employee)
staff3 Name of Designated Certified Individual (employee)
staff3Cert Certification Number of Designated Certified Individual (employee)
staff4 Name of Designated Certified Individual (employee)
staff4Cert Certification Number of Designated Certified Individual (employee)
staff5 Name of Designated Certified Individual (employee)
staff5Cert Certification Number of Designated Certified Individual (employee)
staff6 Name of Designated Certified Individual (employee)
staff6Cert Certification Number of Designated Certified Individual (employee)
state business mailing address state code
title The relationship description of a business's licensee
zip business mailing address zip code
advDesignerFlag advanced designer (Y, N)
intDesignerFlag intermediate designer(Y, N)
designerFlag designer (Y, N)
advInspectorFlag advanced inspector(Y, N)
intInspectorFlag intermediate inspector(Y, N)
inspectorFlag inspector (Y, N)
installerFlag installer (Y, N)
maintainerFlag maintainer (Y, N)
serviceFlag service provider (Y, N)
pipelayerFlag pipelayer (Y, N)

Example Queries: