| GET | /dependent | Retrieve all dependent information from a user's profile. |
|---|
namespace CommonService.Api.Models.Base
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
member val Description:String = null with get,set
member val Heading:String = null with get,set
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ModelState:Object = null with get,set
[<AllowNullLiteral>]
type DependentData() =
///<summary>
///Dependent's Galaxy Id used for referring to or deleting.
///</summary>
[<ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)>]
member val DependentId:Int32 = new Int32() with get,set
///<summary>
///Dependent's first name.
///</summary>
[<ApiMember(Description="Dependent's first name.", IsRequired=true)>]
member val FirstName:String = null with get,set
///<summary>
///Dependent's surname.
///</summary>
[<ApiMember(Description="Dependent's surname.", IsRequired=true)>]
member val Surname:String = null with get,set
///<summary>
///Dependent's mobile contact number.
///</summary>
[<ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)>]
member val MobileNumber:String = null with get,set
///<summary>
///Dependent's email address.
///</summary>
[<ApiMember(Description="Dependent's email address.", IsRequired=true)>]
member val Email:String = null with get,set
///<summary>
///Depdendent's ID number.
///</summary>
[<ApiMember(Description="Depdendent's ID number.", IsRequired=true)>]
member val IdNumber:String = null with get,set
[<AllowNullLiteral>]
type GetDependentResponse() =
inherit ApiServiceResponse()
///<summary>
///List of the user's dependents.
///</summary>
[<ApiMember(Description="List of the user's dependents.")>]
member val Dependents:ResizeArray<DependentData> = new ResizeArray<DependentData>() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
[<AllowNullLiteral>]
type GetDependent() =
inherit ApiServiceRequest()
///<summary>
///ID Number of the user to retrieve all dependent information from.
///</summary>
[<ApiMember(Description="ID Number of the user to retrieve all dependent information from.", IsRequired=true)>]
member val IdNumber:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}