| POST | /dependent | Add a dependent onto a user's profile. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class AddDependent : 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
/**
* Data of the dependent.
*/
@ApiMember(Description="Data of the dependent.", IsRequired=true)
var DependentData:DependentData? = 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 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
}
open class AddDependentResponse : 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
}
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>