Make sure the addressId field in the data matches the address ID in the URL.

Authorization

A valid JWT is required to access this method.

Request

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

Path parameters

Parameter name Value Description Additional
mvUid string

The ID of the user

Required
relationId string

The ID of the relation

Required
addressId string

The ID of the address

Required

Request body

The request body takes a complete The address of a person resource, containing the following writable properties:

{
    "country": "string",
    "label": "string",
    "lat": "double",
    "lng": "double",
    "locality": "string",
    "note": "html",
    "postalCode": "string",
    "region": "string",
    "streetAddress": "string",
    "usage": "enum"
}

Properties

Name Type Description Additional
country string

The country the person lives in.

The country is encoded using an ISO 3166-1 alpha-2 country code. The field is null when no value was set.

optional
label string

.

The field is null when no label was provided.

optional
lat double

.

The field contains null when no latitude was provided.

optional
lng double

.

The field contains null when no longitude was provided.

optional
locality string

The city or locality.

The field contains null when no city was provided.

optional
note html

.

The field contains null when no note was provided.

optional
postalCode string

.

The field contains null when no postal code was provided.

optional
region string

The region or province.

The field contains null when no region was provided.

optional
streetAddress string

.

The field contains null when no address was provided.

optional
usage enum

Intended usage

Possible values are:

  • POSTAL
  • HOME
required

Response

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

Status code Description Resource
200 OK

Success

The address of a person

Explore this API

mvUid

The ID of the user

relationId

The ID of the relation

addressId

The ID of the address

body
Request Content-Type
Response Content-Type

Authorisation:

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