| GET | /subscription/events | Get a list of subscription event types |
|---|
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 SubscriptionEventsDescription
{
public EventType: WebhookSubscriptionEventType;
public EventName: string;
public EventDescription: string;
public constructor(init?: Partial<SubscriptionEventsDescription>) { (Object as any).assign(this, init); }
}
export class SubscriptionEventsResponse extends ApiServiceResponse
{
public SubscriptionEventsDescriptions: SubscriptionEventsDescription[];
public constructor(init?: Partial<SubscriptionEventsResponse>) { super(init); (Object as any).assign(this, init); }
}
export class SubscriptionEvents extends ApiServiceRequest
{
public constructor(init?: Partial<SubscriptionEvents>) { super(init); (Object as any).assign(this, init); }
}
TypeScript SubscriptionEvents 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/events 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
<SubscriptionEventsResponse 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>
<SubscriptionEventsDescriptions>
<SubscriptionEventsDescription>
<EventDescription>String</EventDescription>
<EventName>String</EventName>
<EventType>MessageReceived</EventType>
</SubscriptionEventsDescription>
</SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>