NGngpvan

/people/{vanId}/relationships

Changed on

Use this endpoint to create a single Relationship between two People.

The Person indicated in the body of the request is the “source” of the relationship, and the Person indicated in the URL route is the “destination” of the relationship. In this case, Person 7890123 is the mother of Person 123123.

If the Person specified in the URL route does not exist, this endpoint will return an error with HTTP Status Code 404 Not Found.

If the Relationship or Person specified in the request body are not available, this endpoint will return an error or errors with HTTP Status Code 400 Bad Request.

If successful, the endpoint responds with HTTP Status Code 204 No Content and an empty response body.

post/people/{vanId}/relationships

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{vanId}/relationships
  • Auth
    HTTP basic

Path parameters

vanIdstring required

Unique person identifier available in the current context

Request body

relationshipIdstring

Required; Unique identifier for an existing Relationship.

vanIdstring

Required; Unique identifier of the Person who is related to the Person from the URL route.

Response

204

Changes