Overview of Person Register management using the Assure Customer API
The Assure Customer API can be used to automate the processes of managing Person Register records in Assure. The API is accessed via the internet as a secure RESTful API which is widely supported by integration platforms, ETL tools, and all programming and scripting languages, so it can be easily set up to integrate with external systems. Making use of the Customer API requires a level of technical expertise so this is typically something that a company’s IT function would handle.
The API functionality must be enabled by the Evotix team before you can use it. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring this feature.
HOW DOES IT WORK?
With the Customer API you can:
- Create new Person Register records
- Update existing Person Register records (including marking a person as ‘not current’)
- Delete Person Register records
Each of these operations requires you to make a request to the Customer API. A detailed user guide and supporting API schema is available, this detailing the API methods and the information required to use them.
WHAT DETAILS HAVE TO BE PROVIDED?
The minimum required fields are:
- Org Unit
- Reference
- Forename (First Name)
- Surname (Last Name)
- Plus any other fields which you have set as a mandatory requirement in the Person Register caption maintenance.
Other fields that can be set and will be defaulted if not supplied:
- Linked User Name
- Current
- Date of Birth
- Title
- Job Title
- Is Confidential
- Marital Status
- NI Number (Social Security Number)
- Nationality
- Shift
- Occupation
- Date of Hire
- Phone
- Mobile
- Type of Person
- Manager Name
- Manager Phone
- Age Range
- Address
- Address 2
- Address 3 (City, State)
- Town
- County
- Postcode (Zip Code)
- Location
- Locality
- Next of Kin Name
- Next of Kin Address 1
- Next of Kin Address 2
- Next of Kin Address 3 (Next of Kin City, State)
- Next of Kin Town
- Next of Kin County
- Next of Kin Postcode (Next of Kin Zip Code)
- Next of Kin Phone
- Next of Kin Relationship
- Next of Kin Mobile (Next of Kin Cell)
- Next of Kin Email
- Notes
- User Field 1
- User Field 2
OUT OF SCOPE
The following elements are currently out of scope:
- The Person Register reference field cannot be changed via the API. You can only create new records with a unique reference, or update records where there is an existing record for the reference provided.
- The Person Register reference field cannot be automatically assigned by the system when creating or updating records, it must be provided in the requests.
- Supporting items cannot be added via the API. This includes actions, attachments, notes, reviews, and links to policies and guidance. If there are default reviewers and approvers set up they will be automatically used on the creation of the record.
- It is not possible to add Project records to Person Register records in the Project Links section, via the API. Any Project records will need to be linked manually.
- Any default values set within the caption maintenance area are not taken into consideration by the API.
SETTING UP THE API- Before you can get started you need to request access from Evotix through your Customer Development or Customer Success Manager.
- You can create and manage your API authentication keys at any time in Assure. Check out this article for details API Key Management Article
- Set up the Customer API. Access the user guide here Assure Customer API User Guide
- Set up the Person Register API. Access the user guide here Customer API User Guide-Person Register API