Organisation Schema

GetOrganisationSchema

GET {{domain}}/api/v1/Schema/organisation

Gets the enforcement and validation schema for an organisation entity

Path Parameters

Name	Type	Description
clientId	string	Client Id of the application

200

{
  "message": "200",
  "data": {
    "clientId": "avitech",
    "entityName": "organisation",
    "schema": [
      {
        "attributeName": "RCNumber",
        "isRequired": true,
        "isValidated": true,
        "datatype": "string"
      },
      {
        "attributeName": "Address",
        "isRequired": true,
        "isValidated": false,
        "datatype": "string"
      }
    ]
  }
}

CreateOrganisationSchema

POST {{domain}}/api/v1/Schema/organisation

Creates the enforcement and validation schema for an organisation entity

Request Body

Name	Type	Description
	object	{ "clientId": "string", "entityName": "string", "schema": [ "attributeName":"string", "isRequired": boolean, "isValidated": boolean, "dataType": "string" ] }

200

{
  "message": "200",
  "data": true
}