GalaxyMobile Client API

<back to all web services

AddSubscription

The following routes are available for this service:
POST/subscription/{EventType}Subscribe to an event with a url we should post to
POST/subscriptionSubscribe to an event with a url we should post to
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AddSubscription : ApiServiceRequest(), ILogRequest
{
    /**
    * The event type being subscribed to
    */
    @ApiMember(Description="The event type being subscribed to", IsRequired=true)
    var EventType:WebhookSubscriptionEventType? = null

    /**
    * The URL we should post the event data to
    */
    @ApiMember(Description="The URL we should post the event data to", IsRequired=true)
    var SubscriptionUrl:String? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null
}

enum class WebhookSubscriptionEventType(val value:Int)
{
    @SerializedName("1") MessageReceived(1),
}

open class ApiServiceResponse : IServiceResponse
{
    var Description:String? = null
    var Heading:String? = null
    var WasSuccessful:Boolean? = null
    var ModelState:Object? = null
}

Kotlin AddSubscription DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /subscription/{EventType} HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventType: 1,
	SubscriptionUrl: String,
	ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ModelState: {}
}