Documentation for "/api/v1/ssts/licensed-individual-mentor":

Documentation score: Route: 0% Fields: 75%

Description:

TODO

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
roleIdStudent Certified Individual's system ID ( same as the WIMN site_id )
certNumberStudent Certified Individual Certification Number (####)
certNumberMentor Certified Individual Certification Number (####)
licenseNumber Licensed business's License Number (####)

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
roleIdStudent Certified Individual's system ID ( same as the WIMN site_id )
certNumberStudent Certified Individual Certification Number (####)
relType the relationship type
relDesc A description of the relationship.
certNumberMentor Certified Individual Certification Number (####)
staffNameMentor The mentor's name
licenseNumber Licensed business's License Number (####)
busName The licensed business's name

Example Queries: