| DELETE | /dependent | Remove a dependent 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 DeleteDependentResponse 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 DeleteDependent extends ApiServiceRequest {
/** @param {{IdNumber?:string,DependentId?:number,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 {number}
* @description The Id of the dependent in the Galaxy system you wish to delete. */
DependentId;
}
JavaScript DeleteDependent DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /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: {}
}