Constituent

{
  "description": "Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.",
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "description": "The number of items available for retrieval into the collection after applying any request parameters. The <b>limit</b> and <b>offset</b> parameters do not affect the <b>count</b>, but to facilitate paging, they may affect the number of items in the <b>value</b> result set.",
      "type": "integer"
    },
    "next_link": {
      "description": "For paginated responses, the URI for the next page of results.",
      "type": "string"
    },
    "value": {
      "description": "The set of items included in the response. This may be a subset of the items in the collection.",
      "type": "array",
      "items": {
        "description": "Addresses store information about constituent residences and other addresses along with information about where or whether to send mail.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the address.",
            "type": "string"
          },
          "address_lines": {
            "description": "The address lines.",
            "type": "string"
          },
          "city": {
            "description": "The city of the address.",
            "type": "string"
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the address.",
            "type": "string"
          },
          "country": {
            "description": "The country of the address.",
            "type": "string"
          },
          "county": {
            "description": "The county of the address.",
            "type": "string"
          },
          "date_added": {
            "format": "date-time",
            "description": "The date when the address was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": true
          },
          "date_modified": {
            "format": "date-time",
            "description": "The date when the address was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
            "type": "string",
            "x-supports-datetime-offset": true
          },
          "do_not_mail": {
            "description": "Indicates whether the constituent requests not to be contacted at this address.",
            "type": "boolean"
          },
          "end": {
            "format": "date-time",
            "description": "The date when the constituent ceased to reside at this address. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "formatted_address": {
            "description": "This computed field retrieves the formatted address in the configured format of the country.",
            "type": "string"
          },
          "inactive": {
            "description": "This computed field indicates that the address is active if the current date is before any <code>end</code> date.",
            "type": "boolean"
          },
          "postal_code": {
            "description": "The postal code of the address.",
            "type": "string"
          },
          "preferred": {
            "description": "Indicates whether this is the constituent's preferred address.",
            "type": "boolean"
          },
          "seasonal_end": {
            "description": "The time of the year ceases to reside at this address.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "seasonal_start": {
            "description": "The time of year that the constituent begins residing at this address.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "start": {
            "format": "date-time",
            "description": "The date when the constituent began residing at this address. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "state": {
            "description": "The state of the address.",
            "type": "string"
          },
          "suburb": {
            "description": "The suburb of the address.",
            "type": "string"
          },
          "type": {
            "description": "The address type. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListAddressTypes\"><b>Address Types</b></a> table.",
            "type": "string"
          }
        },
        "x-display-name": "Address",
        "x-display-id": "Address",
        "x-additional-info": "\r\n<p>Some <b>Address</b> entity properties include international address support.</p>\r\n\r\n<div class=\"table-responsive\">\r\n    <table class=\"table table-striped table-hover\">\r\n        <thead>\r\n            <tr>\r\n                <th><strong>Property</strong></th>\r\n                <th><strong>United States</strong></th>\r\n                <th><strong>Canada</strong></th>\r\n                <th><strong>United Kingdom</strong></th>\r\n                <th><strong>Australia</strong></th>\r\n                <th><strong>New Zealand</strong></th>\r\n            </tr>\r\n        </thead>\r\n        <tbody>\r\n            <tr>\r\n                <td>address_lines</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>city</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>*</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>suburb</td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>state</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i>!</td>\r\n                <td></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>postal_code</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n            <tr>\r\n                <td>county</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td></td>\r\n                <td></td>\r\n            </tr>\r\n            <tr>\r\n                <td>country</td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n                <td><i class=\"fa fa-check\"></i></td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>\r\n\r\n<div class=\"footnotes\">\r\n    <p class=\"footnote\">* <b>Australia</b> &mdash; For <code>GET</code> operations, the <code>city</code> property returns city or suburb data. For <code>POST</code> and <code>PATCH</code> operations, you can use either the <code>suburb</code> or <code>city</code> properties, but not both. An error occurs if you provide values for both properties.</p>\r\n    <p class=\"footnote\">! <b>Canada</b> &mdash; Use the <code>state</code> property to track provinces.</p>\r\n</div>"
      }
    }
  },
  "x-hidden": true,
  "x-base-type": "#/definitions/ApiCollection"
}