Introduction
The Form Integration API enables the creation and updating of existing Forms within SafetyChain. This documentation focuses on basic form creation and update functionality.
Getting Started
All API requests require an authorization token – reference our Authentication page for more information
Form Work Flow Setup Information
There are three types of forms within SafetyChain: Check, Audit, Questionnaire.
- Check forms are the majority of forms built within SafetyChain and collect varying metrics of data (e.g. defect counts on products, sanitation performed on equipment prior to production, etc.).
- Questionnaire forms gather information from 3rd party business partners and may be about the partner or about a resource provided by the partner. Can only be used in conjuncture with Supplier Compliance module.
- Audit forms are favored for conducting internal or external audits against resources or partners (e.g. suppliers, brokers, etc.) using scoring systems based on the weighting of questions and answers.
All Forms within SafetyChain follow a three-step workflow when collecting data from the user:
- User selects one Resource (a collective catchall term to describe the business objects known as Customers, Equipment, Items and Suppliers within the UI) from the available list on the form.
- User optionally selects the Location if the Resource is associated with more than one Location (if only one Location is associated with a Resource or visible to the User the Location will be defaulted).
- Question(s), known as fields within SafetyChain, will display to the user to fill out.
SafetyChain's form building API calls have a one-to-one relationship with all of the settings and fields available within the UI (shown below).
