| GET | /dependent | Retrieve all dependent information from a user's profile. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel.User;
using WebService.ClientServiceModel.Base;
using CommonService.Api.Models.Base;
namespace CommonService.Api.Models.Base
{
public partial class ApiServiceResponse
: IServiceResponse
{
public virtual string Description { get; set; }
public virtual string Heading { get; set; }
public virtual bool WasSuccessful { get; set; }
public virtual Object ModelState { get; set; }
}
}
namespace WebService.ClientServiceModel.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
}
}
namespace WebService.ClientServiceModel.User
{
public partial class DependentData
{
///<summary>
///Dependent's Galaxy Id used for referring to or deleting.
///</summary>
[ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)]
public virtual int DependentId { get; set; }
///<summary>
///Dependent's first name.
///</summary>
[ApiMember(Description="Dependent's first name.", IsRequired=true)]
public virtual string FirstName { get; set; }
///<summary>
///Dependent's surname.
///</summary>
[ApiMember(Description="Dependent's surname.", IsRequired=true)]
public virtual string Surname { get; set; }
///<summary>
///Dependent's mobile contact number.
///</summary>
[ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)]
public virtual string MobileNumber { get; set; }
///<summary>
///Dependent's email address.
///</summary>
[ApiMember(Description="Dependent's email address.", IsRequired=true)]
public virtual string Email { get; set; }
///<summary>
///Depdendent's ID number.
///</summary>
[ApiMember(Description="Depdendent's ID number.", IsRequired=true)]
public virtual string IdNumber { get; set; }
}
public partial class GetDependent
: ApiServiceRequest
{
///<summary>
///ID Number of the user to retrieve all dependent information from.
///</summary>
[ApiMember(Description="ID Number of the user to retrieve all dependent information from.", IsRequired=true)]
public virtual string IdNumber { get; set; }
}
public partial class GetDependentResponse
: ApiServiceResponse
{
public GetDependentResponse()
{
Dependents = new List<DependentData>{};
}
///<summary>
///List of the user's dependents.
///</summary>
[ApiMember(Description="List of the user's dependents.")]
public virtual List<DependentData> Dependents { get; set; }
}
}
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.
GET /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: {}
}