Skip to content

HomeApi.md

Latest commit

 

History

History
256 lines (189 loc) · 6.6 KB

HomeApi.md

File metadata and controls

256 lines (189 loc) · 6.6 KB

Flipdish.Api.HomeApi

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

Method HTTP request Description
CompleteHomeAction POST /api/v1.0/{appId}/home/{homeActionId}
GetHomeActions GET /api/v1.0/{appId}/home
GetHomeStatistics GET /api/v1.0/{appId}/home/stats
GetOktaPortalFeatureFlag GET /api/v1.0/home/okta-portal

CompleteHomeAction

Object CompleteHomeAction (string appId, int? homeActionId, bool? isDismissed)

Example

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

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

            var apiInstance = new HomeApi();
            var appId = appId_example;  // string | 
            var homeActionId = 56;  // int? | 
            var isDismissed = true;  // bool? | 

            try
            {
                Object result = apiInstance.CompleteHomeAction(appId, homeActionId, isDismissed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.CompleteHomeAction: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
homeActionId int?
isDismissed bool?

Return type

Object

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]

GetHomeActions

RestApiArrayResultHomeAction GetHomeActions (string appId)

Example

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

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

            var apiInstance = new HomeApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultHomeAction result = apiInstance.GetHomeActions(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.GetHomeActions: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

RestApiArrayResultHomeAction

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]

GetHomeStatistics

RestApiResultHomeStatistics GetHomeStatistics (string appId)

Example

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

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

            var apiInstance = new HomeApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultHomeStatistics result = apiInstance.GetHomeStatistics(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.GetHomeStatistics: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

RestApiResultHomeStatistics

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]

GetOktaPortalFeatureFlag

RestApiResultOktaPortalFeatureFlag GetOktaPortalFeatureFlag ()

Example

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

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

            var apiInstance = new HomeApi();

            try
            {
                RestApiResultOktaPortalFeatureFlag result = apiInstance.GetOktaPortalFeatureFlag();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.GetOktaPortalFeatureFlag: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultOktaPortalFeatureFlag

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]