| DELETE | /dependent | Remove a dependent from 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 DeleteDependentResponse 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<DeleteDependentResponse>) { super(init); (Object as any).assign(this, init); }
}
export class DeleteDependent 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 The Id of the dependent in the Galaxy system you wish to delete. */
// @ApiMember(Description="The Id of the dependent in the Galaxy system you wish to delete.", IsRequired=true)
public DependentId: number;
public constructor(init?: Partial<DeleteDependent>) { super(init); (Object as any).assign(this, init); }
}
TypeScript DeleteDependent DTOs
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.
DELETE /dependent HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DeleteDependentResponse 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>
</DeleteDependentResponse>