Validator response schema - KostasMparmparousis/uLookup GitHub Wiki

Το παρακάτω JSON schema περιγράφει την δομή του response την οποία αναμένεται να επιστρέψει o Validator.

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "properties": {
    "Response code": {
      "type": "integer",
      "examples": [
        "100"
      ]
    },
    "message": {
      "type": "string",
      "examples": [
        "No Conflicts Found"
      ]
    },
    "conflicts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "null-value",
              "existing-login"
            ]
          },
          "description": {
            "type": "string",
            "examples": [
              "A record exists in 'SIS DB View' with the same loginName, but NULL SSN",
              "A record exists in 'SIS DB View' with the same loginName, but a different date of birth"
            ]
          },
          "conflictingData": {
            "type": "string",
            "examples": [
              "SSN",
              "birthDate"
            ]
          },
          "conflictingRecordKey": {
            "type": "string",
            "examples": [
              "registrationID=0002-07-003586,systemID=003586"
            ]
          },
          "conflictSource": {
            "type": "string",
            "examples": [
              "sis",
              "hrms"
            ]
          },
          "requestValue": {
            "type": "string",
            "examples": [
              "12312312312"
            ]
          },
          "conflictingValue": {
            "type": "string",
            "examples": [
              "12312312313"
            ]
          }
        }
      }
    },
    "personPairedWith": {
        "type": "array",
        "items": {
          "type": "string"
        }
    }
  }
}