This operation updates the information about the person.

Authorization

A valid JWT is required to access this method.

Request

PUT https://dev.medrecord.nl/profile/{mvUid}/relation/{relationId}

Path parameters

Parameter name Value Description Additional
mvUid string

The ID of the user

Required
relationId string

The ID of the relation. This can be a single numerical value or prefixed with party:relation:

Required

Request body

The request body takes a complete Single relation resource, containing the following writable properties:

{
    "birthDate": "date",
    "gender": "enum",
    "id": "string",
    "language": "language",
    "name": {
        "displayName": "string",
        "displayNameLetters": "string",
        "familyName": "string",
        "familyNameSpouse": "string",
        "givenName": "string",
        "honorificPostfix": "string",
        "honorificPrefix": "string",
        "initials": "string",
        "note": "html",
        "prefixFamilyName": "string",
        "prefixFamilyNameSpouse": "string"
    },
    "nationality": "external-enum",
    "note": "html",
    "type": "enum"
}

Properties

Name Type Description Additional
birthDate date

The date on which the person was born.

The date must be formatted using the ISO 8601 format (YYYY-MM-DD) or null when not specified.

optional
gender enum

The gender of the person.

Possible values are:

  • MALE
  • FEMALE
optional
id string

Address

optional
language language

The preferred language used to communicate with the person.

The language must contain a language tag according to RFC 3066 (ISO 639-1 with optional ISO 3166-1 alpha-2 code) or null when not specified.

optional
name object

The name of a person

See also: JSON schema.

required
name.displayName string

The name as shown on screen or in letters.

required
name.displayNameLetters string

The name to be shown on letters.

optional
name.familyName string

The family name.

optional
name.familyNameSpouse string

Spouses family name

optional
name.givenName string

Given name

optional
name.honorificPostfix string

Honorific Postfix

optional
name.honorificPrefix string

Honorific Prefix

optional
name.initials string

The initials of the person.

optional
name.note html

Note

optional
name.prefixFamilyName string

Prefix family name

optional
name.prefixFamilyNameSpouse string

Prefix spouses family name

optional
nationality external-enum

The nationality of the person.

The nationality must contain a valid ISO 3166-1 alpha-2 code or null when not specified.

optional
note html

A note about the user.

optional
type enum

Type

Possible values are:

  • DENTAL_SPECIALIST
  • FINANCIAL_REVIEWER
  • MIDWIFE
  • DIETICIAN
  • BEAUTICIAN
  • FRIEND
  • SECONDARY_CONTACT
  • FINANCIAL_AGENT
  • NURSE
  • MEDICAL_OFFICER
  • NEIGHBOUR
  • HEALER
  • PHYSIOTHERAPIST
  • PARENT
  • MENTOR
  • CURATOR
  • DENTIST
  • SPONSOR
  • FAMILY_MEMBER
  • REMEDIAL_THERAPIST
  • DOCTOR
  • SIBLING
  • SPECIALIST
  • LIVING_UNIT
  • PARTNER
  • GUARDIAN
  • HOME_CARE
  • MEDICAL_SPECIALIST
  • CHILD
  • OCCUPATIONAL_THERAPIST
  • HEALTHCARE_PROVIDER
  • OTHER
  • ADMINISTRATOR
  • PHARMACIST
  • EMPLOYER
  • FOSTER_PARENT
  • PRIMARY_CONTACT
  • HEIRS
  • PHYSICIAN_ASSISTANT
  • PSYCHOLOGIST
  • GENERAL_PRACTITIONER
  • SPEECH_THERAPIST
optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

Single relation

Explore this API

mvUid

The ID of the user

relationId

The ID of the relation. This can be a single numerical value or prefixed with party:relation:

body
Request Content-Type
Response Content-Type

Authorisation:

authToken JWT to be used for request.
Try it out!
pluslistarrow-leftglobe