| POST | /dependent |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IHasClientId
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public ApiKey: string;
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public Latitude: number;
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public Longitude: number;
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
{
public DependentId: number;
public FirstName: string;
public Surname: string;
public MobileNumber: string;
public Email: string;
public IdNumber: string;
public constructor(init?: Partial<DependentData>) { (Object as any).assign(this, init); }
}
export class AddDependentResponse extends ApiServiceResponse
{
public Dependents: DependentData[];
public constructor(init?: Partial<AddDependentResponse>) { super(init); (Object as any).assign(this, init); }
}
export class AddDependent extends ApiServiceRequest
{
public FirstName: string;
public Surname: string;
public MobileNumber: string;
public Email: string;
public IdNumber: string;
public constructor(init?: Partial<AddDependent>) { super(init); (Object as any).assign(this, init); }
}
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.
POST /dependent HTTP/1.1
Host: galaxymobile.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FirstName: String,
Surname: String,
MobileNumber: String,
Email: String,
IdNumber: String,
ApiKey: String,
Latitude: 0,
Longitude: 0
}
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: {}
}