Return user schema json

Prerequisites

The fields must be set as API exposed on Field manager.

Expected return

This API will return a JSON payload with information on which fields are mandatory, their type, and the format of each one.

Example:

{
  "type": "object",
  "additionalProperties": false,
  "title": "User Json Schema",
  "description": "A user json schema with all valid fields for Integration of SignUp Manager.",
  "id": "user-schema.json",
  "required": [
    "lastName",
    "firstName",
    "communicationEmailAddress"
  ],
  "properties": {
    "startDateAtCompany": {
      "type": "string",
      "format": "date-time"
    },
    "lastName": {
      "type": "string"
    },
    "verifierEmail": {
      "type": "string",
      "format": "email",
      "description": "Enter firstname.lastname||Enter mailbox domain"
    },
    "experience": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "employmentEndDate"
          ],
          "properties": {
            "employmentEndDate": {
              "type": "string",
              "format": "date-time"
            }
          }
        }
      ]
    },
    "employmentStatus": {
      "type": "string"
    },
  }
}

Notes

Check https://json-schema.org/specification.html for further information.