GalaxyMobile Client API

<back to all web services

SubscriptionEvents

The following routes are available for this service:
GET/subscription/eventsGet a list of subscription event types
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel.Subscription
Imports WebService.ClientServiceModel.Base
Imports CommonService.Api.Models.Base
Imports BusinessLogic.Entities

Namespace Global

    Namespace BusinessLogic.Entities

        Public Enum WebhookSubscriptionEventType
            MessageReceived = 1
        End Enum
    End Namespace

    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.Subscription

        Public Partial Class SubscriptionEvents
            Inherits ApiServiceRequest
        End Class

        Public Partial Class SubscriptionEventsDescription
            Public Overridable Property EventType As WebhookSubscriptionEventType
            Public Overridable Property EventName As String
            Public Overridable Property EventDescription As String
        End Class

        Public Partial Class SubscriptionEventsResponse
            Inherits ApiServiceResponse
            Public Sub New()
                SubscriptionEventsDescriptions = New List(Of SubscriptionEventsDescription)
            End Sub

            Public Overridable Property SubscriptionEventsDescriptions As List(Of SubscriptionEventsDescription)
        End Class
    End Namespace
End Namespace

VB.NET SubscriptionEvents 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.

GET /subscription/events 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

<SubscriptionEventsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Subscription">
  <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>
  <SubscriptionEventsDescriptions>
    <SubscriptionEventsDescription>
      <EventDescription>String</EventDescription>
      <EventName>String</EventName>
      <EventType>MessageReceived</EventType>
    </SubscriptionEventsDescription>
  </SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>