Custom Schema

A custom schema lets you load data into GAINS, and read it back, when it fits none of the standard endpoints. GAINS sets the schema up for you; this page explains what you receive and the errors common to both directions.

What GAINS sets up

Your GAINS representative configures each custom schema and gives you:

Item	Example	Meaning
Route	`warehouse-zones`	The `{ApiRoute}` part of the endpoint path.
Attributes	`ZoneCode`, `LocationCode`, `Capacity`, `Refrigerated`, `Notes`	The field names your records use, spelled exactly as given.
Type of each attribute	`string`, `text`, `numeric`, `boolean`	How the value is checked (see How records are checked).
Required attributes	`ZoneCode`, `LocationCode`	Attributes every record must carry.
Task type	`WarehouseZones`	The `TaskType` the loads of this schema show on their tasks.

You cannot create or change a schema through the API. Ask your GAINS representative to add an attribute or a new route.

Loading and reading

To	See
Send records that match the schema, and see how they are checked	Custom Schema - Inbound
Read the records GAINS holds for the schema	Custom Schema - Outbound

Errors

Status	`Reason` begins with	What to do
`404`	`The route specified does not exist.`	Check the route name with your GAINS representative. Applies to `POST` and `GET`.
`424`	`The underlying schema has not yet been initialized.`	Retry later; contact your GAINS representative if it persists. Applies to `GET`.

Other errors are common to every endpoint; see Errors Handling & Exceptions.