GalaxyMobile Client API

<back to all web services

GetDependent

The following routes are available for this service:
GET/dependentRetrieve all dependent information from a user's profile.
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetDependent : ApiServiceRequest()
{
    /**
    * ID Number of the user to retrieve all dependent information from.
    */
    @ApiMember(Description="ID Number of the user to retrieve all dependent information from.", IsRequired=true)
    var IdNumber:String? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null
}

open class GetDependentResponse : ApiServiceResponse()
{
    /**
    * List of the user's dependents.
    */
    @ApiMember(Description="List of the user's dependents.")
    var Dependents:ArrayList<DependentData> = ArrayList<DependentData>()
}

open class ApiServiceResponse : IServiceResponse
{
    var Description:String? = null
    var Heading:String? = null
    var WasSuccessful:Boolean? = null
    var ModelState:Object? = null
}

open class DependentData
{
    /**
    * Dependent's Galaxy Id used for referring to or deleting.
    */
    @ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)
    var DependentId:Int? = null

    /**
    * Dependent's first name.
    */
    @ApiMember(Description="Dependent's first name.", IsRequired=true)
    var FirstName:String? = null

    /**
    * Dependent's surname.
    */
    @ApiMember(Description="Dependent's surname.", IsRequired=true)
    var Surname:String? = null

    /**
    * Dependent's mobile contact number.
    */
    @ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
    var MobileNumber:String? = null

    /**
    * Dependent's email address.
    */
    @ApiMember(Description="Dependent's email address.", IsRequired=true)
    var Email:String? = null

    /**
    * Depdendent's ID number.
    */
    @ApiMember(Description="Depdendent's ID number.", IsRequired=true)
    var IdNumber:String? = null
}

Kotlin GetDependent DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: {}
}