| GET | /subscription | Get a list of subscription events that you are subscribed to |
|---|
"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 SubscriptionDetail {
/** @param {{EventType?:WebhookSubscriptionEventType,EventName?:string,SubscriptionUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WebhookSubscriptionEventType} */
EventType;
/** @type {string} */
EventName;
/** @type {string} */
SubscriptionUrl;
}
export class SubscriptionListResponse extends ApiServiceResponse {
/** @param {{Subscriptions?:SubscriptionDetail[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {SubscriptionDetail[]} */
Subscriptions;
}
export class SubscriptionList extends ApiServiceRequest {
/** @param {{ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript SubscriptionList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>