Skip to content

Latest commit

 

History

History
268 lines (200 loc) · 7.85 KB

DeviceApi.md

File metadata and controls

268 lines (200 loc) · 7.85 KB

Flipdish.Api.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 (string appId, ClientDeviceAssignEnrolledDevice assignDeviceRequest)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AssignDeviceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var appId = appId_example;  // string | 
            var assignDeviceRequest = new ClientDeviceAssignEnrolledDevice(); // ClientDeviceAssignEnrolledDevice | 

            try
            {
                RestApiResultClientDeviceEnrollmentResult result = apiInstance.AssignDevice(appId, assignDeviceRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.AssignDevice: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnrollDevice

RestApiResultClientDeviceEnrollmentResult EnrollDevice (string appId, ClientDeviceEnroll deviceEnrollmentRequest)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class EnrollDeviceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var appId = appId_example;  // string | 
            var deviceEnrollmentRequest = new ClientDeviceEnroll(); // ClientDeviceEnroll | 

            try
            {
                RestApiResultClientDeviceEnrollmentResult result = apiInstance.EnrollDevice(appId, deviceEnrollmentRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.EnrollDevice: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDeviceDetails

RestApiResultClientDevice GetDeviceDetails (string appId, string deviceModel, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetDeviceDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var appId = appId_example;  // string | 
            var deviceModel = deviceModel_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultClientDevice result = apiInstance.GetDeviceDetails(appId, deviceModel, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.GetDeviceDetails: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchDevices

RestApiArrayResultClientDeviceSummary SearchDevices (string appId, int? storeId = null, string deviceModel = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class SearchDevicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? |  (optional) 
            var deviceModel = deviceModel_example;  // string |  (optional) 

            try
            {
                RestApiArrayResultClientDeviceSummary result = apiInstance.SearchDevices(appId, storeId, deviceModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.SearchDevices: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int? [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

[Back to top] [Back to API list] [Back to Model list] [Back to README]