| DELETE | /dependent | Remove a dependent from a user's profile. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class DeleteDependent : 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)
var IdNumber:String? = 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)
var DependentId:Int? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
open class DeleteDependentResponse : ApiServiceResponse()
{
/**
* Updated list of the user's dependents.
*/
@ApiMember(Description="Updated list of the user's dependents.")
var Dependents:ArrayList<DependentData> = ArrayList<DependentData>()
}
open class ApiServiceResponse : IServiceResponse
{
var Description:String? = null
var Heading:String? = null
var WasSuccessful:Boolean? = null
var ModelState:Object? = null
}
open 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)
var DependentId:Int? = null
/**
* Dependent's first name.
*/
@ApiMember(Description="Dependent's first name.", IsRequired=true)
var FirstName:String? = null
/**
* Dependent's surname.
*/
@ApiMember(Description="Dependent's surname.", IsRequired=true)
var Surname:String? = null
/**
* Dependent's mobile contact number.
*/
@ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
var MobileNumber:String? = null
/**
* Dependent's email address.
*/
@ApiMember(Description="Dependent's email address.", IsRequired=true)
var Email:String? = null
/**
* Depdendent's ID number.
*/
@ApiMember(Description="Depdendent's ID number.", IsRequired=true)
var IdNumber:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}