| DELETE | /dependent | Remove a dependent from a user's profile. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class DeleteDependent extends ApiServiceRequest
{
/**
* 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 String IdNumber = null;
/**
* 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 Integer DependentId = null;
public String getIdNumber() { return IdNumber; }
public DeleteDependent setIdNumber(String value) { this.IdNumber = value; return this; }
public Integer getDependentId() { return DependentId; }
public DeleteDependent setDependentId(Integer value) { this.DependentId = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static class DeleteDependentResponse extends ApiServiceResponse
{
/**
* Updated list of the user's dependents.
*/
@ApiMember(Description="Updated list of the user's dependents.")
public ArrayList<DependentData> Dependents = null;
public ArrayList<DependentData> getDependents() { return Dependents; }
public DeleteDependentResponse setDependents(ArrayList<DependentData> value) { this.Dependents = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
public static class DependentData
{
/**
* 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 Integer DependentId = null;
/**
* Dependent's first name.
*/
@ApiMember(Description="Dependent's first name.", IsRequired=true)
public String FirstName = null;
/**
* Dependent's surname.
*/
@ApiMember(Description="Dependent's surname.", IsRequired=true)
public String Surname = null;
/**
* Dependent's mobile contact number.
*/
@ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
public String MobileNumber = null;
/**
* Dependent's email address.
*/
@ApiMember(Description="Dependent's email address.", IsRequired=true)
public String Email = null;
/**
* Depdendent's ID number.
*/
@ApiMember(Description="Depdendent's ID number.", IsRequired=true)
public String IdNumber = null;
public Integer getDependentId() { return DependentId; }
public DependentData setDependentId(Integer value) { this.DependentId = value; return this; }
public String getFirstName() { return FirstName; }
public DependentData setFirstName(String value) { this.FirstName = value; return this; }
public String getSurname() { return Surname; }
public DependentData setSurname(String value) { this.Surname = value; return this; }
public String getMobileNumber() { return MobileNumber; }
public DependentData setMobileNumber(String value) { this.MobileNumber = value; return this; }
public String getEmail() { return Email; }
public DependentData setEmail(String value) { this.Email = value; return this; }
public String getIdNumber() { return IdNumber; }
public DependentData setIdNumber(String value) { this.IdNumber = value; return this; }
}
}
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: {}
}