| GET | /subscription | Get a list of subscription events that you are subscribed to |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public ApiKey: string;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
public Description: string;
public Heading: string;
public WasSuccessful: boolean;
public ModelState: Object;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export enum WebhookSubscriptionEventType
{
MessageReceived = 1,
}
export class SubscriptionDetail
{
public EventType: WebhookSubscriptionEventType;
public EventName: string;
public SubscriptionUrl: string;
public constructor(init?: Partial<SubscriptionDetail>) { (Object as any).assign(this, init); }
}
export class SubscriptionListResponse extends ApiServiceResponse
{
public Subscriptions: SubscriptionDetail[];
public constructor(init?: Partial<SubscriptionListResponse>) { super(init); (Object as any).assign(this, init); }
}
export class SubscriptionList extends ApiServiceRequest
{
public constructor(init?: Partial<SubscriptionList>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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>