SCRAM Nexus API Resource Guide

Validation

Required Field Validation

API expects input value for the fields which are marked as Required, this is also mentioned in the API documentation.

In case value not provided for such fields, API response will be returned as Bad Request along with a validation message “[Field Name] is required”

Free Text Validations

Input validations are in place for all the free text input for the API, allowed characters includes-

Letters- a-z, A-Z

Numbers- 0-9

Special Characters- !@#$%^&*()_=\-`~][{}|'”;:.,?$

Any other characters apart from these will be marked as invalid and API response will be returned as Bad Request along with a validation message “[Field Name] contains some characters which are not allowed”

Length Validation

Input value for the fields of type string are validated for the length, allowed length is also mentioned in the API documentation.

In case input value is not as per allowed length, API response will be returned as Bad Request along with a validation message “[Field Name] must be [char length] characters long”

Other Validations

Specific validations are in place for the structured field values like Email, Date etc.

In case of invalid input value, API response will return Bad Request along with a validation message

“[Field Name] is invalid”

Features

Currently Nexus Sync provide API’s to access the following client data elements

* Client Profile

* Client Notes

* Addresses

* Contacts

* Court Cases

* Protective Orders

* Profile Picture

* Lookup