Skip to content

Latest commit

 

History

History
568 lines (403 loc) · 16.8 KB

DriversApi.md

File metadata and controls

568 lines (403 loc) · 16.8 KB

DriversApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
driversAddDriverNotificationToken POST /api/v1.0/drivers/token
driversDeleteDriverProfileImage DELETE /api/v1.0/drivers/profile/image
driversDriverLogin POST /api/v1.0/drivers/login
driversDriverRequestLoginCodeSms POST /api/v1.0/drivers/pin
driversGetDriverProfile GET /api/v1.0/drivers/profile
driversGetStoresForDriver GET /api/v1.0/drivers/assignedstores
driversRemoveDriverNotificationToken DELETE /api/v1.0/drivers/token
driversSetDriverPresenceForStore POST /api/v1.0/drivers/stores/{storeId}/presence/{presence}
driversSetDriverProfileImage POST /api/v1.0/drivers/profile/image
driversUpdateDeliveryTrackingStatus POST /api/v1.0/orders/{orderId}/tracking/{deliveryTrackingStatus}
driversUpdateDriverProfile POST /api/v1.0/drivers/profile

driversAddDriverNotificationToken

Object driversAddDriverNotificationToken(updateDriverToken)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
UpdateDriverNotificationToken updateDriverToken = new UpdateDriverNotificationToken(); // UpdateDriverNotificationToken | 
try {
    Object result = apiInstance.driversAddDriverNotificationToken(updateDriverToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversAddDriverNotificationToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updateDriverToken UpdateDriverNotificationToken

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

driversDeleteDriverProfileImage

Object driversDeleteDriverProfileImage()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
try {
    Object result = apiInstance.driversDeleteDriverProfileImage();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversDeleteDriverProfileImage");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversDriverLogin

Object driversDriverLogin(driverLoginModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
DriverLoginModel driverLoginModel = new DriverLoginModel(); // DriverLoginModel | 
try {
    Object result = apiInstance.driversDriverLogin(driverLoginModel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversDriverLogin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
driverLoginModel DriverLoginModel

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

driversDriverRequestLoginCodeSms

Object driversDriverRequestLoginCodeSms(driverRequestLoginPinModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
DriverRequestLoginPinModel driverRequestLoginPinModel = new DriverRequestLoginPinModel(); // DriverRequestLoginPinModel | 
try {
    Object result = apiInstance.driversDriverRequestLoginCodeSms(driverRequestLoginPinModel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversDriverRequestLoginCodeSms");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
driverRequestLoginPinModel DriverRequestLoginPinModel

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

driversGetDriverProfile

Object driversGetDriverProfile()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
try {
    Object result = apiInstance.driversGetDriverProfile();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversGetDriverProfile");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversGetStoresForDriver

Object driversGetStoresForDriver()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
try {
    Object result = apiInstance.driversGetStoresForDriver();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversGetStoresForDriver");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversRemoveDriverNotificationToken

Object driversRemoveDriverNotificationToken(removeDriverToken)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
UpdateDriverNotificationToken removeDriverToken = new UpdateDriverNotificationToken(); // UpdateDriverNotificationToken | 
try {
    Object result = apiInstance.driversRemoveDriverNotificationToken(removeDriverToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversRemoveDriverNotificationToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
removeDriverToken UpdateDriverNotificationToken

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

driversSetDriverPresenceForStore

Object driversSetDriverPresenceForStore(storeId, presence)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
Integer storeId = 56; // Integer | 
String presence = "presence_example"; // String | 
try {
    Object result = apiInstance.driversSetDriverPresenceForStore(storeId, presence);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversSetDriverPresenceForStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
presence String [enum: Offline, Online]

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversSetDriverProfileImage

Object driversSetDriverProfileImage()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
try {
    Object result = apiInstance.driversSetDriverProfileImage();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversSetDriverProfileImage");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversUpdateDeliveryTrackingStatus

Object driversUpdateDeliveryTrackingStatus(orderId, deliveryTrackingStatus)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
Integer orderId = 56; // Integer | 
String deliveryTrackingStatus = "deliveryTrackingStatus_example"; // String | 
try {
    Object result = apiInstance.driversUpdateDeliveryTrackingStatus(orderId, deliveryTrackingStatus);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversUpdateDeliveryTrackingStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer
deliveryTrackingStatus String [enum: Unassigned, Unaccepted, Accepted, Carrying, OnTheWay, ArrivedAtLocation, Delivered, CannotDeliver]

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

driversUpdateDriverProfile

Object driversUpdateDriverProfile(updateDriverProfile)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.DriversApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

DriversApi apiInstance = new DriversApi();
UpdateDriverProfileModel updateDriverProfile = new UpdateDriverProfileModel(); // UpdateDriverProfileModel | 
try {
    Object result = apiInstance.driversUpdateDriverProfile(updateDriverProfile);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DriversApi#driversUpdateDriverProfile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updateDriverProfile UpdateDriverProfileModel

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml