| GET | /dependent | Retrieve all dependent information from a user's profile. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | query | string | Yes | ID Number of the user to retrieve all dependent information from. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dependents | form | List<DependentData> | No | List of the user's dependents. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DependentId | form | int | Yes | Dependent's Galaxy Id used for referring to or deleting. |
| FirstName | form | string | Yes | Dependent's first name. |
| Surname | form | string | Yes | Dependent's surname. |
| MobileNumber | form | string | Yes | Dependent's mobile contact number. |
| form | string | Yes | Dependent's email address. | |
| IdNumber | form | string | Yes | Depdendent's ID number. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /dependent HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Dependents:
[
{
DependentId: 0,
FirstName: String,
Surname: String,
MobileNumber: String,
Email: String,
IdNumber: String
}
],
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}