Update Student Emergency Contact

PUT 
/students/:communityId/emergency-contact/:emergencyContactId

This endpoint updates a student’s emergency contact information including personal details and contact details.

If the emergency contacts are also existing community members, then only ‘contact order' will be able to be updated. If you are trying to update the contacts other details you will need to use the PUT Community Member endpoint.

Request

Path Parameters

communityId uuidrequired
Student id
Example: 46cb5481-6e20-4f17-b947-db81cdce9a4f
emergencyContactId uuidrequired
Emergency contact id
Example: 08b01352-2678-4e8a-bb40-b78696bf9128

application/json

Body

oneOf
StudentEmergencyContactWithCommunityMemberBody
contactType stringrequired
swapEmergencyContactOrder numbernullablerequired
The swapEmergencyContactOrder property is required if you need to update the emergency contact order. When provided, it will swap the contact order with the other emergency contact.
StudentEmergencyContactWithoutCommunityMemberBody
contactType string
name string
Possible values: non-empty
email stringnullable
address stringnullable
relationship objectnullable
id uuidrequired
swapEmergencyContactOrder numbernullable
The swapEmergencyContactOrder property is required if you need to update the emergency contact order. When provided, it will swap the contact order with the other emergency contact.
phones object[]nullable
Array [
phone stringnullablerequired
phoneOrder numberrequired
Possible values: [1, 2]
Can only be for Phone (1) and Alt Phone (2)
]

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
id uuidrequired
contactCommunityId uuidnullablerequired
contactOrder integerrequired
name stringrequired
schoolId stringnullablerequired
relationship objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
phones object[]required
Array [
phone stringrequired
phoneOrder numberrequired
Possible values: [1, 2]
Can only be for Phone (1) and Alt Phone (2)
id uuidrequired
]
email stringnullablerequired
address stringnullablerequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contactCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contactOrder": 0,
    "name": "string",
    "schoolId": "string",
    "relationship": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "code": "string"
    },
    "phones": [
      {
        "phone": "string",
        "phoneOrder": 1,
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "email": "string",
    "address": "string"
  }
}

Successful

{
  "code": "OK",
  "data": [
    {
      "name": "Mrs Jennifer Ngyuen",
      "address": "123 Education Avenue, Australia",
      "email": "mtuemail@email.com",
      "contactOrder": 1,
      "id": "eac8f3b6-3320-4519-a84a-03b869a3f063",
      "schoolId": "17",
      "contactCommunityId": null,
      "phones": [
        {
          "phone": "0456789012",
          "phoneOrder": 1,
          "id": "a4992bce-63e1-4116-8f72-f3a2d3ea09ed"
        }
      ],
      "relationship": {
        "id": "82a757fb-7442-42d5-b239-48dbce193920",
        "description": "Mother",
        "code": "MO"
      }
    }
  ]
}

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