1Fetch Client API

<back to all web services

AddSubscription

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
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public Description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public Heading: string;

    /** @description Did the intended operation for this response complete successfully? */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public WasSuccessful: boolean;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export enum WebhookSubscriptionEventType
{
    DriverOnTheWay = 0,
    ArrivedAtWaypoint = 1,
    DepartedWaypoint = 2,
    OrderCompleted = 3,
    OrderCancelled = 4,
}

export class AddSubscription extends ApiServiceRequest implements ILogRequest
{
    /** @description The event type being subscribed to */
    // @ApiMember(Description="The event type being subscribed to", IsRequired=true)
    public EventType: WebhookSubscriptionEventType;

    /** @description The URL we should post the event data to */
    // @ApiMember(Description="The URL we should post the event data to", IsRequired=true)
    public SubscriptionUrl: string;

    public constructor(init?: Partial<AddSubscription>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AddSubscription DTOs

POST /subscription/{EventType} HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventType: 0,
	SubscriptionUrl: String,
	ApiKey: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	Heading: String,
	WasSuccessful: False
}