Skip to content

Latest commit

 

History

History
306 lines (214 loc) · 9.13 KB

ExchangeApi.md

File metadata and controls

306 lines (214 loc) · 9.13 KB
Raw

TelstraTPN.ExchangeApi

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

Method HTTP request Description
account_profile_exchange GET /1.0.0/account/profile/exchange Get the current account's Exchange profile
exchange GET /1.0.0/exchange List all Exchange providers, with POPs
exchange_exprovuuid GET /1.0.0/exchange/{exprovuuid} Exchange provider details
visitcard GET /1.0.0/visitcard Get list of Visit Cards
visitcard_uuid_get GET /1.0.0/visitcard/{visitcarduuid} View details of the specified Visit Card
visitcard_uuid_put PUT /1.0.0/visitcard/{visitcarduuid} Update details of the specified Visit Card

account_profile_exchange

InlineResponse20012 account_profile_exchange()

Get the current account's Exchange profile

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))

try:
    # Get the current account's Exchange profile
    api_response = api_instance.account_profile_exchange()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->account_profile_exchange: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse20012

Authorization

oAuth2

HTTP request headers

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

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

exchange

list[ExchangeProvider] exchange()

List all Exchange providers, with POPs

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))

try:
    # List all Exchange providers, with POPs
    api_response = api_instance.exchange()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->exchange: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[ExchangeProvider]

Authorization

oAuth2

HTTP request headers

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

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

exchange_exprovuuid

ExchangeProvider exchange_exprovuuid(exprovuuid)

Exchange provider details

Get information about the specified Exchange provider

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))
exprovuuid = 'exprovuuid_example' # str | Unique identifier representing a specific exchange provider

try:
    # Exchange provider details
    api_response = api_instance.exchange_exprovuuid(exprovuuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->exchange_exprovuuid: %s\n" % e)

Parameters

Name Type Description Notes
exprovuuid str Unique identifier representing a specific exchange provider

Return type

ExchangeProvider

Authorization

oAuth2

HTTP request headers

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

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

visitcard

list[Visitcard] visitcard()

Get list of Visit Cards

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))

try:
    # Get list of Visit Cards
    api_response = api_instance.visitcard()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->visitcard: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Visitcard]

Authorization

oAuth2

HTTP request headers

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

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

visitcard_uuid_get

Visitcard visitcard_uuid_get(visitcarduuid)

View details of the specified Visit Card

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))
visitcarduuid = 'visitcarduuid_example' # str | Unique identifier representing a specific exchange visit card (provider description)

try:
    # View details of the specified Visit Card
    api_response = api_instance.visitcard_uuid_get(visitcarduuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->visitcard_uuid_get: %s\n" % e)

Parameters

Name Type Description Notes
visitcarduuid str Unique identifier representing a specific exchange visit card (provider description)

Return type

Visitcard

Authorization

oAuth2

HTTP request headers

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

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

visitcard_uuid_put

Visitcard visitcard_uuid_put(visitcarduuid, unknown_base_type=unknown_base_type)

Update details of the specified Visit Card

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.ExchangeApi(TelstraTPN.ApiClient(configuration))
visitcarduuid = 'visitcarduuid_example' # str | Unique identifier representing a specific exchange visit card (provider description)
unknown_base_type = TelstraTPN.UNKNOWN_BASE_TYPE() # UNKNOWN_BASE_TYPE |  (optional)

try:
    # Update details of the specified Visit Card
    api_response = api_instance.visitcard_uuid_put(visitcarduuid, unknown_base_type=unknown_base_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExchangeApi->visitcard_uuid_put: %s\n" % e)

Parameters

Name Type Description Notes
visitcarduuid str Unique identifier representing a specific exchange visit card (provider description)
unknown_base_type UNKNOWN_BASE_TYPE [optional]

Return type

Visitcard

Authorization

oAuth2

HTTP request headers

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

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