Skip to content

Latest commit

 

History

History
232 lines (168 loc) · 7.28 KB

LocationAreasApi.md

File metadata and controls

232 lines (168 loc) · 7.28 KB

LocationAreasApi

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

Method HTTP request Description
createLocationArea POST /api/v1.0/{appId}/stores/{storeId}/location-areas
getLocationArea GET /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}
getLocationAreasForStore GET /api/v1.0/{appId}/stores/{storeId}/location-areas
updateLocationArea POST /api/v1.0/{appId}/stores/{storeId}/location-areas/{locationAreaId}/update

createLocationArea

Object createLocationArea(locationAreaInput, appId, storeId)

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.LocationAreasApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

LocationAreasApi apiInstance = new LocationAreasApi();
CreateLocationArea locationAreaInput = new CreateLocationArea(); // CreateLocationArea | 
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    Object result = apiInstance.createLocationArea(locationAreaInput, appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationAreasApi#createLocationArea");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
locationAreaInput CreateLocationArea
appId String
storeId Integer

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

getLocationArea

RestApiResultLocationAreaWithLocations getLocationArea(locationAreaId, appId, storeId)

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.LocationAreasApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

LocationAreasApi apiInstance = new LocationAreasApi();
Integer locationAreaId = 56; // Integer | 
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiResultLocationAreaWithLocations result = apiInstance.getLocationArea(locationAreaId, appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationAreasApi#getLocationArea");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
locationAreaId Integer
appId String
storeId Integer

Return type

RestApiResultLocationAreaWithLocations

Authorization

oauth2

HTTP request headers

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

getLocationAreasForStore

RestApiArrayResultLocationAreaWithLocations getLocationAreasForStore(appId, storeId)

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.LocationAreasApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

LocationAreasApi apiInstance = new LocationAreasApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiArrayResultLocationAreaWithLocations result = apiInstance.getLocationAreasForStore(appId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationAreasApi#getLocationAreasForStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer

Return type

RestApiArrayResultLocationAreaWithLocations

Authorization

oauth2

HTTP request headers

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

updateLocationArea

RestApiResultLocationArea updateLocationArea(locationAreaInput, appId, storeId, locationAreaId)

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.LocationAreasApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

LocationAreasApi apiInstance = new LocationAreasApi();
UpdateLocationArea locationAreaInput = new UpdateLocationArea(); // UpdateLocationArea | 
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
String locationAreaId = "locationAreaId_example"; // String | 
try {
    RestApiResultLocationArea result = apiInstance.updateLocationArea(locationAreaInput, appId, storeId, locationAreaId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationAreasApi#updateLocationArea");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
locationAreaInput UpdateLocationArea
appId String
storeId Integer
locationAreaId String

Return type

RestApiResultLocationArea

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