Com.Lab5e.Span.Api.GatewaysApi

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
CreateGateway	POST /span/collections/{collectionId}/gateways	Create gateway
DeleteGateway	DELETE /span/collections/{collectionId}/gateways/{gatewayId}	Delete gateway
GatewayCertificates	GET /span/collections/{collectionId}/gateways/{gatewayId}/certs	Get issued certificate(s) for gateway
ListGateways	GET /span/collections/{collectionId}/gateways	List gateways
RetrieveGateway	GET /span/collections/{collectionId}/gateways/{gatewayId}	Retrieve gateway
RetrieveGatewayStats	GET /span/collections/{collectionId}/gateways/{gatewayId}/stats	Retrieve gateway statistics
UpdateGateway	PATCH /span/collections/{existingCollectionId}/gateways/{gatewayId}	Update gateway

CreateGateway

Gateway CreateGateway (string collectionId, CreateGatewayBody body)

Create gateway

Create a new gateway.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class CreateGatewayExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 
            var body = new CreateGatewayBody(); // CreateGatewayBody | 

            try
            {
                // Create gateway
                Gateway result = apiInstance.CreateGateway(collectionId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.CreateGateway: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateGatewayWithHttpInfo variant

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

try
{
    // Create gateway
    ApiResponse<Gateway> response = apiInstance.CreateGatewayWithHttpInfo(collectionId, body);
    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 GatewaysApi.CreateGatewayWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
body	CreateGatewayBody

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

DeleteGateway

Gateway DeleteGateway (string collectionId, string gatewayId)

Delete gateway

Remove a gateway from Span.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class DeleteGatewayExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 
            var gatewayId = "gatewayId_example";  // string | 

            try
            {
                // Delete gateway
                Gateway result = apiInstance.DeleteGateway(collectionId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.DeleteGateway: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteGatewayWithHttpInfo variant

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

try
{
    // Delete gateway
    ApiResponse<Gateway> response = apiInstance.DeleteGatewayWithHttpInfo(collectionId, gatewayId);
    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 GatewaysApi.DeleteGatewayWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
gatewayId	string

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

GatewayCertificates

GatewayCertificateResponse GatewayCertificates (string collectionId, string gatewayId)

Get issued certificate(s) for gateway

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class GatewayCertificatesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 
            var gatewayId = "gatewayId_example";  // string | 

            try
            {
                // Get issued certificate(s) for gateway
                GatewayCertificateResponse result = apiInstance.GatewayCertificates(collectionId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.GatewayCertificates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GatewayCertificatesWithHttpInfo variant

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

try
{
    // Get issued certificate(s) for gateway
    ApiResponse<GatewayCertificateResponse> response = apiInstance.GatewayCertificatesWithHttpInfo(collectionId, gatewayId);
    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 GatewaysApi.GatewayCertificatesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
gatewayId	string

Return type

GatewayCertificateResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

ListGateways

ListGatewayResponse ListGateways (string collectionId)

List gateways

List the user's gatways, including built-in gateways.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class ListGatewaysExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 

            try
            {
                // List gateways
                ListGatewayResponse result = apiInstance.ListGateways(collectionId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.ListGateways: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ListGatewaysWithHttpInfo variant

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

try
{
    // List gateways
    ApiResponse<ListGatewayResponse> response = apiInstance.ListGatewaysWithHttpInfo(collectionId);
    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 GatewaysApi.ListGatewaysWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string

Return type

ListGatewayResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

RetrieveGateway

Gateway RetrieveGateway (string collectionId, string gatewayId)

Retrieve gateway

Get gateway information

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class RetrieveGatewayExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 
            var gatewayId = "gatewayId_example";  // string | 

            try
            {
                // Retrieve gateway
                Gateway result = apiInstance.RetrieveGateway(collectionId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.RetrieveGateway: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RetrieveGatewayWithHttpInfo variant

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

try
{
    // Retrieve gateway
    ApiResponse<Gateway> response = apiInstance.RetrieveGatewayWithHttpInfo(collectionId, gatewayId);
    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 GatewaysApi.RetrieveGatewayWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
gatewayId	string

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

RetrieveGatewayStats

GatewayStats RetrieveGatewayStats (string collectionId, string gatewayId)

Retrieve gateway statistics

Get statistics for gateway

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class RetrieveGatewayStatsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var collectionId = "collectionId_example";  // string | 
            var gatewayId = "gatewayId_example";  // string | 

            try
            {
                // Retrieve gateway statistics
                GatewayStats result = apiInstance.RetrieveGatewayStats(collectionId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.RetrieveGatewayStats: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RetrieveGatewayStatsWithHttpInfo variant

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

try
{
    // Retrieve gateway statistics
    ApiResponse<GatewayStats> response = apiInstance.RetrieveGatewayStatsWithHttpInfo(collectionId, gatewayId);
    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 GatewaysApi.RetrieveGatewayStatsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
gatewayId	string

Return type

GatewayStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

UpdateGateway

Gateway UpdateGateway (string existingCollectionId, string gatewayId, UpdateGatewayBody body)

Update gateway

Update configuration for a gateway. If you want to remove or move a gateway from the collection the devices in the collection must not have any gateway configuration. The certificates for the gateway are unchanged when the gateway is moved.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class UpdateGatewayExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new GatewaysApi(config);
            var existingCollectionId = "existingCollectionId_example";  // string | 
            var gatewayId = "gatewayId_example";  // string | 
            var body = new UpdateGatewayBody(); // UpdateGatewayBody | 

            try
            {
                // Update gateway
                Gateway result = apiInstance.UpdateGateway(existingCollectionId, gatewayId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling GatewaysApi.UpdateGateway: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateGatewayWithHttpInfo variant

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

try
{
    // Update gateway
    ApiResponse<Gateway> response = apiInstance.UpdateGatewayWithHttpInfo(existingCollectionId, gatewayId, body);
    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 GatewaysApi.UpdateGatewayWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
existingCollectionId	string
gatewayId	string
body	UpdateGatewayBody

Return type

Gateway

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

Files

GatewaysApi.md

Latest commit

History

GatewaysApi.md

File metadata and controls

Com.Lab5e.Span.Api.GatewaysApi

CreateGateway

Example

Using the CreateGatewayWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteGateway

Example

Using the DeleteGatewayWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GatewayCertificates

Example

Using the GatewayCertificatesWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListGateways

Example

Using the ListGatewaysWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetrieveGateway

Example

Using the RetrieveGatewayWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetrieveGatewayStats

Example

Using the RetrieveGatewayStatsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateGateway

Example

Using the UpdateGatewayWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details