GalaxyMobile Client API

<back to all web services

AddDependent

The following routes are available for this service:
POST/dependentAdd a dependent onto a user's profile.

export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public ApiKey: string;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public Description: string;
    public Heading: string;
    public WasSuccessful: boolean;
    public ModelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class DependentData
{
    /** @description Dependent's Galaxy Id used for referring to or deleting. */
    // @ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)
    public DependentId: number;

    /** @description Dependent's first name. */
    // @ApiMember(Description="Dependent's first name.", IsRequired=true)
    public FirstName: string;

    /** @description Dependent's surname. */
    // @ApiMember(Description="Dependent's surname.", IsRequired=true)
    public Surname: string;

    /** @description Dependent's mobile contact number. */
    // @ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
    public MobileNumber: string;

    /** @description Dependent's email address. */
    // @ApiMember(Description="Dependent's email address.", IsRequired=true)
    public Email: string;

    /** @description Depdendent's ID number. */
    // @ApiMember(Description="Depdendent's ID number.", IsRequired=true)
    public IdNumber: string;

    public constructor(init?: Partial<DependentData>) { (Object as any).assign(this, init); }
}

export class AddDependentResponse extends ApiServiceResponse
{
    /** @description Updated list of the user's dependents. */
    // @ApiMember(Description="Updated list of the user's dependents.")
    public Dependents: DependentData[];

    public constructor(init?: Partial<AddDependentResponse>) { super(init); (Object as any).assign(this, init); }
}

export class AddDependent extends ApiServiceRequest
{
    /** @description ID Number of the primary user you wish to add a dependent onto. */
    // @ApiMember(Description="ID Number of the primary user you wish to add a dependent onto.", IsRequired=true)
    public IdNumber: string;

    /** @description Data of the dependent. */
    // @ApiMember(Description="Data of the dependent.", IsRequired=true)
    public DependentData: DependentData;

    public constructor(init?: Partial<AddDependent>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AddDependent DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /dependent HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"IdNumber":"String","DependentData":{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"},"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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