| DELETE | /dependent | Remove a dependent from a user's profile. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel.User
Imports WebService.ClientServiceModel.Base
Imports CommonService.Api.Models.Base
Namespace Global
Namespace CommonService.Api.Models.Base
Public Partial Class ApiServiceResponse
Implements IServiceResponse
Public Overridable Property Description As String
Public Overridable Property Heading As String
Public Overridable Property WasSuccessful As Boolean
Public Overridable Property ModelState As Object
End Class
End Namespace
Namespace WebService.ClientServiceModel.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
End Class
End Namespace
Namespace WebService.ClientServiceModel.User
Public Partial Class DeleteDependent
Inherits 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 Overridable Property IdNumber As String
'''<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 Overridable Property DependentId As Integer
End Class
Public Partial Class DeleteDependentResponse
Inherits ApiServiceResponse
Public Sub New()
Dependents = New List(Of DependentData)
End Sub
'''<Summary>
'''Updated list of the user's dependents.
'''</Summary>
<ApiMember(Description:="Updated list of the user's dependents.")>
Public Overridable Property Dependents As List(Of DependentData)
End Class
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 Overridable Property DependentId As Integer
'''<Summary>
'''Dependent's first name.
'''</Summary>
<ApiMember(Description:="Dependent's first name.", IsRequired:=true)>
Public Overridable Property FirstName As String
'''<Summary>
'''Dependent's surname.
'''</Summary>
<ApiMember(Description:="Dependent's surname.", IsRequired:=true)>
Public Overridable Property Surname As String
'''<Summary>
'''Dependent's mobile contact number.
'''</Summary>
<ApiMember(Description:="Dependent's mobile contact number.", IsRequired:=true)>
Public Overridable Property MobileNumber As String
'''<Summary>
'''Dependent's email address.
'''</Summary>
<ApiMember(Description:="Dependent's email address.", IsRequired:=true)>
Public Overridable Property Email As String
'''<Summary>
'''Depdendent's ID number.
'''</Summary>
<ApiMember(Description:="Depdendent's ID number.", IsRequired:=true)>
Public Overridable Property IdNumber As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}