- SERVICE DESCRIPTION
This service provides integration with the Safety Forward platform through the GHUBEE interface. It enables company creation, driver creation, driver enrollment, driver status updates, and access to training courses and assigned driver courses.
- INTEGRATION SPECIFICATION
- Service Details
| Service Name | Create Company, Create Driver, Enroll Driver, Update Driver Status, Training Courses, Driver Courses |
| Context |
/safety-forward/create-company /safety-forward/create-driver /safety-forward/enroll-driver /safety-forward/update-driver-status /safety-forward/training-courses /safety-forward/driver-courses |
| Description | Provides endpoints to manage Safety Forward companies, drivers, enrollments, driver status updates, and access to training and course information. |
| Endpoint |
https://hml.ghubee.com/api/safety-forward/create-company https://hml.ghubee.com/api/safety-forward/create-driver https://hml.ghubee.com/api/safety-forward/enroll-driver https://hml.ghubee.com/api/safety-forward/update-driver-status https://hml.ghubee.com/api/safety-forward/training-courses https://hml.ghubee.com/api/safety-forward/driver-courses |
| Environment Specifications | https://ghubee.com/api |
| Protocol/Transport | HTTPS |
| Method | POST / GET |
| Representation format | JSON |
| Input/Output Interface or Both | Both |
| Data transformation | No |
- Assumption
The service must be invoked with all mandatory parameters correctly filled.
Authentication is required to access Safety Forward services through GHUBEE.
- Data input
Identification of the input data for the Safety Forward APIs.
| Field | Description | Format | Size | Required | Remarks |
| Token_Ghubee | Authentication token | Authorization Header | - | Yes | Bearer token |
| cName | Company name | Query Parameter | - | Conditional | Create company |
| cType | Company type | Query Parameter | 1 | Conditional | P = Production |
| add1 | Company address | Query Parameter | - | Conditional | Street address |
| city | City | Query Parameter | - | Conditional | Company location |
| state | State | Query Parameter | 2 | Conditional | State abbreviation |
| zip | ZIP code | Query Parameter | - | Conditional | Postal code |
| country | Country | Query Parameter | 2 | Conditional | ISO country code |
| phone | Phone number | Query Parameter | - | Conditional | Numeric only |
| Email address | Query Parameter | - | Conditional | Must be unique | |
| un | Username | Query Parameter | - | Conditional | User login |
| pw | Password | Query Parameter | - | Conditional | User password |
| coUUID | Company UUID | Query Parameter | - | Conditional | Driver and course APIs |
| emUUID | Employee UUID | Query Parameter | - | Conditional | Enrollment and status update |
| EnrollDate | Enrollment date | Query Parameter | - | Conditional | MM/DD/YYYY |
| ExpireDate | Expiration date | Query Parameter | - | Conditional | MM/DD/YYYY |
| RemindDate | Reminder date | Query Parameter | - | No | Optional |
| emStatus | Employee status | Query Parameter | 1 | Conditional | A = Active / I = Inactive |
| fedExID | Driver external ID | Query Parameter | - | Conditional | Driver identifier |
- Data input example
https://hml.ghubee.com/api/safety-forward/create-company
https://hml.ghubee.com/api/safety-forward/create-driver
https://hml.ghubee.com/api/safety-forward/enroll-driver
https://hml.ghubee.com/api/safety-forward/update-driver-status
https://hml.ghubee.com/api/safety-forward/training-courses
https://hml.ghubee.com/api/safety-forward/driver-courses
Content-Type: application/json
Accept: application/json
Authorization: Bearer token_ghubee
- Data output
Return of Safety Forward API output data.
| Field | Description | Format | Required | Remarks |
| status | Response status | String | Yes | Success / Error |
| message | Response message | String | Yes | Success description |
| data | Main response payload | Object / Array | Yes | Depends on endpoint |
| emuuid | Employee UUID | String | Conditional | Returned on driver actions |
| couuid | Company UUID | String | Conditional | Returned on company creation |
| submission_status | Submission result | Boolean | Conditional | True when processed |
| error_code_list | Error codes | Array | No | Null when success |
| error_array | Error details | Array | No | Empty when success |
| title | Training course title | String | Conditional | Courses endpoints |
| description | Training course description | String | Conditional | Courses endpoints |
| url | Course access URL | String | Conditional | Iframe path |
| success | Operation result | Boolean | Conditional | Enrollment confirmation |
- Error messages
Identification and description of error message types.
| Situation | Message Code | Message description |
| Unauthenticated | { "status": "Error", "message": "Unauthenticated", "data": null } | Authentication error with GHUBEE. |
| Integration not found | { "status": "Error", "message": "Integration not found", "data": null } | Invalid Safety Forward configuration. |
| Driver not found | { "status": "Error", "message": "Driver not found", "data": null } | The specified driver could not be identified. |