All URIs are relative to https://api.flipdish.co
| Method | HTTP request | Description |
|---|---|---|
| AppsSetPropertyId | POST /api/v1.0/apps/{appId}/orgId/{orgId} | |
| CreateApp | POST /api/v1.0/apps | |
| GetApp | GET /api/v1.0/apps/{appId} | |
| GetAppHostnameStatus | GET /api/v1.0/apps/{appId}/hostnamestatus | |
| GetAppName | GET /api/v1.0/apps/{appId}/name | |
| GetApps | GET /api/v1.0/apps | |
| GetCompliance | GET /api/v1.0/apps/{appId}/compliance | |
| GetPanaceaVanityUrl | GET /api/v1.0/apps/{appId}/panacea/url | |
| GetSupportedCountries | GET /api/v1.0/apps/supportedcountries | |
| IsPanaceaVanityUrlAvailable | GET /api/v1.0/apps/{appId}/panacea/url/available | |
| LookupByWhitelabelId | GET /api/v1.0/apps/{whitelabelId}/lookup | |
| SendPushNotification | POST /api/v1.0/apps/{appId}/SendPushNotification/{customerId} | |
| SetAppConfig | POST /api/v1.0/apps/{appId}/config | |
| SetAppHostname | POST /api/v1.0/apps/{appId}/hostname | |
| SetAppLanguages | POST /api/v1.0/apps/{appId}/config/languages | |
| SetAppStoreName | POST /api/v1.0/apps/{appId}/appstorename | |
| SetCompliance | POST /api/v1.0/apps/{appId}/compliance | |
| SetPanaceaVanityUrl | POST /api/v1.0/apps/{appId}/panacea/url | |
| ToggleNextGenWeb | POST /api/v1.0/apps/{appId}/nextgenweb | |
| UploadAppLogo | POST /api/v1.0/apps/{appId}/logo |
Object AppsSetPropertyId (string appId, string orgId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class AppsSetPropertyIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var orgId = orgId_example; // string |
try
{
Object result = apiInstance.AppsSetPropertyId(appId, orgId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.AppsSetPropertyId: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| orgId | string |
Object
- 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]
RestApiStringResult CreateApp (CreateAppParameters parameters)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class CreateAppExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var parameters = new CreateAppParameters(); // CreateAppParameters |
try
{
RestApiStringResult result = apiInstance.CreateApp(parameters);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.CreateApp: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| parameters | CreateAppParameters |
- 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]
RestApiResultApp GetApp (string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetAppExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
try
{
RestApiResultApp result = apiInstance.GetApp(appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetApp: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string |
- 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]
RestApiResultDnsRecordInformation GetAppHostnameStatus (string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetAppHostnameStatusExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
try
{
RestApiResultDnsRecordInformation result = apiInstance.GetAppHostnameStatus(appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetAppHostnameStatus: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string |
RestApiResultDnsRecordInformation
- 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]
RestApiStringResult GetAppName (string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetAppNameExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
try
{
RestApiStringResult result = apiInstance.GetAppName(appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetAppName: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string |
- 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]
RestApiPaginationResultApp GetApps (string nameFilter = null, int? page = null, int? limit = null)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetAppsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var nameFilter = nameFilter_example; // string | (optional)
var page = 56; // int? | (optional)
var limit = 56; // int? | (optional)
try
{
RestApiPaginationResultApp result = apiInstance.GetApps(nameFilter, page, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetApps: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| nameFilter | string | [optional] | |
| page | int? | [optional] | |
| limit | int? | [optional] |
- 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]
RestApiResultAppCompliance GetCompliance (string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetComplianceExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
try
{
RestApiResultAppCompliance result = apiInstance.GetCompliance(appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetCompliance: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string |
- 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]
RestApiStringResult GetPanaceaVanityUrl (string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetPanaceaVanityUrlExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
try
{
RestApiStringResult result = apiInstance.GetPanaceaVanityUrl(appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetPanaceaVanityUrl: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string |
- 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]
RestApiArrayResultSupportedCountry GetSupportedCountries ()
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class GetSupportedCountriesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
try
{
RestApiArrayResultSupportedCountry result = apiInstance.GetSupportedCountries();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.GetSupportedCountries: " + e.Message );
}
}
}
}This endpoint does not need any parameter.
RestApiArrayResultSupportedCountry
- 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]
RestApiStringResult IsPanaceaVanityUrlAvailable (string vanityUrl, string appId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class IsPanaceaVanityUrlAvailableExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var vanityUrl = vanityUrl_example; // string |
var appId = appId_example; // string |
try
{
RestApiStringResult result = apiInstance.IsPanaceaVanityUrlAvailable(vanityUrl, appId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.IsPanaceaVanityUrlAvailable: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| vanityUrl | string | ||
| appId | string |
- 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]
AppLookup LookupByWhitelabelId (int? whitelabelId)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class LookupByWhitelabelIdExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var whitelabelId = 56; // int? |
try
{
AppLookup result = apiInstance.LookupByWhitelabelId(whitelabelId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.LookupByWhitelabelId: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| whitelabelId | int? |
- 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]
void SendPushNotification (string appId, int? customerId, string message)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SendPushNotificationExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var customerId = 56; // int? |
var message = message_example; // string |
try
{
apiInstance.SendPushNotification(appId, customerId, message);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SendPushNotification: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| customerId | int? | ||
| message | string |
void (empty response body)
- 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]
RestApiResultApp SetAppConfig (string appId, AppConfigUpdateModel appConfigUpdate)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetAppConfigExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var appConfigUpdate = new AppConfigUpdateModel(); // AppConfigUpdateModel |
try
{
RestApiResultApp result = apiInstance.SetAppConfig(appId, appConfigUpdate);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetAppConfig: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| appConfigUpdate | AppConfigUpdateModel |
- 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]
RestApiStringResult SetAppHostname (string appId, string hostname, bool? isEmbed = null)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetAppHostnameExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var hostname = hostname_example; // string |
var isEmbed = true; // bool? | (optional)
try
{
RestApiStringResult result = apiInstance.SetAppHostname(appId, hostname, isEmbed);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetAppHostname: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| hostname | string | ||
| isEmbed | bool? | [optional] |
- 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]
RestApiResultApp SetAppLanguages (string appId, List languages)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetAppLanguagesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var languages = new List<Language>(); // List<Language> |
try
{
RestApiResultApp result = apiInstance.SetAppLanguages(appId, languages);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetAppLanguages: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| languages | List<Language> |
- 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]
void SetAppStoreName (string appId, string appStoreName)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetAppStoreNameExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var appStoreName = appStoreName_example; // string |
try
{
apiInstance.SetAppStoreName(appId, appStoreName);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetAppStoreName: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| appStoreName | string |
void (empty response body)
- 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]
RestApiResultAppCompliance SetCompliance (string appId, string complianceType)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetComplianceExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var complianceType = complianceType_example; // string |
try
{
RestApiResultAppCompliance result = apiInstance.SetCompliance(appId, complianceType);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetCompliance: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| complianceType | string |
- 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]
RestApiStringResult SetPanaceaVanityUrl (string appId, string vanityUrl)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class SetPanaceaVanityUrlExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var vanityUrl = vanityUrl_example; // string |
try
{
RestApiStringResult result = apiInstance.SetPanaceaVanityUrl(appId, vanityUrl);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.SetPanaceaVanityUrl: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| vanityUrl | string |
- 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]
RestApiStringResult ToggleNextGenWeb (string appId, string hostname, string vanityUrl, bool? isNextGenWeb)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class ToggleNextGenWebExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var hostname = hostname_example; // string |
var vanityUrl = vanityUrl_example; // string |
var isNextGenWeb = true; // bool? |
try
{
RestApiStringResult result = apiInstance.ToggleNextGenWeb(appId, hostname, vanityUrl, isNextGenWeb);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.ToggleNextGenWeb: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| hostname | string | ||
| vanityUrl | string | ||
| isNextGenWeb | bool? |
- 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]
void UploadAppLogo (string appId, System.IO.Stream image)
using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;
namespace Example
{
public class UploadAppLogoExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AppsApi();
var appId = appId_example; // string |
var image = new System.IO.Stream(); // System.IO.Stream | App Logo
try
{
apiInstance.UploadAppLogo(appId, image);
}
catch (Exception e)
{
Debug.Print("Exception when calling AppsApi.UploadAppLogo: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| appId | string | ||
| image | System.IO.Stream | App Logo |
void (empty response body)
- Content-Type: multipart/form-data
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]