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
"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Heading;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {Object} */
    ModelState;
}
/** @typedef {number} */
export var WebhookSubscriptionEventType;
(function (WebhookSubscriptionEventType) {
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["MessageReceived"] = 1] = "MessageReceived"
})(WebhookSubscriptionEventType || (WebhookSubscriptionEventType = {}));
export class SubscriptionEventsDescription {
    /** @param {{EventType?:WebhookSubscriptionEventType,EventName?:string,EventDescription?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WebhookSubscriptionEventType} */
    EventType;
    /** @type {string} */
    EventName;
    /** @type {string} */
    EventDescription;
}
export class SubscriptionEventsResponse extends ApiServiceResponse {
    /** @param {{SubscriptionEventsDescriptions?:SubscriptionEventsDescription[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SubscriptionEventsDescription[]} */
    SubscriptionEventsDescriptions;
}
export class SubscriptionEvents extends ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript SubscriptionEvents DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SubscriptionEventsDescriptions":[{"EventType":1,"EventName":"String","EventDescription":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}