| PUT | /subscription/{EventType} | Update your subscription to an event with a url we should post to | |
|---|---|---|---|
| PUT | /subscription | Update your subscription to an event with a url we should post to |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class UpdateSubscription extends ApiServiceRequest implements ILogRequest
{
/**
* The event type being subscribed to
*/
@ApiMember(Description="The event type being subscribed to", IsRequired=true)
public WebhookSubscriptionEventType EventType = null;
/**
* The URL we should post the event data to
*/
@ApiMember(Description="The URL we should post the event data to", IsRequired=true)
public String SubscriptionUrl = null;
public WebhookSubscriptionEventType getEventType() { return EventType; }
public UpdateSubscription setEventType(WebhookSubscriptionEventType value) { this.EventType = value; return this; }
public String getSubscriptionUrl() { return SubscriptionUrl; }
public UpdateSubscription setSubscriptionUrl(String value) { this.SubscriptionUrl = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static enum WebhookSubscriptionEventType
{
@SerializedName("1") MessageReceived(1);
private final int value;
WebhookSubscriptionEventType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
}
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.
PUT /subscription/{EventType} HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Subscription">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<EventType>MessageReceived</EventType>
<SubscriptionUrl>String</SubscriptionUrl>
</UpdateSubscription>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base"> <Description>String</Description> <Heading>String</Heading> <ModelState /> <WasSuccessful>false</WasSuccessful> </ApiServiceResponse>