GET
/
users
/
{user_id}
/
dependants
/
{dependant_id}
cURL
curl --request GET \
  --url http://localhost:8080/users/{user_id}/dependants/{dependant_id}
{
  "created_at": "<string>",
  "date_of_birth": "2000-01-15",
  "first_name": "<string>",
  "id": "<string>",
  "last_modified_at": "<string>",
  "last_name": "<string>",
  "previous_version_id": "<string>",
  "primary_user_id": "012345678901"
}

Path Parameters

​
user_id
string
required

User ID

​
dependant_id
string
required

Dependant ID

Response

Dependant found

​
created_at
string
required
​
date_of_birth
string
required
Example:

"2000-01-15"

​
first_name
string
required
​
gender
enum<string>
required

User gender.

Available options:
MALE,
FEMALE,
OTHER
​
id
string
required
​
last_modified_at
string
required
​
last_name
string
required
​
previous_version_id
string
required
​
primary_user_id
string
required

A validated 12-digit numeric user identifier.

Every external entry point validates:

  • JSON Deserialize runs [UserId::parse] (outer whitespace trimmed, length and digit-only enforced) via #[serde(try_from = "String")].
  • DB FromSql runs [UserId::parse] on every row read.

Display / Deref<Target = str> / AsRef<str> / Into<String> are derived via derive_more — the inner String is pass-through for every read-only borrow, display, and move-out.

Example:

"012345678901"

​
relationship
enum<string>
required

Relationship of a dependant to the primary user.

Available options:
SELF,
SPOUSE,
MOTHER,
FATHER,
CHILD,
FATHER_IN_LAW,
MOTHER_IN_LAW,
SIBLING
​
salutation
enum<string>
required

Title or honorific for a person.

Available options:
MR,
MRS,
MS,
MASTER
​
status
enum<string>
required

Dependant row lifecycle status.

Available options:
ACTIVE,
DISCARDED