Skip to content

Latest commit

 

History

History
214 lines (159 loc) · 7.38 KB

ContractsApi.md

File metadata and controls

214 lines (159 loc) · 7.38 KB
Raw

IO.TelstraTPN.Api.ContractsApi

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

Method HTTP request Description
InventoryLinksContractByLinkidAndContractidGet GET /1.0.0/inventory/links/{linkid}/contract/{contractid} Get active Contract by ContractID
InventoryLinksContractByLinkidAndContractidPut PUT /1.0.0/inventory/links/{linkid}/contract/{contractid} Update active Contract by ContractID
InventoryLinksContractByLinkidPost POST /1.0.0/inventory/links/{linkid}/contract Create new Contract on specified link

InventoryLinksContractByLinkidAndContractidGet

InventoryLinksContractResponse InventoryLinksContractByLinkidAndContractidGet (string linkid, string contractid)

Get active Contract by ContractID

Get active Contract by ContractID

Example

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

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

            var apiInstance = new ContractsApi();
            var linkid = linkid_example;  // string | Unique identifier representing a specific link
            var contractid = contractid_example;  // string | Unique identifier representing a specific contract

            try
            {
                // Get active Contract by ContractID
                InventoryLinksContractResponse result = apiInstance.InventoryLinksContractByLinkidAndContractidGet(linkid, contractid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContractsApi.InventoryLinksContractByLinkidAndContractidGet: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

InventoryLinksContractResponse

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]

InventoryLinksContractByLinkidAndContractidPut

InventoryLinksContractResponse33 InventoryLinksContractByLinkidAndContractidPut (string linkid, string contractid, InventoryLinksContractRequest body)

Update active Contract by ContractID

Update active Contract by ContractID

Example

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

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

            var apiInstance = new ContractsApi();
            var linkid = linkid_example;  // string | Unique identifier representing a specific link
            var contractid = contractid_example;  // string | Unique identifier representing a specific contract
            var body = new InventoryLinksContractRequest(); // InventoryLinksContractRequest |  (optional) 

            try
            {
                // Update active Contract by ContractID
                InventoryLinksContractResponse33 result = apiInstance.InventoryLinksContractByLinkidAndContractidPut(linkid, contractid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContractsApi.InventoryLinksContractByLinkidAndContractidPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
linkid string Unique identifier representing a specific link
contractid string Unique identifier representing a specific contract
body InventoryLinksContractRequest [optional]

Return type

InventoryLinksContractResponse33

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]

InventoryLinksContractByLinkidPost

List InventoryLinksContractByLinkidPost (string linkid, InventoryLinksContractRequest37 body)

Create new Contract on specified link

Create new Contract on specified link

Example

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

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

            var apiInstance = new ContractsApi();
            var linkid = linkid_example;  // string | Unique identifier representing a specific link
            var body = new InventoryLinksContractRequest37(); // InventoryLinksContractRequest37 |  (optional) 

            try
            {
                // Create new Contract on specified link
                List<InventoryLinksContractResponse38> result = apiInstance.InventoryLinksContractByLinkidPost(linkid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContractsApi.InventoryLinksContractByLinkidPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
linkid string Unique identifier representing a specific link
body InventoryLinksContractRequest37 [optional]

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]