SpanApi.md

Com.Lab5e.Span.Api.SpanApi

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

Method	HTTP request	Description
GetSystemInfo	GET /span/system	System information

GetSystemInfo

SystemInfoResponse GetSystemInfo ()

System information

Get system information. This will show the current version of the API that you are using.

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 GetSystemInfoExample
    {
        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 SpanApi(config);

            try
            {
                // System information
                SystemInfoResponse result = apiInstance.GetSystemInfo();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SpanApi.GetSystemInfo: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetSystemInfoWithHttpInfo variant

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

try
{
    // System information
    ApiResponse<SystemInfoResponse> response = apiInstance.GetSystemInfoWithHttpInfo();
    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 SpanApi.GetSystemInfoWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

SystemInfoResponse

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]