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.
"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Heading;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {Object} */
    ModelState;
}
export class DependentData {
    /** @param {{DependentId?:number,FirstName?:string,Surname?:string,MobileNumber?:string,Email?:string,IdNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Dependent's Galaxy Id used for referring to or deleting. */
    DependentId;
    /**
     * @type {string}
     * @description Dependent's first name. */
    FirstName;
    /**
     * @type {string}
     * @description Dependent's surname. */
    Surname;
    /**
     * @type {string}
     * @description Dependent's mobile contact number. */
    MobileNumber;
    /**
     * @type {string}
     * @description Dependent's email address. */
    Email;
    /**
     * @type {string}
     * @description Depdendent's ID number. */
    IdNumber;
}
export class GetDependentResponse extends ApiServiceResponse {
    /** @param {{Dependents?:DependentData[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {DependentData[]}
     * @description List of the user's dependents. */
    Dependents;
}
export class GetDependent extends ApiServiceRequest {
    /** @param {{IdNumber?:string,ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID Number of the user to retrieve all dependent information from. */
    IdNumber;
}

JavaScript GetDependent DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}