eedm.constituent-wealth-assessments.v9.0.constituent-wealth-assessments.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Constituent Wealth Assessments",
  "description" : "The assessments of constituents' overall wealth.",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the constituent wealth assessment.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "constituent" : {
      "title" : "Constituent",
      "description" : "The constituent for whom the wealth assessment applies.",
      "oneOf" : [ {
        "title" : "one Of-1",
        "description" : "The person for whom the wealth assessment applies.",
        "type" : "object",
        "properties" : {
          "person" : {
            "title" : "Person",
            "description" : "The person for whom the wealth assessment applies.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Person.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/constituent-persons/{id}",
              "targetSchema" : {
                "$ref" : "constituent-persons.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "person" ]
      }, {
        "title" : "One Of-2",
        "description" : "The organization to which the wealth assessment applies.",
        "type" : "object",
        "properties" : {
          "organization" : {
            "title" : "Organization",
            "description" : "The organization to which the wealth assessment applies.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Organization.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/constituent-organizations/{id}",
              "targetSchema" : {
                "$ref" : "constituent-organizations.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "organization" ]
      } ]
    },
    "wealthRange" : {
      "title" : "Wealth Range",
      "description" : "The range within which the constituent's overall wealth falls.",
      "type" : "object",
      "properties" : {
        "id" : {
          "title" : "ID",
          "description" : "The global identifier for the Wealth Range.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      },
      "links" : [ {
        "rel" : "self",
        "href" : "/advancement-currency-ranges/{id}",
        "targetSchema" : {
          "$ref" : "advancement-currency-ranges.json#"
        }
      } ],
      "additionalProperties" : false,
      "required" : [ "id" ]
    },
    "informationDate" : {
      "title" : "Information Date",
      "description" : "The date of the information of the wealth assessment.",
      "type" : "string",
      "format" : "date",
      "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
    },
    "confidenceLevel" : {
      "title" : "Confidence Level",
      "description" : "The level of confidence in the constituent's wealth information.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Confidence Level.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/wealth-assessment-confidence-levels/{id}",
          "targetSchema" : {
            "$ref" : "wealth-assessment-confidence-levels.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "source" : {
      "title" : "Source",
      "description" : "The source that provided the wealth assessment information.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Source.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/advancement-sources/{id}",
          "targetSchema" : {
            "$ref" : "advancement-sources.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    }
  },
  "required" : [ "id", "constituent", "wealthRange", "informationDate" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "constituent-wealth-assessments",
    "method" : "GET",
    "title" : "Constituent Wealth Assessments",
    "description" : "The assets associated with a constituent.",
    "href" : "/constituent-wealth-assessments?constituentWealthAssessments.id={id}",
    "schema" : {
      "type" : "object",
      "properties" : {
        "constituent" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    }
  } ]
}