GalaxyMobile Client API

<back to all web services

DeleteDependent

The following routes are available for this service:
DELETE/dependentRemove a dependent 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 DeleteDependent
        : ApiServiceRequest
    {
        ///<summary>
        ///ID Number of the primary user you wish to add a dependent onto.
        ///</summary>
        [ApiMember(Description="ID Number of the primary user you wish to add a dependent onto.", IsRequired=true)]
        public virtual string IdNumber { get; set; }

        ///<summary>
        ///The Id of the dependent in the Galaxy system you wish to delete.
        ///</summary>
        [ApiMember(Description="The Id of the dependent in the Galaxy system you wish to delete.", IsRequired=true)]
        public virtual int DependentId { get; set; }
    }

    public partial class DeleteDependentResponse
        : ApiServiceResponse
    {
        public DeleteDependentResponse()
        {
            Dependents = new List<DependentData>{};
        }

        ///<summary>
        ///Updated list of the user's dependents.
        ///</summary>
        [ApiMember(Description="Updated list of the user's dependents.")]
        public virtual List<DependentData> Dependents { get; set; }
    }

    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; }
    }

}

C# DeleteDependent 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.

DELETE /dependent HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DeleteDependentResponse 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>
</DeleteDependentResponse>