Update Student Contact

PUT 
/students/:communityId/contact/:contactCommunityId

Updates a student’s contact information including flags for parent/guardian, day-to-day carer, lives with student, and contact channel preferences.

Request

Path Parameters

communityId uuidrequired
contactCommunityId uuidrequired

application/json

Body

sms booleanrequired
email booleanrequired
mail booleanrequired
reports booleanrequired
portalAccess booleanrequired
livesWithStudent booleanrequired
parentGuardian booleanrequired
caregiver booleanrequired
labels object[]nullablerequired
Array [
id uuidrequired
]
swapContactOrder integernullablerequired

The swapContactOrder property is required if you need to update the contact order. When provided, it will swap the contact order with the other contact.

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
id uuidrequired
schoolId stringrequired
photoId stringnullablerequired
givenName stringnullablerequired
surname stringnullablerequired
preferredName stringnullablerequired
otherGivenName stringnullablerequired
nameSuffix stringnullablerequired
title objectnullablerequired
id uuidrequired
description stringrequired
initials stringnullablerequired
displayName stringrequired
addressId uuidnullablerequired
addressFull stringnullablerequired
sms booleanrequired
defaultSMS stringnullablerequired
phone stringnullablerequired
phoneNumber object[]required
Array [
phoneType objectnullablerequired
id uuid
UUID of the phone contact type lookup
description string
The phone contact type (e.g. Home Phone, Personal Mobile, etc)
code string
The unique code indicating the phone contact type (e.g. PERSONALMOBILE)
value stringnullablerequired
Phone number
confidential booleanrequired
preferred booleanrequired
defaultSMS booleanrequired
Is this the default SMS number?
extension stringnullablerequired
Optional extension for the phone number
countryCode stringnullablerequired
The country calling code prefix for the phone number
country objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
email booleanrequired
emailToDisplay stringnullablerequired
mail booleanrequired
reports booleanrequired
portalAccess booleanrequired
contactCommunityId uuidrequired
contactOrder integerrequired
livesWithStudent booleanrequired
parentGuardian booleanrequired
caregiver booleanrequired
contactType stringrequired
relationship objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
labels object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
]
overrideLegalSurname stringnullablerequired
overrideMailFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullablerequired
maidenName stringnullablerequired
genderId uuidnullablerequired
gender stringnullablerequired
genderSortOrder numbernullablerequired
genderCode stringnullablerequired
genderSystemMeaning stringnullablerequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "schoolId": "string",
    "photoId": "string",
    "givenName": "string",
    "surname": "string",
    "preferredName": "string",
    "otherGivenName": "string",
    "nameSuffix": "string",
    "title": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string"
    },
    "initials": "string",
    "displayName": "string",
    "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "addressFull": "string",
    "sms": true,
    "defaultSMS": "string",
    "phone": "string",
    "phoneNumber": [
      {
        "phoneType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "value": "string",
        "confidential": true,
        "preferred": true,
        "defaultSMS": true,
        "extension": "string",
        "countryCode": "string",
        "country": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        }
      }
    ],
    "email": true,
    "emailToDisplay": "string",
    "mail": true,
    "reports": true,
    "portalAccess": true,
    "contactCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contactOrder": 0,
    "livesWithStudent": true,
    "parentGuardian": true,
    "caregiver": true,
    "contactType": "string",
    "relationship": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "code": "string"
    },
    "labels": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string"
      }
    ],
    "overrideLegalSurname": "string",
    "overrideMailFormat": {
      "id": 0,
      "description": "string"
    },
    "overrideSalutationFormat": {
      "id": 0,
      "description": "string"
    },
    "overrideSalutationPreferredFormat": {
      "id": 0,
      "description": "string"
    },
    "familyNamePrevious": "string",
    "maidenName": "string",
    "genderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "gender": "string",
    "genderSortOrder": 0,
    "genderCode": "string",
    "genderSystemMeaning": "string"
  }
}

Successful

{
  "code": "OK",
  "data": [
    {
      "sms": true,
      "email": true,
      "mail": true,
      "reports": true,
      "portalAccess": false,
      "livesWithStudent": true,
      "parentGuardian": true,
      "caregiver": null,
      "contactCommunityId": "79b774ba-4bac-46f6-a7cf-d29104a380a7",
      "contactOrder": 1,
      "schoolId": "16",
      "photoId": null,
      "contactType": "person",
      "givenName": "Garrick",
      "surname": "Addison",
      "preferredName": "Garrick",
      "otherGivenName": "Bashir",
      "nameSuffix": "Jr",
      "overrideLegalSurname": null,
      "overrideMailFormat": null,
      "overrideSalutationFormat": null,
      "overrideSalutationPreferredFormat": null,
      "familyNamePrevious": null,
      "maidenName": null,
      "phone": "+619632587",
      "phoneNumber": [
        {
          "id": "afa50fb5-102f-4935-a077-5f33058b2866",
          "phoneType": {
            "id": "3d3e529d-6c7d-41a7-85a9-3ac1d683f050",
            "code": "OCCUPATIONMOBILE",
            "description": "Occupation mobile"
          },
          "value": "041899967",
          "confidential": false,
          "preferred": false,
          "defaultSMS": true,
          "extension": null,
          "sortOrder": 2
        }
      ],
      "defaultSMS": null,
      "emailToDisplay": null,
      "addressFull": "3 Jade Court, BURWOOD EAST, VIC, 3151",
      "addressId": "38cbc3ba-122c-46b5-b512-9f19010b79e8",
      "title": {
        "id": "432a7034-a75a-49ea-a5fa-bb46cbe53ea6",
        "description": "Mr"
      },
      "initials": "GA",
      "displayName": "Mr Garrick Addison",
      "relationship": {
        "id": "fae58258-a307-4a49-b0aa-8008e273b632",
        "description": "Father",
        "code": "FR"
      },
      "labels": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10
  }
}

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...