Update Community Education Information

PUT 
/community/:communityId/education

This endpoint updates a community member's education information.

For a list of all secondary levels, go to Lookup - Secondary Level

For a list of all national qualifications, go to Lookup - Qualification Level

For a list of all non-national qualifications, go to Lookup - Non National Qualification

Request

Path Parameters

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

application/json

Body

education stringrequired
qualifications stringrequired
lastYearOfStudy integernullablerequired

Possible values: >= 1900 and <= 3000

highestSecondaryLevel objectnullablerequired
Lookup - Secondary Level
id uuidrequired
highestQualificationLevel objectnullablerequired
Lookup - Qualification Level
id uuidrequired
highestNonNationalQualificationLevel objectnullablerequired
Lookup - Non National Qualification Level
id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
education stringnullablerequired
qualifications stringnullablerequired
lastYearOfStudy integernullablerequired
highestSecondaryLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
highestQualificationLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
highestNonNationalQualificationLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "education": "string",
    "qualifications": "string",
    "lastYearOfStudy": 0,
    "highestSecondaryLevel": {
      "id": "string",
      "description": "string"
    },
    "highestQualificationLevel": {
      "id": "string",
      "description": "string"
    },
    "highestNonNationalQualificationLevel": {
      "id": "string",
      "description": "string"
    }
  }
}

Successful

{
  "education": "Secondary education",
  "qualifications": "Graduate",
  "lastYearOfStudy": 2000,
  "highestSecondaryLevel": {
    "id": "e60954dd-3aa0-4944-86f4-7c9b8d5a535a",
    "description": "Year 9 or below"
  },
  "highestQualificationLevel": {
    "id": "635e9a5d-6ec6-49e1-b304-31979a33908c",
    "description": "Not stated/Unknown"
  },
  "highestNonNationalQualificationLevel": {
    "id": "fa55dbdb-65fe-4c03-bfcd-d8092ff41ebc",
    "description": "No formal Attainment"
  }
}

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