| POST | /dependent | Add a dependent onto 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 AddDependentResponse 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 Updated list of the user's dependents. */
Dependents;
}
export class AddDependent extends ApiServiceRequest {
/** @param {{IdNumber?:string,DependentData?:DependentData,ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description ID Number of the primary user you wish to add a dependent onto. */
IdNumber;
/**
* @type {DependentData}
* @description Data of the dependent. */
DependentData;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<AddDependent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.User">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<DependentData>
<DependentId>0</DependentId>
<Email>String</Email>
<FirstName>String</FirstName>
<IdNumber>String</IdNumber>
<MobileNumber>String</MobileNumber>
<Surname>String</Surname>
</DependentData>
<IdNumber>String</IdNumber>
</AddDependent>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddDependentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.User">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<Dependents>
<DependentData>
<DependentId>0</DependentId>
<Email>String</Email>
<FirstName>String</FirstName>
<IdNumber>String</IdNumber>
<MobileNumber>String</MobileNumber>
<Surname>String</Surname>
</DependentData>
</Dependents>
</AddDependentResponse>