LinksApi.md

IO.TelstraTPN.Api.LinksApi

All URIs are relative to https://penapi.pacnetconnect.com

Method	HTTP request	Description
InventoryLinkPost	POST /1.0.0/inventory/link	Create Link and initial Contract
InventoryLinksByLinkidGet	GET /1.0.0/inventory/links/{linkid}	Get details of specified link
InventoryLinksCustomerByCustomeruuidGet	GET /1.0.0/inventory/links/customer/{customeruuid}	Get active Links
InventoryLinksHistoryByLinkidGet	GET /1.0.0/inventory/links/history/{linkid}	Get Link history

InventoryLinkPost

InventoryLinkResponse InventoryLinkPost (InventoryLinkRequest body)

Create Link and initial Contract

Create Link and initial Contract

Example

using System;
using System.Diagnostics;
using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

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

            var apiInstance = new LinksApi();
            var body = new InventoryLinkRequest(); // InventoryLinkRequest |  (optional) 

            try
            {
                // Create Link and initial Contract
                InventoryLinkResponse result = apiInstance.InventoryLinkPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LinksApi.InventoryLinkPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	InventoryLinkRequest		[optional]

Return type

InventoryLinkResponse

Authorization

auth

HTTP request headers

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

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

InventoryLinksByLinkidGet

InventoryLinksResponse InventoryLinksByLinkidGet (string linkid)

Get details of specified link

Get details of specified link

Example

using System;
using System.Diagnostics;
using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

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

            var apiInstance = new LinksApi();
            var linkid = linkid_example;  // string | Unique identifier representing a specific link

            try
            {
                // Get details of specified link
                InventoryLinksResponse result = apiInstance.InventoryLinksByLinkidGet(linkid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LinksApi.InventoryLinksByLinkidGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
linkid	string	Unique identifier representing a specific link

Return type

InventoryLinksResponse

Authorization

auth

HTTP request headers

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

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

InventoryLinksCustomerByCustomeruuidGet

List InventoryLinksCustomerByCustomeruuidGet (string customeruuid)

Get active Links

Get active Links

Example

using System;
using System.Diagnostics;
using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

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

            var apiInstance = new LinksApi();
            var customeruuid = customeruuid_example;  // string | Unique identifier representing a specific customer

            try
            {
                // Get active Links
                List<Link> result = apiInstance.InventoryLinksCustomerByCustomeruuidGet(customeruuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LinksApi.InventoryLinksCustomerByCustomeruuidGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
customeruuid	string	Unique identifier representing a specific customer

Return type

List

Authorization

auth

HTTP request headers

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

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

InventoryLinksHistoryByLinkidGet

InventoryLinksHistoryResponse InventoryLinksHistoryByLinkidGet (string linkid)

Get Link history

Get Link history

Example

using System;
using System.Diagnostics;
using IO.TelstraTPN.Api;
using IO.TelstraTPN;
using IO.TelstraTPN.Model;

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

            var apiInstance = new LinksApi();
            var linkid = linkid_example;  // string | Unique identifier representing a specific link

            try
            {
                // Get Link history
                InventoryLinksHistoryResponse result = apiInstance.InventoryLinksHistoryByLinkidGet(linkid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LinksApi.InventoryLinksHistoryByLinkidGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
linkid	string	Unique identifier representing a specific link

Return type

InventoryLinksHistoryResponse

Authorization

auth

HTTP request headers

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

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