PublicWebAppDataApi.md

Agravity.Public.Api.PublicWebAppDataApi

All URIs are relative to http://localhost:7072/api

Method	HTTP request	Description
HttpGetDataCollectionType	GET /data/collectiontype/{id}
HttpGetWebAppData	GET /webappdata/{id}

HttpGetDataCollectionType

GroupAllAppData HttpGetDataCollectionType (string id)

This returns all collections and assets from the given collection type.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;

namespace Example
{
    public class HttpGetDataCollectionTypeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:7072/api";
            // Configure API key authorization: function_key
            config.AddApiKey("x-functions-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-functions-key", "Bearer");

            var apiInstance = new PublicWebAppDataApi(config);
            var id = "id_example";  // string | The ID of the collection type for which this web data should be prepared.

            try
            {
                GroupAllAppData result = apiInstance.HttpGetDataCollectionType(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PublicWebAppDataApi.HttpGetDataCollectionType: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the HttpGetDataCollectionTypeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<GroupAllAppData> response = apiInstance.HttpGetDataCollectionTypeWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling PublicWebAppDataApi.HttpGetDataCollectionTypeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	The ID of the collection type for which this web data should be prepared.

Return type

GroupAllAppData

Authorization

function_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	This returns all collections and assets from the given collection type.	-
400	Unknown request method (Code: 2e7570d3-7667-4bc9-89ea-f5d6f5aa84c0)	-
404	Collection Type not found - Never existed, not a collection type or already deleted. (Code: 8f939f77-1ba9-40b7-905e-bef8ddc720a1)<br>or the web app data was never created (POST). (Code: 210910ed-68e8-4837-a58f-bfce0591cb49)	-
401	Unauthorized. API Key not provided.	-
500	Internal server error. Please contact administrator.	-

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

HttpGetWebAppData

AllWebAppData HttpGetWebAppData (string id)

This lists all elements of a given collection which can be used by the web frontend. It includes structure and all assets. All coming live from database.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;

namespace Example
{
    public class HttpGetWebAppDataExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:7072/api";
            // Configure API key authorization: function_key
            config.AddApiKey("x-functions-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-functions-key", "Bearer");

            var apiInstance = new PublicWebAppDataApi(config);
            var id = "id_example";  // string | The ID of the collection for which this web data should be prepared.

            try
            {
                AllWebAppData result = apiInstance.HttpGetWebAppData(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PublicWebAppDataApi.HttpGetWebAppData: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the HttpGetWebAppDataWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<AllWebAppData> response = apiInstance.HttpGetWebAppDataWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling PublicWebAppDataApi.HttpGetWebAppDataWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	The ID of the collection for which this web data should be prepared.

Return type

AllWebAppData

Authorization

function_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	This lists all elements which should be used by the web frontend.	-
400	Update failed. (Code: e85183ec-6183-4329-a74f-6ceb963967a3)	-
404	Collection not found - Never existed, not a collection or already deleted. (Code: 1d6325bf-7c1c-41ae-ba95-e41dd037a29f)	-
401	Unauthorized. API Key not provided.	-
500	Internal server error. Please contact administrator.	-

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