Update Community Demographic Information

PUT 
/community/:communityId/demographic-info

Updates a community member’s demographic information.

The demographics section is only for Person community member.

For a list of all religions, go to Lookup - Religion

For a list of all indigenous status, go to Lookup - Indigenous Status

For a list of all parish, go to Lookup - Parish

For a list of all regions, go to Lookup - Region, OverrideRegion is a boolean value which is required if the region is to be overridden. When set to false, the region would be determined by the address. Set it to true if updating the region.

For a list of all birth countries, go to Lookup - Country

For a list of all home languages, go to Lookup - Languages

For a list of all nationalities, go to Lookup - Nationality

Request

Path Parameters

communityId uuidrequired
Community id
Example: 46cb5481-6e20-4f17-b947-db81cdce9a4f

application/json

Body

overrideRegion booleanrequired

This is a boolean value which is required if the region is to be overridden. When set to false, the region would be determined by the address. Set it to true if updating the region field below.

region objectnullablerequired

id uuid

Lookup - Region

religion objectnullablerequired

id uuid

Lookup - Religion

parish objectnullablerequired

id uuid

Lookup - Parish

birthCountry objectnullablerequired

id uuid

Lookup - Country

indigenousStatus objectnullablerequired

id uuid

Lookup - Indigenous Status

nationalities object[]nullablerequired
Array [
id uuid
Lookup - Nationality
]
homeLanguages object[]nullablerequired
Array [
id uuid
Lookup - Languages
]

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data objectnullable
overrideRegion booleanrequired
religion objectnullablerequired
id stringnullablerequired
description stringnullablerequired
indigenousStatus objectnullablerequired
id stringnullablerequired
description stringnullablerequired
parish objectnullablerequired
id stringnullablerequired
description stringnullablerequired
region objectnullablerequired
id stringnullablerequired
description stringnullablerequired
birthCountry objectnullablerequired
id stringnullablerequired
description stringnullablerequired
addresses object[]nullablerequired
Array [
systemMeaning stringnullablerequired
The type of address: 'Postal' for postal addresses, 'Home' for residential addresses, or null for other custom types.
id uuidrequired
UUID of the community member's address record
addressId uuidrequired
UUID of the record containing details for a given address (street name/number, postcode, etc)
addressType objectnullablerequired
The lookup for the address type (null if systemMeaning is not 'home' or 'postal')
id
UUID of the address type lookup
description
The address type (e.g. Alternative Home Address, Occupation Address, etc)
code
The address type code (e.g. ALT, OCC)
addressLine1 stringnullablerequired
addressLine2 stringnullablerequired
addressLine3 stringnullablerequired
suburb stringnullablerequired
Burwood East
postalCode stringnullablerequired
confidential booleannullablerequired
country objectnullablerequired
id
UUID of the country lookup
description
Country name (e.g. Australia)
code
Country code (e.g. AU)
state objectnullablerequired
id
UUID of the state lookup
description
State name (e.g. Tasmania)
code
Country code (e.g. TAS)
displayAddressComma stringrequired
The community member's full address with commas separating the fields
displayAddressFull stringrequired
The community member's full address with each field on a new line
]
homeLanguages object[]required
Array [
id uuidrequired
language objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
nationalities object[]required
Array [
id uuidrequired
nationality objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "overrideRegion": true,
    "religion": {
      "id": "string",
      "description": "string"
    },
    "indigenousStatus": {
      "id": "string",
      "description": "string"
    },
    "parish": {
      "id": "string",
      "description": "string"
    },
    "region": {
      "id": "string",
      "description": "string"
    },
    "birthCountry": {
      "id": "string",
      "description": "string"
    },
    "addresses": [
      {
        "systemMeaning": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "addressType": {},
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "suburb": "string",
        "postalCode": "string",
        "confidential": true,
        "country": {},
        "state": {},
        "displayAddressComma": "string",
        "displayAddressFull": "string"
      }
    ],
    "homeLanguages": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "language": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "sortOrder": 0
      }
    ],
    "nationalities": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "nationality": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "sortOrder": 0
      }
    ]
  }
}

Successful

{
  "overrideRegion": true,
  "religion": {
    "id": "df4328e6-3d98-40ca-8d75-1bd743ef28ae",
    "description": "Anglican Church of Australia"
  },
  "indigenousStatus": null,
  "parish": {
    "id": "ba2f17a0-5fd3-4089-a77e-cacdea00673d",
    "description": "Alexandra"
  },
  "region": {
    "id": "6de6253b-3e5d-4b8b-a24a-944c26ff5171",
    "description": "Region 2"
  },
  "birthCountry": {
    "id": "16163f09-75a9-4b4a-a773-63f7b1767cd9",
    "description": "Afghanistan"
  },
  "addresses": [
    {
      "systemMeaning": "home",
      "id": "61302062-8648-41f8-92f4-a349a7b3be87",
      "addressId": "d19702ce-08aa-4a1a-81dd-3a931702f945",
      "addressType": null,
      "addressLine1": "123 Taradale Road",
      "addressLine2": "Apartment 4b",
      "addressLine3": "",
      "suburb": "Cranbourne North",
      "postalCode": "3977",
      "confidential": false,
      "country": {
        "id": "385df538-66fc-45b9-860c-65f01314aber",
        "description": "New Zealand",
        "code": "NZ"
      },
      "state": {
        "id": "1ec93d5d-f2ea-4aa4-8c1e-1b0eec8ad193",
        "description": "Otago",
        "code": "NZ-OTA"
      },
      "displayAddressComma": "123 Taradale Road, Apartment 4b, CRANBOURNE NORTH, NZ-OTA, 3977, New Zealand",
      "displayAddressFull": "123 Taradale Road\nApartment 4b\nCRANBOURNE NORTH\nNZ-OTA\n3977\nNew Zealand"
    }
  ],
  "homeLanguages": [
    {
      "id": "2dfe62c6-e68d-44f9-9657-97f91916b868",
      "language": {
        "id": "64a48038-517f-4f28-a057-f971bdb7b3dd",
        "description\"": "Welsh",
        "code": "1063"
      },
      "sortOrder": null
    }
  ],
  "nationalities": [
    {
      "id": "c811a5c6-b169-419a-84ee-19f9c239fdec",
      "nationality": {
        "id": "60e38915-0850-4af7-96b9-e564b8abea9s",
        "description": "American",
        "code": "US"
      },
      "sortOrder": null
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...