8.0 Json Schemas

8.1 Person

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "HookResponseOfPersonDto",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "subjectType": {
      "type": [
        "null",
        "string"
      ]
    },
    "changeType": {
      "type": [
        "null",
        "string"
      ]
    },
    "subjectFrontEndUrl": {
      "type": [
        "null",
        "string"
      ]
    },
    "timeStamp": {
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "data": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/PersonDto"
        }
      ]
    },
    "differences": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/Difference"
      }
    }
  },
  "definitions": {
    "PersonDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        },
        "givenName": {
          "type": [
            "null",
            "string"
          ]
        },
        "middleName": {
          "type": [
            "null",
            "string"
          ]
        },
        "familyName": {
          "type": [
            "null",
            "string"
          ]
        },
        "knownAs": {
          "type": [
            "null",
            "string"
          ]
        },
        "gender": {
          "type": [
            "null",
            "string"
          ]
        },
        "ethnicity": {
          "type": [
            "null",
            "string"
          ]
        },
        "dateOfBirth": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "maritalStatus": {
          "type": [
            "null",
            "string"
          ]
        },
        "nationality": {
          "type": [
            "null",
            "string"
          ]
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ]
        },
        "contactDetails": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/ContactDto"
            }
          ]
        },
        "address": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/AddressDto"
            }
          ]
        },
        "emergencyContact": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/EmergencyContactDto"
            }
          ]
        },
        "nextOfKin": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/NextOfKinDto"
            }
          ]
        },
        "employeeDetails": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/EmployeeDetailsDto"
            }
          ]
        },
        "isSample": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "isActive": {
          "type": "boolean"
        },
        "accountStatus": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "ContactDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "personalEmail": {
          "type": [
            "null",
            "string"
          ]
        },
        "workEmail": {
          "type": [
            "null",
            "string"
          ]
        },
        "dialingCode": {
          "type": [
            "null",
            "string"
          ]
        },
        "workMobile": {
          "type": [
            "null",
            "string"
          ]
        },
        "personalMobile": {
          "type": [
            "null",
            "string"
          ]
        },
        "homeTelephone": {
          "type": [
            "null",
            "string"
          ]
        },
        "workTelephone": {
          "type": [
            "null",
            "string"
          ]
        },
        "workExtension": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "AddressDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "addressLine1": {
          "type": [
            "null",
            "string"
          ]
        },
        "addressLine2": {
          "type": [
            "null",
            "string"
          ]
        },
        "town": {
          "type": [
            "null",
            "string"
          ]
        },
        "county": {
          "type": [
            "null",
            "string"
          ]
        },
        "country": {
          "type": [
            "null",
            "string"
          ]
        },
        "postCode": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "EmergencyContactDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "emergencyContactName": {
          "type": [
            "null",
            "string"
          ]
        },
        "emergencyContactTelephone": {
          "type": [
            "null",
            "string"
          ]
        },
        "emergencyRelationshipId": {
          "type": "integer",
          "format": "int32"
        },
        "emergencyContactConsent": {
          "type": "boolean"
        },
        "emergencyAddress": {
          "type": [
            "null",
            "string"
          ]
        },
        "emergencyMedicalNotes": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "NextOfKinDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Name": {
          "type": [
            "null",
            "string"
          ]
        },
        "Telephone": {
          "type": [
            "null",
            "string"
          ]
        },
        "RelationshipId": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        }
      }
    },
    "EmployeeDetailsDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "employeeStatus": {
          "type": [
            "null",
            "string"
          ]
        },
        "employmentType": {
          "type": [
            "null",
            "string"
          ]
        },
        "employmentNotes": {
          "type": [
            "null",
            "string"
          ]
        },
        "tag": {
          "type": [
            "null",
            "string"
          ]
        },
        "startDate": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "tenure": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "tenureName": {
          "type": [
            "null",
            "string"
          ]
        },
        "role": {
          "type": [
            "null",
            "string"
          ]
        },
        "teams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/definitions/TeamDto"
          }
        },
        "skills": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "externalIds": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "siteId": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "siteName": {
          "type": [
            "null",
            "string"
          ]
        },
        "groupId": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "groupName": {
          "type": [
            "null",
            "string"
          ]
        },
        "departmentId": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "departmentName": {
          "type": [
            "null",
            "string"
          ]
        },
        "manager": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/ManagerDto"
            }
          ]
        }
      }
    },
    "TeamDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "ManagerDto": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "Difference": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": [
            "null",
            "string"
          ]
        },
        "oldValue": {
          "type": [
            "null",
            "string"
          ]
        },
        "newValue": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    }
  }
}