1Fetch Client API

SubscriptionEvents

The following routes are available for this service:
GET	/subscription/events	Get a list of subscription event types

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication

**SubscriptionEventsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionEventsDescriptions	form	List<SubscriptionEventsDescription>	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?

**SubscriptionEventsDescription** Parameters:
Name	Parameter	Data Type	Required
EventType	form	WebhookSubscriptionEventType	No
EventName	form	string	No
EventDescription	form	string	No

**WebhookSubscriptionEventType** Enum:
Name	Value
DriverOnTheWay	0
ArrivedAtWaypoint	1
DepartedWaypoint	2
OrderCompleted	3
OrderCancelled	4

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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: api.1fetch.co.za 
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">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <SubscriptionEventsDescriptions>
    <SubscriptionEventsDescription>
      <EventDescription>String</EventDescription>
      <EventName>String</EventName>
      <EventType>DriverOnTheWay</EventType>
    </SubscriptionEventsDescription>
  </SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>