Preferred Parent Relationship

Description

The Preferred Parent Relationship resource is used to read and to update a user's preferred relationship to a parent for a tree person.

Operations

GET - Read the preferred parent relationship for the given user and tree person.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
pid path The id of the tree person.
uid path The id of the user.
Status Codes
  • 204  -  No preference specified.
  • 301  -  If the person has been merged into another person.
  • 303  -  Upon a successful read.
  • 404  -  If the person is not found.
  • 410  -  If the person has been deleted.
  • 429  -  If the request was throttled.

PUT - Set the preferred parent relationship for the given user and tree person.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
Location header The URI of the preferred parent relationship. Required.
pid path The id of the tree person.
uid path The id of the user.
Status Codes
  • 204  -  The update was successful.
  • 404  -  If the person is not found.
  • 410  -  If the person has been merged or deleted.
  • 429  -  If the request was throttled.

DELETE - Delete the preferred parent relationship for the given user and tree person.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
pid path The id of the tree person.
uid path The id of the user.
Status Codes
  • 204  -  The delete was successful.
  • 404  -  If the requested preferred parent relationship reference is not found.
  • 429  -  If the request was throttled.

Example Requests

Delete Preferred Parent Relationship How to delete a user's preferred parent relationship for a person.
Read Preferred Parent Relationship How to read a user's preferred parent relationship for a person.
Update Preferred Parent Relationship How to set a user's preferred parent relationship for a person.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.