GalaxyMobile Client API

<back to all web services

SubscriptionList

The following routes are available for this service:
GET/subscriptionGet a list of subscription events that you are subscribed to
import Foundation
import ServiceStack

public class SubscriptionList : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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 SubscriptionListResponse : ApiServiceResponse
{
    public var subscriptions:[SubscriptionDetail] = []

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

    private enum CodingKeys : String, CodingKey {
        case subscriptions
    }

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

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

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(){}
}

public class SubscriptionDetail : Codable
{
    public var eventType:WebhookSubscriptionEventType
    public var eventName:String
    public var subscriptionUrl:String

    required public init(){}
}

public enum WebhookSubscriptionEventType : String, Codable
{
    case MessageReceived = 1
}


Swift SubscriptionList 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 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

<SubscriptionListResponse 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>
  <Subscriptions>
    <SubscriptionDetail>
      <EventName>String</EventName>
      <EventType>MessageReceived</EventType>
      <SubscriptionUrl>String</SubscriptionUrl>
    </SubscriptionDetail>
  </Subscriptions>
</SubscriptionListResponse>