GalaxyMobile Client API

<back to all web services

AddDependent

import Foundation
import ServiceStack

public 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)
    public var idNumber:String

    /**
    * Data of the dependent.
    */
    // @ApiMember(Description="Data of the dependent.", IsRequired=true)
    public var dependentData:DependentData

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case idNumber
        case dependentData
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        idNumber = try container.decodeIfPresent(String.self, forKey: .idNumber)
        dependentData = try container.decodeIfPresent(DependentData.self, forKey: .dependentData)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if idNumber != nil { try container.encode(idNumber, forKey: .idNumber) }
        if dependentData != nil { try container.encode(dependentData, forKey: .dependentData) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    required public init(){}
}

public class DependentData : Codable
{
    /**
    * Dependent's Galaxy Id used for referring to or deleting.
    */
    // @ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)
    public var dependentId:Int

    /**
    * Dependent's first name.
    */
    // @ApiMember(Description="Dependent's first name.", IsRequired=true)
    public var firstName:String

    /**
    * Dependent's surname.
    */
    // @ApiMember(Description="Dependent's surname.", IsRequired=true)
    public var surname:String

    /**
    * Dependent's mobile contact number.
    */
    // @ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
    public var mobileNumber:String

    /**
    * Dependent's email address.
    */
    // @ApiMember(Description="Dependent's email address.", IsRequired=true)
    public var email:String

    /**
    * Depdendent's ID number.
    */
    // @ApiMember(Description="Depdendent's ID number.", IsRequired=true)
    public var idNumber:String

    required public init(){}
}

public class AddDependentResponse : ApiServiceResponse
{
    /**
    * Updated list of the user's dependents.
    */
    // @ApiMember(Description="Updated list of the user's dependents.")
    public var dependents:[DependentData] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case dependents
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dependents = try container.decodeIfPresent([DependentData].self, forKey: .dependents) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dependents.count > 0 { try container.encode(dependents, forKey: .dependents) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

Swift AddDependent DTOs

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>