GalaxyMobile Client API

<back to all web services

AddDependent

The following routes are available for this service:
POST/dependentAdd a dependent onto 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 AddDependentResponse extends ApiServiceResponse implements IConvertible
{
    /**
    * Updated list of the user's dependents.
    */
    // @ApiMember(Description="Updated list of the user's dependents.")
    List<DependentData>? Dependents;

    AddDependentResponse({this.Dependents});
    AddDependentResponse.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() => "AddDependentResponse";
    TypeContext? context = _ctx;
}

class AddDependent extends ApiServiceRequest implements IConvertible
{
    /**
    * 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)
    String? IdNumber;

    /**
    * Data of the dependent.
    */
    // @ApiMember(Description="Data of the dependent.", IsRequired=true)
    DependentData? DependentData;

    AddDependent({this.IdNumber,this.DependentData});
    AddDependent.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        IdNumber = json['IdNumber'];
        DependentData = JsonConverters.fromJson(json['DependentData'],'DependentData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IdNumber': IdNumber,
        'DependentData': JsonConverters.toJson(DependentData,'DependentData',context!)
    });

    getTypeName() => "AddDependent";
    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()),
    'AddDependentResponse': TypeInfo(TypeOf.Class, create:() => AddDependentResponse()),
    'List<DependentData>': TypeInfo(TypeOf.Class, create:() => <DependentData>[]),
    'AddDependent': TypeInfo(TypeOf.Class, create:() => AddDependent()),
});

Dart AddDependent DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>