Skip to content

Latest commit

 

History

History
228 lines (164 loc) · 7 KB

DeviceApi.md

File metadata and controls

228 lines (164 loc) · 7 KB

DeviceApi

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

Method HTTP request Description
assignDevice POST /api/v1.0/{appId}/devices/assign
enrollDevice POST /api/v1.0/{appId}/devices/enroll
getDeviceDetails GET /api/v1.0/{appId}/devices/device/{deviceModel}/{deviceId}
searchDevices GET /api/v1.0/{appId}/devices/search

assignDevice

RestApiResultClientDeviceEnrollmentResult assignDevice(appId, assignDeviceRequest)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DeviceApi apiInstance = new DeviceApi();
String appId = "appId_example"; // String | 
ClientDeviceAssignEnrolledDevice assignDeviceRequest = new ClientDeviceAssignEnrolledDevice(); // ClientDeviceAssignEnrolledDevice | 
try {
    RestApiResultClientDeviceEnrollmentResult result = apiInstance.assignDevice(appId, assignDeviceRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeviceApi#assignDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
assignDeviceRequest ClientDeviceAssignEnrolledDevice

Return type

RestApiResultClientDeviceEnrollmentResult

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

enrollDevice

RestApiResultClientDeviceEnrollmentResult enrollDevice(appId, deviceEnrollmentRequest)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DeviceApi apiInstance = new DeviceApi();
String appId = "appId_example"; // String | 
ClientDeviceEnroll deviceEnrollmentRequest = new ClientDeviceEnroll(); // ClientDeviceEnroll | 
try {
    RestApiResultClientDeviceEnrollmentResult result = apiInstance.enrollDevice(appId, deviceEnrollmentRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeviceApi#enrollDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceEnrollmentRequest ClientDeviceEnroll

Return type

RestApiResultClientDeviceEnrollmentResult

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

getDeviceDetails

RestApiResultClientDevice getDeviceDetails(appId, deviceModel, deviceId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

DeviceApi apiInstance = new DeviceApi();
String appId = "appId_example"; // String | 
String deviceModel = "deviceModel_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultClientDevice result = apiInstance.getDeviceDetails(appId, deviceModel, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeviceApi#getDeviceDetails");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceModel String
deviceId String

Return type

RestApiResultClientDevice

Authorization

oauth2

HTTP request headers

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

searchDevices

RestApiArrayResultClientDeviceSummary searchDevices(appId, storeId, deviceModel)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
storeId Integer [optional]
deviceModel String [optional]

Return type

RestApiArrayResultClientDeviceSummary

Authorization

oauth2

HTTP request headers

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