| GET | /dependent | Retrieve all dependent information from a user's profile. |
|---|
import 'package:servicestack/servicestack.dart';
class ApiServiceRequest implements IServiceRequest, IHasApiKey, IConvertible
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
String? ApiKey;
ApiServiceRequest({this.ApiKey});
ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey
};
getTypeName() => "ApiServiceRequest";
TypeContext? context = _ctx;
}
class ApiServiceResponse implements IServiceResponse, IConvertible
{
String? Description;
String? Heading;
bool? WasSuccessful;
dynamic? ModelState;
ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful,this.ModelState});
ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Description = json['Description'];
Heading = json['Heading'];
WasSuccessful = json['WasSuccessful'];
ModelState = JsonConverters.fromJson(json['ModelState'],'dynamic',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Description': Description,
'Heading': Heading,
'WasSuccessful': WasSuccessful,
'ModelState': JsonConverters.toJson(ModelState,'dynamic',context!)
};
getTypeName() => "ApiServiceResponse";
TypeContext? context = _ctx;
}
class DependentData implements IConvertible
{
/**
* Dependent's Galaxy Id used for referring to or deleting.
*/
// @ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)
int? DependentId;
/**
* Dependent's first name.
*/
// @ApiMember(Description="Dependent's first name.", IsRequired=true)
String? FirstName;
/**
* Dependent's surname.
*/
// @ApiMember(Description="Dependent's surname.", IsRequired=true)
String? Surname;
/**
* Dependent's mobile contact number.
*/
// @ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
String? MobileNumber;
/**
* Dependent's email address.
*/
// @ApiMember(Description="Dependent's email address.", IsRequired=true)
String? Email;
/**
* Depdendent's ID number.
*/
// @ApiMember(Description="Depdendent's ID number.", IsRequired=true)
String? IdNumber;
DependentData({this.DependentId,this.FirstName,this.Surname,this.MobileNumber,this.Email,this.IdNumber});
DependentData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DependentId = json['DependentId'];
FirstName = json['FirstName'];
Surname = json['Surname'];
MobileNumber = json['MobileNumber'];
Email = json['Email'];
IdNumber = json['IdNumber'];
return this;
}
Map<String, dynamic> toJson() => {
'DependentId': DependentId,
'FirstName': FirstName,
'Surname': Surname,
'MobileNumber': MobileNumber,
'Email': Email,
'IdNumber': IdNumber
};
getTypeName() => "DependentData";
TypeContext? context = _ctx;
}
class GetDependentResponse extends ApiServiceResponse implements IConvertible
{
/**
* List of the user's dependents.
*/
// @ApiMember(Description="List of the user's dependents.")
List<DependentData>? Dependents;
GetDependentResponse({this.Dependents});
GetDependentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Dependents = JsonConverters.fromJson(json['Dependents'],'List<DependentData>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Dependents': JsonConverters.toJson(Dependents,'List<DependentData>',context!)
});
getTypeName() => "GetDependentResponse";
TypeContext? context = _ctx;
}
class GetDependent extends ApiServiceRequest implements IConvertible
{
/**
* ID Number of the user to retrieve all dependent information from.
*/
// @ApiMember(Description="ID Number of the user to retrieve all dependent information from.", IsRequired=true)
String? IdNumber;
GetDependent({this.IdNumber});
GetDependent.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
IdNumber = json['IdNumber'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'IdNumber': IdNumber
});
getTypeName() => "GetDependent";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'galaxymobile.api.client.prod.86degrees.com', types: <String, TypeInfo> {
'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
'DependentData': TypeInfo(TypeOf.Class, create:() => DependentData()),
'GetDependentResponse': TypeInfo(TypeOf.Class, create:() => GetDependentResponse()),
'List<DependentData>': TypeInfo(TypeOf.Class, create:() => <DependentData>[]),
'GetDependent': TypeInfo(TypeOf.Class, create:() => GetDependent()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}