B2ctelco Tmf Webservices

ChecklistAction

getChecklistActions

Retrieve the Checklist Actions for the given context


/checklistAction

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/xml,application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/checklistAction?baseSiteId=&fields=&processType.id=&productOffering.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChecklistActionApi;

import java.io.File;
import java.util.*;

public class ChecklistActionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ChecklistActionApi apiInstance = new ChecklistActionApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma separated properties to display in response
        String processType.id = processType.id_example; // String | Purchase Flow for which to retrieve the Checklist Actions
        array[String] productOffering.id = ; // array[String] | Product Offering IDs for which to retrieve the Checklist Actions
        try {
            array[ChecklistAction] result = apiInstance.getChecklistActions(baseSiteId, fields, processType.id, productOffering.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChecklistActionApi#getChecklistActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChecklistActionApi;

public class ChecklistActionApiExample {

    public static void main(String[] args) {
        ChecklistActionApi apiInstance = new ChecklistActionApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma separated properties to display in response
        String processType.id = processType.id_example; // String | Purchase Flow for which to retrieve the Checklist Actions
        array[String] productOffering.id = ; // array[String] | Product Offering IDs for which to retrieve the Checklist Actions
        try {
            array[ChecklistAction] result = apiInstance.getChecklistActions(baseSiteId, fields, processType.id, productOffering.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChecklistActionApi#getChecklistActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Comma separated properties to display in response (optional)
String *processType.id = processType.id_example; // Purchase Flow for which to retrieve the Checklist Actions (optional)
array[String] *productOffering.id = ; // Product Offering IDs for which to retrieve the Checklist Actions (optional)

ChecklistActionApi *apiInstance = [[ChecklistActionApi alloc] init];

// Retrieve the Checklist Actions for the given context
[apiInstance getChecklistActionsWith:baseSiteId
    fields:fields
    processType.id:processType.id
    productOffering.id:productOffering.id
              completionHandler: ^(array[ChecklistAction] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ChecklistActionApi()
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Comma separated properties to display in response
  'processType.id': processType.id_example, // {{String}} Purchase Flow for which to retrieve the Checklist Actions
  'productOffering.id':  // {{array[String]}} Product Offering IDs for which to retrieve the Checklist Actions
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChecklistActions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChecklistActionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ChecklistActionApi();
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 
            var processType.id = processType.id_example;  // String | Purchase Flow for which to retrieve the Checklist Actions (optional) 
            var productOffering.id = new array[String](); // array[String] | Product Offering IDs for which to retrieve the Checklist Actions (optional) 

            try
            {
                // Retrieve the Checklist Actions for the given context
                array[ChecklistAction] result = apiInstance.getChecklistActions(baseSiteId, fields, processType.id, productOffering.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChecklistActionApi.getChecklistActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiChecklistActionApi();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma separated properties to display in response
$processType.id = processType.id_example; // String | Purchase Flow for which to retrieve the Checklist Actions
$productOffering.id = ; // array[String] | Product Offering IDs for which to retrieve the Checklist Actions

try {
    $result = $api_instance->getChecklistActions($baseSiteId, $fields, $processType.id, $productOffering.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChecklistActionApi->getChecklistActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChecklistActionApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ChecklistActionApi->new();
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma separated properties to display in response
my $processType.id = processType.id_example; # String | Purchase Flow for which to retrieve the Checklist Actions
my $productOffering.id = []; # array[String] | Product Offering IDs for which to retrieve the Checklist Actions

eval { 
    my $result = $api_instance->getChecklistActions(baseSiteId => $baseSiteId, fields => $fields, processType.id => $processType.id, productOffering.id => $productOffering.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChecklistActionApi->getChecklistActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ChecklistActionApi()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma separated properties to display in response (optional)
processType.id = processType.id_example # String | Purchase Flow for which to retrieve the Checklist Actions (optional)
productOffering.id =  # array[String] | Product Offering IDs for which to retrieve the Checklist Actions (optional)

try: 
    # Retrieve the Checklist Actions for the given context
    api_response = api_instance.get_checklist_actions(baseSiteId=baseSiteId, fields=fields, processType.id=processType.id, productOffering.id=productOffering.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChecklistActionApi->getChecklistActions: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Comma separated properties to display in response
processType.id
String
Purchase Flow for which to retrieve the Checklist Actions
productOffering.id
array[String]
Product Offering IDs for which to retrieve the Checklist Actions

Responses

Status: 200 - Ok

Status: 206 - Partial Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


CustomerProductInventory

listSubscriptionBase

List or find 'SubscriptionBase' objects


/subscriptionBase

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/subscriptionBase?fields=&subscriptionAccess.relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerProductInventoryApi;

import java.io.File;
import java.util.*;

public class CustomerProductInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerProductInventoryApi apiInstance = new CustomerProductInventoryApi();
        String subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; // String | Unique identifier of the Related Party
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[SubscriptionBase] result = apiInstance.listSubscriptionBase(subscriptionAccess.relatedParty.id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerProductInventoryApi#listSubscriptionBase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerProductInventoryApi;

public class CustomerProductInventoryApiExample {

    public static void main(String[] args) {
        CustomerProductInventoryApi apiInstance = new CustomerProductInventoryApi();
        String subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; // String | Unique identifier of the Related Party
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[SubscriptionBase] result = apiInstance.listSubscriptionBase(subscriptionAccess.relatedParty.id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerProductInventoryApi#listSubscriptionBase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; // Unique identifier of the Related Party
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)

CustomerProductInventoryApi *apiInstance = [[CustomerProductInventoryApi alloc] init];

// List or find 'SubscriptionBase' objects
[apiInstance listSubscriptionBaseWith:subscriptionAccess.relatedParty.id
    fields:fields
              completionHandler: ^(array[SubscriptionBase] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.CustomerProductInventoryApi()
var subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; // {{String}} Unique identifier of the Related Party
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscriptionBase(subscriptionAccess.relatedParty.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSubscriptionBaseExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerProductInventoryApi();
            var subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example;  // String | Unique identifier of the Related Party
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 

            try
            {
                // List or find 'SubscriptionBase' objects
                array[SubscriptionBase] result = apiInstance.listSubscriptionBase(subscriptionAccess.relatedParty.id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerProductInventoryApi.listSubscriptionBase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerProductInventoryApi();
$subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; // String | Unique identifier of the Related Party
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body

try {
    $result = $api_instance->listSubscriptionBase($subscriptionAccess.relatedParty.id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerProductInventoryApi->listSubscriptionBase: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerProductInventoryApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerProductInventoryApi->new();
my $subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example; # String | Unique identifier of the Related Party
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body

eval { 
    my $result = $api_instance->listSubscriptionBase(subscriptionAccess.relatedParty.id => $subscriptionAccess.relatedParty.id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerProductInventoryApi->listSubscriptionBase: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerProductInventoryApi()
subscriptionAccess.relatedParty.id = subscriptionAccess.relatedParty.id_example # String | Unique identifier of the Related Party
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)

try: 
    # List or find 'SubscriptionBase' objects
    api_response = api_instance.list_subscription_base(subscriptionAccess.relatedParty.id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerProductInventoryApi->listSubscriptionBase: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body
subscriptionAccess.relatedParty.id*
String
Unique identifier of the Related Party
Required

Responses

Status: 200 - Ok

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


DeliveryMode

listDeliveryMode

Retrieves a list of 'DeliveryMode'


/deliveryMode

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/deliveryMode?baseSiteId=&description=&fields=&name=&relatedParty.id=&shoppingCart.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliveryModeApi;

import java.io.File;
import java.util.*;

public class DeliveryModeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DeliveryModeApi apiInstance = new DeliveryModeApi();
        String relatedParty.id = relatedParty.id_example; // String | Unique identifier of the Related Party
        String shoppingCart.id = shoppingCart.id_example; // String | Unique identifier of the Shopping Cart
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String description = description_example; // String | For filtering: Description of deliveryMode
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String name = name_example; // String | For filtering: Name of deliveryMode
        try {
            array[DeliveryMode] result = apiInstance.listDeliveryMode(relatedParty.id, shoppingCart.id, baseSiteId, description, fields, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryModeApi#listDeliveryMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliveryModeApi;

public class DeliveryModeApiExample {

    public static void main(String[] args) {
        DeliveryModeApi apiInstance = new DeliveryModeApi();
        String relatedParty.id = relatedParty.id_example; // String | Unique identifier of the Related Party
        String shoppingCart.id = shoppingCart.id_example; // String | Unique identifier of the Shopping Cart
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String description = description_example; // String | For filtering: Description of deliveryMode
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String name = name_example; // String | For filtering: Name of deliveryMode
        try {
            array[DeliveryMode] result = apiInstance.listDeliveryMode(relatedParty.id, shoppingCart.id, baseSiteId, description, fields, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryModeApi#listDeliveryMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *relatedParty.id = relatedParty.id_example; // Unique identifier of the Related Party
String *shoppingCart.id = shoppingCart.id_example; // Unique identifier of the Shopping Cart
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *description = description_example; // For filtering: Description of deliveryMode (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *name = name_example; // For filtering: Name of deliveryMode (optional)

DeliveryModeApi *apiInstance = [[DeliveryModeApi alloc] init];

// Retrieves a list of 'DeliveryMode'
[apiInstance listDeliveryModeWith:relatedParty.id
    shoppingCart.id:shoppingCart.id
    baseSiteId:baseSiteId
    description:description
    fields:fields
    name:name
              completionHandler: ^(array[DeliveryMode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.DeliveryModeApi()
var relatedParty.id = relatedParty.id_example; // {{String}} Unique identifier of the Related Party
var shoppingCart.id = shoppingCart.id_example; // {{String}} Unique identifier of the Shopping Cart
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'description': description_example, // {{String}} For filtering: Description of deliveryMode
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'name': name_example // {{String}} For filtering: Name of deliveryMode
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDeliveryMode(relatedParty.id, shoppingCart.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listDeliveryModeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeliveryModeApi();
            var relatedParty.id = relatedParty.id_example;  // String | Unique identifier of the Related Party
            var shoppingCart.id = shoppingCart.id_example;  // String | Unique identifier of the Shopping Cart
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var description = description_example;  // String | For filtering: Description of deliveryMode (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var name = name_example;  // String | For filtering: Name of deliveryMode (optional) 

            try
            {
                // Retrieves a list of 'DeliveryMode'
                array[DeliveryMode] result = apiInstance.listDeliveryMode(relatedParty.id, shoppingCart.id, baseSiteId, description, fields, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryModeApi.listDeliveryMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeliveryModeApi();
$relatedParty.id = relatedParty.id_example; // String | Unique identifier of the Related Party
$shoppingCart.id = shoppingCart.id_example; // String | Unique identifier of the Shopping Cart
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$description = description_example; // String | For filtering: Description of deliveryMode
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$name = name_example; // String | For filtering: Name of deliveryMode

try {
    $result = $api_instance->listDeliveryMode($relatedParty.id, $shoppingCart.id, $baseSiteId, $description, $fields, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryModeApi->listDeliveryMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeliveryModeApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeliveryModeApi->new();
my $relatedParty.id = relatedParty.id_example; # String | Unique identifier of the Related Party
my $shoppingCart.id = shoppingCart.id_example; # String | Unique identifier of the Shopping Cart
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $description = description_example; # String | For filtering: Description of deliveryMode
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $name = name_example; # String | For filtering: Name of deliveryMode

eval { 
    my $result = $api_instance->listDeliveryMode(relatedParty.id => $relatedParty.id, shoppingCart.id => $shoppingCart.id, baseSiteId => $baseSiteId, description => $description, fields => $fields, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeliveryModeApi->listDeliveryMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeliveryModeApi()
relatedParty.id = relatedParty.id_example # String | Unique identifier of the Related Party
shoppingCart.id = shoppingCart.id_example # String | Unique identifier of the Shopping Cart
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
description = description_example # String | For filtering: Description of deliveryMode (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
name = name_example # String | For filtering: Name of deliveryMode (optional)

try: 
    # Retrieves a list of 'DeliveryMode'
    api_response = api_instance.list_delivery_mode(relatedParty.id, shoppingCart.id, baseSiteId=baseSiteId, description=description, fields=fields, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliveryModeApi->listDeliveryMode: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
description
String
For filtering: Description of deliveryMode
fields
String
Response configuration. This is the list of fields that should be returned in the response body
name
String
For filtering: Name of deliveryMode
relatedParty.id*
String
Unique identifier of the Related Party
Required
shoppingCart.id*
String
Unique identifier of the Shopping Cart
Required

Responses

Status: 200 - Ok

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


GeographicAddressManagement

createGeographicAddress

Creates a 'Geographic Address'

This operation creates a new geographic address entity for the related party.


/geographicAddress

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/geographicAddress?relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeographicAddressManagementApi;

import java.io.File;
import java.util.*;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        GeographicAddress body = ; // GeographicAddress | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            GeographicAddress result = apiInstance.createGeographicAddress(body, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#createGeographicAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        GeographicAddress body = ; // GeographicAddress | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            GeographicAddress result = apiInstance.createGeographicAddress(body, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#createGeographicAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
GeographicAddress *body = ; // 
String *relatedParty.id = relatedParty.id_example; // The id of the related party.

GeographicAddressManagementApi *apiInstance = [[GeographicAddressManagementApi alloc] init];

// Creates a 'Geographic Address'
[apiInstance createGeographicAddressWith:body
    relatedParty.id:relatedParty.id
              completionHandler: ^(GeographicAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.GeographicAddressManagementApi()
var body = ; // {{GeographicAddress}} 
var relatedParty.id = relatedParty.id_example; // {{String}} The id of the related party.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createGeographicAddress(bodyrelatedParty.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGeographicAddressExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GeographicAddressManagementApi();
            var body = new GeographicAddress(); // GeographicAddress | 
            var relatedParty.id = relatedParty.id_example;  // String | The id of the related party.

            try
            {
                // Creates a 'Geographic Address'
                GeographicAddress result = apiInstance.createGeographicAddress(body, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.createGeographicAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGeographicAddressManagementApi();
$body = ; // GeographicAddress | 
$relatedParty.id = relatedParty.id_example; // String | The id of the related party.

try {
    $result = $api_instance->createGeographicAddress($body, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->createGeographicAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeographicAddressManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GeographicAddressManagementApi->new();
my $body = WWW::SwaggerClient::Object::GeographicAddress->new(); # GeographicAddress | 
my $relatedParty.id = relatedParty.id_example; # String | The id of the related party.

eval { 
    my $result = $api_instance->createGeographicAddress(body => $body, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->createGeographicAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GeographicAddressManagementApi()
body =  # GeographicAddress | 
relatedParty.id = relatedParty.id_example # String | The id of the related party.

try: 
    # Creates a 'Geographic Address'
    api_response = api_instance.create_geographic_address(body, relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->createGeographicAddress: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
relatedParty.id*
String
The id of the related party.
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


deleteGeographicAddress

Deletes a GeographicAddress

This operation deletes a GeographicAddress entity.


/geographicAddress/{id}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/geographicAddress/{id}?relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeographicAddressManagementApi;

import java.io.File;
import java.util.*;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String id = id_example; // String | Unique identifier of the geographic address
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            apiInstance.deleteGeographicAddress(id, relatedParty.id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#deleteGeographicAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String id = id_example; // String | Unique identifier of the geographic address
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            apiInstance.deleteGeographicAddress(id, relatedParty.id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#deleteGeographicAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Unique identifier of the geographic address
String *relatedParty.id = relatedParty.id_example; // Id of a specific party role for which the addresses should be provided

GeographicAddressManagementApi *apiInstance = [[GeographicAddressManagementApi alloc] init];

// Deletes a GeographicAddress
[apiInstance deleteGeographicAddressWith:id
    relatedParty.id:relatedParty.id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.GeographicAddressManagementApi()
var id = id_example; // {{String}} Unique identifier of the geographic address
var relatedParty.id = relatedParty.id_example; // {{String}} Id of a specific party role for which the addresses should be provided

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteGeographicAddress(id, relatedParty.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteGeographicAddressExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GeographicAddressManagementApi();
            var id = id_example;  // String | Unique identifier of the geographic address
            var relatedParty.id = relatedParty.id_example;  // String | Id of a specific party role for which the addresses should be provided

            try
            {
                // Deletes a GeographicAddress
                apiInstance.deleteGeographicAddress(id, relatedParty.id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.deleteGeographicAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGeographicAddressManagementApi();
$id = id_example; // String | Unique identifier of the geographic address
$relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided

try {
    $api_instance->deleteGeographicAddress($id, $relatedParty.id);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->deleteGeographicAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeographicAddressManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GeographicAddressManagementApi->new();
my $id = id_example; # String | Unique identifier of the geographic address
my $relatedParty.id = relatedParty.id_example; # String | Id of a specific party role for which the addresses should be provided

eval { 
    $api_instance->deleteGeographicAddress(id => $id, relatedParty.id => $relatedParty.id);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->deleteGeographicAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GeographicAddressManagementApi()
id = id_example # String | Unique identifier of the geographic address
relatedParty.id = relatedParty.id_example # String | Id of a specific party role for which the addresses should be provided

try: 
    # Deletes a GeographicAddress
    api_instance.delete_geographic_address(id, relatedParty.id)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->deleteGeographicAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Unique identifier of the geographic address
Required
Query parameters
Name Description
relatedParty.id*
String
Id of a specific party role for which the addresses should be provided
Required

Responses

Status: 200 - OK

Status: 204 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


finsGeographicAddressById

Retrieves a 'GeographicAddress' By ID

This operation retrieves a geographic address entity using its unique ID.


/geographicAddress/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/geographicAddress/{id}?fields=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeographicAddressManagementApi;

import java.io.File;
import java.util.*;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String id = id_example; // String | Identifier of the Geographic Address
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicAddress result = apiInstance.finsGeographicAddressById(id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#finsGeographicAddressById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String id = id_example; // String | Identifier of the Geographic Address
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicAddress result = apiInstance.finsGeographicAddressById(id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#finsGeographicAddressById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the Geographic Address
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *relatedParty.id = relatedParty.id_example; // Id of a specific party role for which the addresses should be provided (optional)

GeographicAddressManagementApi *apiInstance = [[GeographicAddressManagementApi alloc] init];

// Retrieves a 'GeographicAddress' By ID
[apiInstance finsGeographicAddressByIdWith:id
    fields:fields
    relatedParty.id:relatedParty.id
              completionHandler: ^(GeographicAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.GeographicAddressManagementApi()
var id = id_example; // {{String}} Identifier of the Geographic Address
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'relatedParty.id': relatedParty.id_example // {{String}} Id of a specific party role for which the addresses should be provided
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.finsGeographicAddressById(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class finsGeographicAddressByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GeographicAddressManagementApi();
            var id = id_example;  // String | Identifier of the Geographic Address
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Id of a specific party role for which the addresses should be provided (optional) 

            try
            {
                // Retrieves a 'GeographicAddress' By ID
                GeographicAddress result = apiInstance.finsGeographicAddressById(id, fields, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.finsGeographicAddressById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGeographicAddressManagementApi();
$id = id_example; // String | Identifier of the Geographic Address
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->finsGeographicAddressById($id, $fields, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->finsGeographicAddressById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeographicAddressManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GeographicAddressManagementApi->new();
my $id = id_example; # String | Identifier of the Geographic Address
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $relatedParty.id = relatedParty.id_example; # String | Id of a specific party role for which the addresses should be provided

eval { 
    my $result = $api_instance->finsGeographicAddressById(id => $id, fields => $fields, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->finsGeographicAddressById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GeographicAddressManagementApi()
id = id_example # String | Identifier of the Geographic Address
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
relatedParty.id = relatedParty.id_example # String | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # Retrieves a 'GeographicAddress' By ID
    api_response = api_instance.fins_geographic_address_by_id(id, fields=fields, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->finsGeographicAddressById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Geographic Address
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body
relatedParty.id
String
Id of a specific party role for which the addresses should be provided

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 405 - Method Not Allowed List of supported error codes: - 61: Method not allowed

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error


listGeographicAddresses

Retrieves a list of 'GeographicAddress'

This operation retrieves a list of geographic address entities for the related party.


/geographicAddress

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/geographicAddress?baseSiteId=&fields=&limit=&offset=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeographicAddressManagementApi;

import java.io.File;
import java.util.*;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String limit = limit_example; // String | Requested number of resources to be provided in response requested by client
        String offset = offset_example; // String | Requested index for start of resources to be provided in response requested by client
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicAddress] result = apiInstance.listGeographicAddresses(baseSiteId, fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String limit = limit_example; // String | Requested number of resources to be provided in response requested by client
        String offset = offset_example; // String | Requested index for start of resources to be provided in response requested by client
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicAddress] result = apiInstance.listGeographicAddresses(baseSiteId, fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *limit = limit_example; // Requested number of resources to be provided in response requested by client (optional)
String *offset = offset_example; // Requested index for start of resources to be provided in response requested by client (optional)
String *relatedParty.id = relatedParty.id_example; // Id of a specific party role for which the addresses should be provided (optional)

GeographicAddressManagementApi *apiInstance = [[GeographicAddressManagementApi alloc] init];

// Retrieves a list of 'GeographicAddress'
[apiInstance listGeographicAddressesWith:baseSiteId
    fields:fields
    limit:limit
    offset:offset
    relatedParty.id:relatedParty.id
              completionHandler: ^(array[GeographicAddress] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.GeographicAddressManagementApi()
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'limit': limit_example, // {{String}} Requested number of resources to be provided in response requested by client
  'offset': offset_example, // {{String}} Requested index for start of resources to be provided in response requested by client
  'relatedParty.id': relatedParty.id_example // {{String}} Id of a specific party role for which the addresses should be provided
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGeographicAddresses(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listGeographicAddressesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GeographicAddressManagementApi();
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var limit = limit_example;  // String | Requested number of resources to be provided in response requested by client (optional) 
            var offset = offset_example;  // String | Requested index for start of resources to be provided in response requested by client (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Id of a specific party role for which the addresses should be provided (optional) 

            try
            {
                // Retrieves a list of 'GeographicAddress'
                array[GeographicAddress] result = apiInstance.listGeographicAddresses(baseSiteId, fields, limit, offset, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.listGeographicAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGeographicAddressManagementApi();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$limit = limit_example; // String | Requested number of resources to be provided in response requested by client
$offset = offset_example; // String | Requested index for start of resources to be provided in response requested by client
$relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->listGeographicAddresses($baseSiteId, $fields, $limit, $offset, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->listGeographicAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeographicAddressManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GeographicAddressManagementApi->new();
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $limit = limit_example; # String | Requested number of resources to be provided in response requested by client
my $offset = offset_example; # String | Requested index for start of resources to be provided in response requested by client
my $relatedParty.id = relatedParty.id_example; # String | Id of a specific party role for which the addresses should be provided

eval { 
    my $result = $api_instance->listGeographicAddresses(baseSiteId => $baseSiteId, fields => $fields, limit => $limit, offset => $offset, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->listGeographicAddresses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GeographicAddressManagementApi()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
limit = limit_example # String | Requested number of resources to be provided in response requested by client (optional)
offset = offset_example # String | Requested index for start of resources to be provided in response requested by client (optional)
relatedParty.id = relatedParty.id_example # String | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # Retrieves a list of 'GeographicAddress'
    api_response = api_instance.list_geographic_addresses(baseSiteId=baseSiteId, fields=fields, limit=limit, offset=offset, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->listGeographicAddresses: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Response configuration. This is the list of fields that should be returned in the response body
limit
String
Requested number of resources to be provided in response requested by client
offset
String
Requested index for start of resources to be provided in response requested by client
relatedParty.id
String
Id of a specific party role for which the addresses should be provided

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 405 - Method Not Allowed List of supported error codes: - 61: Method not allowed

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error


updateGeographicAddressById

Updates partially a 'GeographicAddress' by Id

This operation updates an existing geographic address entity for the related party using its unique ID.


/geographicAddress/{id}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/geographicAddress/{id}?relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GeographicAddressManagementApi;

import java.io.File;
import java.util.*;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        GeographicAddress body = ; // GeographicAddress | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        String id = id_example; // String | Identifier of the GeographicAddress
        try {
            GeographicAddress result = apiInstance.updateGeographicAddressById(body, relatedParty.id, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#updateGeographicAddressById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        GeographicAddress body = ; // GeographicAddress | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        String id = id_example; // String | Identifier of the GeographicAddress
        try {
            GeographicAddress result = apiInstance.updateGeographicAddressById(body, relatedParty.id, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#updateGeographicAddressById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
GeographicAddress *body = ; // 
String *relatedParty.id = relatedParty.id_example; // The id of the related party.
String *id = id_example; // Identifier of the GeographicAddress

GeographicAddressManagementApi *apiInstance = [[GeographicAddressManagementApi alloc] init];

// Updates partially a 'GeographicAddress' by Id
[apiInstance updateGeographicAddressByIdWith:body
    relatedParty.id:relatedParty.id
    id:id
              completionHandler: ^(GeographicAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.GeographicAddressManagementApi()
var body = ; // {{GeographicAddress}} 
var relatedParty.id = relatedParty.id_example; // {{String}} The id of the related party.
var id = id_example; // {{String}} Identifier of the GeographicAddress

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGeographicAddressById(bodyrelatedParty.idid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateGeographicAddressByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new GeographicAddressManagementApi();
            var body = new GeographicAddress(); // GeographicAddress | 
            var relatedParty.id = relatedParty.id_example;  // String | The id of the related party.
            var id = id_example;  // String | Identifier of the GeographicAddress

            try
            {
                // Updates partially a 'GeographicAddress' by Id
                GeographicAddress result = apiInstance.updateGeographicAddressById(body, relatedParty.id, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.updateGeographicAddressById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiGeographicAddressManagementApi();
$body = ; // GeographicAddress | 
$relatedParty.id = relatedParty.id_example; // String | The id of the related party.
$id = id_example; // String | Identifier of the GeographicAddress

try {
    $result = $api_instance->updateGeographicAddressById($body, $relatedParty.id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->updateGeographicAddressById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GeographicAddressManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::GeographicAddressManagementApi->new();
my $body = WWW::SwaggerClient::Object::GeographicAddress->new(); # GeographicAddress | 
my $relatedParty.id = relatedParty.id_example; # String | The id of the related party.
my $id = id_example; # String | Identifier of the GeographicAddress

eval { 
    my $result = $api_instance->updateGeographicAddressById(body => $body, relatedParty.id => $relatedParty.id, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->updateGeographicAddressById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.GeographicAddressManagementApi()
body =  # GeographicAddress | 
relatedParty.id = relatedParty.id_example # String | The id of the related party.
id = id_example # String | Identifier of the GeographicAddress

try: 
    # Updates partially a 'GeographicAddress' by Id
    api_response = api_instance.update_geographic_address_by_id(body, relatedParty.id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->updateGeographicAddressById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the GeographicAddress
Required
Body parameters
Name Description
body *
Query parameters
Name Description
relatedParty.id*
String
The id of the related party.
Required

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


PartyRoleManagement

retrievePartyRole

Retrieves a 'PartyRole' by Id


/partyRole/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/partyRole/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyRoleManagementApi;

import java.io.File;
import java.util.*;

public class PartyRoleManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PartyRoleManagementApi apiInstance = new PartyRoleManagementApi();
        String id = id_example; // String | Identifier of the Party Role
        String fields = fields_example; // String | Comma separated properties to display in response
        try {
            array[PartyRole] result = apiInstance.retrievePartyRole(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyRoleManagementApi#retrievePartyRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyRoleManagementApi;

public class PartyRoleManagementApiExample {

    public static void main(String[] args) {
        PartyRoleManagementApi apiInstance = new PartyRoleManagementApi();
        String id = id_example; // String | Identifier of the Party Role
        String fields = fields_example; // String | Comma separated properties to display in response
        try {
            array[PartyRole] result = apiInstance.retrievePartyRole(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyRoleManagementApi#retrievePartyRole");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the Party Role
String *fields = fields_example; // Comma separated properties to display in response (optional)

PartyRoleManagementApi *apiInstance = [[PartyRoleManagementApi alloc] init];

// Retrieves a 'PartyRole' by Id
[apiInstance retrievePartyRoleWith:id
    fields:fields
              completionHandler: ^(array[PartyRole] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.PartyRoleManagementApi()
var id = id_example; // {{String}} Identifier of the Party Role
var opts = { 
  'fields': fields_example // {{String}} Comma separated properties to display in response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrievePartyRole(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrievePartyRoleExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PartyRoleManagementApi();
            var id = id_example;  // String | Identifier of the Party Role
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 

            try
            {
                // Retrieves a 'PartyRole' by Id
                array[PartyRole] result = apiInstance.retrievePartyRole(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyRoleManagementApi.retrievePartyRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPartyRoleManagementApi();
$id = id_example; // String | Identifier of the Party Role
$fields = fields_example; // String | Comma separated properties to display in response

try {
    $result = $api_instance->retrievePartyRole($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartyRoleManagementApi->retrievePartyRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartyRoleManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PartyRoleManagementApi->new();
my $id = id_example; # String | Identifier of the Party Role
my $fields = fields_example; # String | Comma separated properties to display in response

eval { 
    my $result = $api_instance->retrievePartyRole(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartyRoleManagementApi->retrievePartyRole: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PartyRoleManagementApi()
id = id_example # String | Identifier of the Party Role
fields = fields_example # String | Comma separated properties to display in response (optional)

try: 
    # Retrieves a 'PartyRole' by Id
    api_response = api_instance.retrieve_party_role(id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyRoleManagementApi->retrievePartyRole: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Party Role
Required
Query parameters
Name Description
fields
String
Comma separated properties to display in response

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


PaymentMethods

createPaymentMethod

Creates a PaymentMethod

This operation creates a PaymentMethod entity.


/paymentMethod

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8,application/xml,application/json"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/paymentMethod"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentMethodsApi;

import java.io.File;
import java.util.*;

public class PaymentMethodsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentMethodsApi apiInstance = new PaymentMethodsApi();
        PaymentMethodType body = ; // PaymentMethodType | 
        try {
            PaymentMethodType result = apiInstance.createPaymentMethod(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentMethodsApi#createPaymentMethod");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentMethodsApi;

public class PaymentMethodsApiExample {

    public static void main(String[] args) {
        PaymentMethodsApi apiInstance = new PaymentMethodsApi();
        PaymentMethodType body = ; // PaymentMethodType | 
        try {
            PaymentMethodType result = apiInstance.createPaymentMethod(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentMethodsApi#createPaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PaymentMethodType *body = ; // 

PaymentMethodsApi *apiInstance = [[PaymentMethodsApi alloc] init];

// Creates a PaymentMethod
[apiInstance createPaymentMethodWith:body
              completionHandler: ^(PaymentMethodType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.PaymentMethodsApi()
var body = ; // {{PaymentMethodType}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPaymentMethod(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPaymentMethodExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentMethodsApi();
            var body = new PaymentMethodType(); // PaymentMethodType | 

            try
            {
                // Creates a PaymentMethod
                PaymentMethodType result = apiInstance.createPaymentMethod(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentMethodsApi.createPaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentMethodsApi();
$body = ; // PaymentMethodType | 

try {
    $result = $api_instance->createPaymentMethod($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentMethodsApi->createPaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentMethodsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentMethodsApi->new();
my $body = WWW::SwaggerClient::Object::PaymentMethodType->new(); # PaymentMethodType | 

eval { 
    my $result = $api_instance->createPaymentMethod(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentMethodsApi->createPaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentMethodsApi()
body =  # PaymentMethodType | 

try: 
    # Creates a PaymentMethod
    api_response = api_instance.create_payment_method(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodsApi->createPaymentMethod: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


retrievePaymentMethods

Retrieve a list of payment methods


/paymentMethod

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/paymentMethod?bankAccount.BIC=&bankAccount.accountNumber=&bankAccount.bank=&bankCard.cardNumber=&bankCard.nameOnCard=&bankCard.type=&baseSiteId=&bucket=&check.bank=&check.checkId=&digitalWallet.id=&digitalWallet.service=&fields=&limit=&loyaltyAccount=&offset=&relatedParty.id=&relatedParty.type=&type=&voucher.code=&voucher.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentMethodsApi;

import java.io.File;
import java.util.*;

public class PaymentMethodsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentMethodsApi apiInstance = new PaymentMethodsApi();
        String bankAccount.BIC = bankAccount.BIC_example; // String | To retrieve the accounts of a specific bank
        String bankAccount.accountNumber = bankAccount.accountNumber_example; // String | To retrieve a specific account
        String bankAccount.bank = bankAccount.bank_example; // String | To retrieve the accounts of a specific bank
        String bankCard.cardNumber = bankCard.cardNumber_example; // String | To retrieve a specific bank card
        String bankCard.nameOnCard = bankCard.nameOnCard_example; // String | To retrieve cards with a specific name
        String bankCard.type = bankCard.type_example; // String | To retrieve cards of a specific type
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String bucket = bucket_example; // String | To retrieve a specific bucket
        String check.bank = check.bank_example; // String | To retrieve checks of a specific bank
        String check.checkId = check.checkId_example; // String | To retrieve a specific check
        String digitalWallet.id = digitalWallet.id_example; // String | To retrieve a specific digital wallet
        String digitalWallet.service = digitalWallet.service_example; // String | To retrieve digital wallets of a specific service
        String fields = fields_example; // String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
        Integer limit = 56; // Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
        String loyaltyAccount = loyaltyAccount_example; // String | To retrieve a specific loyalty account
        Integer offset = 56; // Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
        String relatedParty.id = relatedParty.id_example; // String | To retrieve methods from a specific related party
        String relatedParty.type = relatedParty.type_example; // String | To retrieve methods from a specific related party
        String type = type_example; // String | To retrieve methods of a specific type
        String voucher.code = voucher.code_example; // String | To retrieve voucher with a specific code
        String voucher.id = voucher.id_example; // String | To retrieve a specific voucher
        try {
            array[PaymentMethodType] result = apiInstance.retrievePaymentMethods(bankAccount.BIC, bankAccount.accountNumber, bankAccount.bank, bankCard.cardNumber, bankCard.nameOnCard, bankCard.type, baseSiteId, bucket, check.bank, check.checkId, digitalWallet.id, digitalWallet.service, fields, limit, loyaltyAccount, offset, relatedParty.id, relatedParty.type, type, voucher.code, voucher.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentMethodsApi#retrievePaymentMethods");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentMethodsApi;

public class PaymentMethodsApiExample {

    public static void main(String[] args) {
        PaymentMethodsApi apiInstance = new PaymentMethodsApi();
        String bankAccount.BIC = bankAccount.BIC_example; // String | To retrieve the accounts of a specific bank
        String bankAccount.accountNumber = bankAccount.accountNumber_example; // String | To retrieve a specific account
        String bankAccount.bank = bankAccount.bank_example; // String | To retrieve the accounts of a specific bank
        String bankCard.cardNumber = bankCard.cardNumber_example; // String | To retrieve a specific bank card
        String bankCard.nameOnCard = bankCard.nameOnCard_example; // String | To retrieve cards with a specific name
        String bankCard.type = bankCard.type_example; // String | To retrieve cards of a specific type
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String bucket = bucket_example; // String | To retrieve a specific bucket
        String check.bank = check.bank_example; // String | To retrieve checks of a specific bank
        String check.checkId = check.checkId_example; // String | To retrieve a specific check
        String digitalWallet.id = digitalWallet.id_example; // String | To retrieve a specific digital wallet
        String digitalWallet.service = digitalWallet.service_example; // String | To retrieve digital wallets of a specific service
        String fields = fields_example; // String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
        Integer limit = 56; // Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
        String loyaltyAccount = loyaltyAccount_example; // String | To retrieve a specific loyalty account
        Integer offset = 56; // Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
        String relatedParty.id = relatedParty.id_example; // String | To retrieve methods from a specific related party
        String relatedParty.type = relatedParty.type_example; // String | To retrieve methods from a specific related party
        String type = type_example; // String | To retrieve methods of a specific type
        String voucher.code = voucher.code_example; // String | To retrieve voucher with a specific code
        String voucher.id = voucher.id_example; // String | To retrieve a specific voucher
        try {
            array[PaymentMethodType] result = apiInstance.retrievePaymentMethods(bankAccount.BIC, bankAccount.accountNumber, bankAccount.bank, bankCard.cardNumber, bankCard.nameOnCard, bankCard.type, baseSiteId, bucket, check.bank, check.checkId, digitalWallet.id, digitalWallet.service, fields, limit, loyaltyAccount, offset, relatedParty.id, relatedParty.type, type, voucher.code, voucher.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentMethodsApi#retrievePaymentMethods");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *bankAccount.BIC = bankAccount.BIC_example; // To retrieve the accounts of a specific bank (optional)
String *bankAccount.accountNumber = bankAccount.accountNumber_example; // To retrieve a specific account (optional)
String *bankAccount.bank = bankAccount.bank_example; // To retrieve the accounts of a specific bank (optional)
String *bankCard.cardNumber = bankCard.cardNumber_example; // To retrieve a specific bank card (optional)
String *bankCard.nameOnCard = bankCard.nameOnCard_example; // To retrieve cards with a specific name (optional)
String *bankCard.type = bankCard.type_example; // To retrieve cards of a specific type (optional)
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *bucket = bucket_example; // To retrieve a specific bucket (optional)
String *check.bank = check.bank_example; // To retrieve checks of a specific bank (optional)
String *check.checkId = check.checkId_example; // To retrieve a specific check (optional)
String *digitalWallet.id = digitalWallet.id_example; // To retrieve a specific digital wallet (optional)
String *digitalWallet.service = digitalWallet.service_example; // To retrieve digital wallets of a specific service (optional)
String *fields = fields_example; // To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested. (optional)
Integer *limit = 56; // To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response. (optional)
String *loyaltyAccount = loyaltyAccount_example; // To retrieve a specific loyalty account (optional)
Integer *offset = 56; // To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied. (optional)
String *relatedParty.id = relatedParty.id_example; // To retrieve methods from a specific related party (optional)
String *relatedParty.type = relatedParty.type_example; // To retrieve methods from a specific related party (optional)
String *type = type_example; // To retrieve methods of a specific type (optional)
String *voucher.code = voucher.code_example; // To retrieve voucher with a specific code (optional)
String *voucher.id = voucher.id_example; // To retrieve a specific voucher (optional)

PaymentMethodsApi *apiInstance = [[PaymentMethodsApi alloc] init];

// Retrieve a list of payment methods
[apiInstance retrievePaymentMethodsWith:bankAccount.BIC
    bankAccount.accountNumber:bankAccount.accountNumber
    bankAccount.bank:bankAccount.bank
    bankCard.cardNumber:bankCard.cardNumber
    bankCard.nameOnCard:bankCard.nameOnCard
    bankCard.type:bankCard.type
    baseSiteId:baseSiteId
    bucket:bucket
    check.bank:check.bank
    check.checkId:check.checkId
    digitalWallet.id:digitalWallet.id
    digitalWallet.service:digitalWallet.service
    fields:fields
    limit:limit
    loyaltyAccount:loyaltyAccount
    offset:offset
    relatedParty.id:relatedParty.id
    relatedParty.type:relatedParty.type
    type:type
    voucher.code:voucher.code
    voucher.id:voucher.id
              completionHandler: ^(array[PaymentMethodType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.PaymentMethodsApi()
var opts = { 
  'bankAccount.BIC': bankAccount.BIC_example, // {{String}} To retrieve the accounts of a specific bank
  'bankAccount.accountNumber': bankAccount.accountNumber_example, // {{String}} To retrieve a specific account
  'bankAccount.bank': bankAccount.bank_example, // {{String}} To retrieve the accounts of a specific bank
  'bankCard.cardNumber': bankCard.cardNumber_example, // {{String}} To retrieve a specific bank card
  'bankCard.nameOnCard': bankCard.nameOnCard_example, // {{String}} To retrieve cards with a specific name
  'bankCard.type': bankCard.type_example, // {{String}} To retrieve cards of a specific type
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'bucket': bucket_example, // {{String}} To retrieve a specific bucket
  'check.bank': check.bank_example, // {{String}} To retrieve checks of a specific bank
  'check.checkId': check.checkId_example, // {{String}} To retrieve a specific check
  'digitalWallet.id': digitalWallet.id_example, // {{String}} To retrieve a specific digital wallet
  'digitalWallet.service': digitalWallet.service_example, // {{String}} To retrieve digital wallets of a specific service
  'fields': fields_example, // {{String}} To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
  'limit': 56, // {{Integer}} To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
  'loyaltyAccount': loyaltyAccount_example, // {{String}} To retrieve a specific loyalty account
  'offset': 56, // {{Integer}} To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
  'relatedParty.id': relatedParty.id_example, // {{String}} To retrieve methods from a specific related party
  'relatedParty.type': relatedParty.type_example, // {{String}} To retrieve methods from a specific related party
  'type': type_example, // {{String}} To retrieve methods of a specific type
  'voucher.code': voucher.code_example, // {{String}} To retrieve voucher with a specific code
  'voucher.id': voucher.id_example // {{String}} To retrieve a specific voucher
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrievePaymentMethods(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrievePaymentMethodsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentMethodsApi();
            var bankAccount.BIC = bankAccount.BIC_example;  // String | To retrieve the accounts of a specific bank (optional) 
            var bankAccount.accountNumber = bankAccount.accountNumber_example;  // String | To retrieve a specific account (optional) 
            var bankAccount.bank = bankAccount.bank_example;  // String | To retrieve the accounts of a specific bank (optional) 
            var bankCard.cardNumber = bankCard.cardNumber_example;  // String | To retrieve a specific bank card (optional) 
            var bankCard.nameOnCard = bankCard.nameOnCard_example;  // String | To retrieve cards with a specific name (optional) 
            var bankCard.type = bankCard.type_example;  // String | To retrieve cards of a specific type (optional) 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var bucket = bucket_example;  // String | To retrieve a specific bucket (optional) 
            var check.bank = check.bank_example;  // String | To retrieve checks of a specific bank (optional) 
            var check.checkId = check.checkId_example;  // String | To retrieve a specific check (optional) 
            var digitalWallet.id = digitalWallet.id_example;  // String | To retrieve a specific digital wallet (optional) 
            var digitalWallet.service = digitalWallet.service_example;  // String | To retrieve digital wallets of a specific service (optional) 
            var fields = fields_example;  // String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested. (optional) 
            var limit = 56;  // Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response. (optional) 
            var loyaltyAccount = loyaltyAccount_example;  // String | To retrieve a specific loyalty account (optional) 
            var offset = 56;  // Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied. (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | To retrieve methods from a specific related party (optional) 
            var relatedParty.type = relatedParty.type_example;  // String | To retrieve methods from a specific related party (optional) 
            var type = type_example;  // String | To retrieve methods of a specific type (optional) 
            var voucher.code = voucher.code_example;  // String | To retrieve voucher with a specific code (optional) 
            var voucher.id = voucher.id_example;  // String | To retrieve a specific voucher (optional) 

            try
            {
                // Retrieve a list of payment methods
                array[PaymentMethodType] result = apiInstance.retrievePaymentMethods(bankAccount.BIC, bankAccount.accountNumber, bankAccount.bank, bankCard.cardNumber, bankCard.nameOnCard, bankCard.type, baseSiteId, bucket, check.bank, check.checkId, digitalWallet.id, digitalWallet.service, fields, limit, loyaltyAccount, offset, relatedParty.id, relatedParty.type, type, voucher.code, voucher.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentMethodsApi.retrievePaymentMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentMethodsApi();
$bankAccount.BIC = bankAccount.BIC_example; // String | To retrieve the accounts of a specific bank
$bankAccount.accountNumber = bankAccount.accountNumber_example; // String | To retrieve a specific account
$bankAccount.bank = bankAccount.bank_example; // String | To retrieve the accounts of a specific bank
$bankCard.cardNumber = bankCard.cardNumber_example; // String | To retrieve a specific bank card
$bankCard.nameOnCard = bankCard.nameOnCard_example; // String | To retrieve cards with a specific name
$bankCard.type = bankCard.type_example; // String | To retrieve cards of a specific type
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$bucket = bucket_example; // String | To retrieve a specific bucket
$check.bank = check.bank_example; // String | To retrieve checks of a specific bank
$check.checkId = check.checkId_example; // String | To retrieve a specific check
$digitalWallet.id = digitalWallet.id_example; // String | To retrieve a specific digital wallet
$digitalWallet.service = digitalWallet.service_example; // String | To retrieve digital wallets of a specific service
$fields = fields_example; // String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
$limit = 56; // Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
$loyaltyAccount = loyaltyAccount_example; // String | To retrieve a specific loyalty account
$offset = 56; // Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
$relatedParty.id = relatedParty.id_example; // String | To retrieve methods from a specific related party
$relatedParty.type = relatedParty.type_example; // String | To retrieve methods from a specific related party
$type = type_example; // String | To retrieve methods of a specific type
$voucher.code = voucher.code_example; // String | To retrieve voucher with a specific code
$voucher.id = voucher.id_example; // String | To retrieve a specific voucher

try {
    $result = $api_instance->retrievePaymentMethods($bankAccount.BIC, $bankAccount.accountNumber, $bankAccount.bank, $bankCard.cardNumber, $bankCard.nameOnCard, $bankCard.type, $baseSiteId, $bucket, $check.bank, $check.checkId, $digitalWallet.id, $digitalWallet.service, $fields, $limit, $loyaltyAccount, $offset, $relatedParty.id, $relatedParty.type, $type, $voucher.code, $voucher.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentMethodsApi->retrievePaymentMethods: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentMethodsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentMethodsApi->new();
my $bankAccount.BIC = bankAccount.BIC_example; # String | To retrieve the accounts of a specific bank
my $bankAccount.accountNumber = bankAccount.accountNumber_example; # String | To retrieve a specific account
my $bankAccount.bank = bankAccount.bank_example; # String | To retrieve the accounts of a specific bank
my $bankCard.cardNumber = bankCard.cardNumber_example; # String | To retrieve a specific bank card
my $bankCard.nameOnCard = bankCard.nameOnCard_example; # String | To retrieve cards with a specific name
my $bankCard.type = bankCard.type_example; # String | To retrieve cards of a specific type
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $bucket = bucket_example; # String | To retrieve a specific bucket
my $check.bank = check.bank_example; # String | To retrieve checks of a specific bank
my $check.checkId = check.checkId_example; # String | To retrieve a specific check
my $digitalWallet.id = digitalWallet.id_example; # String | To retrieve a specific digital wallet
my $digitalWallet.service = digitalWallet.service_example; # String | To retrieve digital wallets of a specific service
my $fields = fields_example; # String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
my $limit = 56; # Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
my $loyaltyAccount = loyaltyAccount_example; # String | To retrieve a specific loyalty account
my $offset = 56; # Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
my $relatedParty.id = relatedParty.id_example; # String | To retrieve methods from a specific related party
my $relatedParty.type = relatedParty.type_example; # String | To retrieve methods from a specific related party
my $type = type_example; # String | To retrieve methods of a specific type
my $voucher.code = voucher.code_example; # String | To retrieve voucher with a specific code
my $voucher.id = voucher.id_example; # String | To retrieve a specific voucher

eval { 
    my $result = $api_instance->retrievePaymentMethods(bankAccount.BIC => $bankAccount.BIC, bankAccount.accountNumber => $bankAccount.accountNumber, bankAccount.bank => $bankAccount.bank, bankCard.cardNumber => $bankCard.cardNumber, bankCard.nameOnCard => $bankCard.nameOnCard, bankCard.type => $bankCard.type, baseSiteId => $baseSiteId, bucket => $bucket, check.bank => $check.bank, check.checkId => $check.checkId, digitalWallet.id => $digitalWallet.id, digitalWallet.service => $digitalWallet.service, fields => $fields, limit => $limit, loyaltyAccount => $loyaltyAccount, offset => $offset, relatedParty.id => $relatedParty.id, relatedParty.type => $relatedParty.type, type => $type, voucher.code => $voucher.code, voucher.id => $voucher.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentMethodsApi->retrievePaymentMethods: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentMethodsApi()
bankAccount.BIC = bankAccount.BIC_example # String | To retrieve the accounts of a specific bank (optional)
bankAccount.accountNumber = bankAccount.accountNumber_example # String | To retrieve a specific account (optional)
bankAccount.bank = bankAccount.bank_example # String | To retrieve the accounts of a specific bank (optional)
bankCard.cardNumber = bankCard.cardNumber_example # String | To retrieve a specific bank card (optional)
bankCard.nameOnCard = bankCard.nameOnCard_example # String | To retrieve cards with a specific name (optional)
bankCard.type = bankCard.type_example # String | To retrieve cards of a specific type (optional)
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
bucket = bucket_example # String | To retrieve a specific bucket (optional)
check.bank = check.bank_example # String | To retrieve checks of a specific bank (optional)
check.checkId = check.checkId_example # String | To retrieve a specific check (optional)
digitalWallet.id = digitalWallet.id_example # String | To retrieve a specific digital wallet (optional)
digitalWallet.service = digitalWallet.service_example # String | To retrieve digital wallets of a specific service (optional)
fields = fields_example # String | To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested. (optional)
limit = 56 # Integer | To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response. (optional)
loyaltyAccount = loyaltyAccount_example # String | To retrieve a specific loyalty account (optional)
offset = 56 # Integer | To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied. (optional)
relatedParty.id = relatedParty.id_example # String | To retrieve methods from a specific related party (optional)
relatedParty.type = relatedParty.type_example # String | To retrieve methods from a specific related party (optional)
type = type_example # String | To retrieve methods of a specific type (optional)
voucher.code = voucher.code_example # String | To retrieve voucher with a specific code (optional)
voucher.id = voucher.id_example # String | To retrieve a specific voucher (optional)

try: 
    # Retrieve a list of payment methods
    api_response = api_instance.retrieve_payment_methods(bankAccount.BIC=bankAccount.BIC, bankAccount.accountNumber=bankAccount.accountNumber, bankAccount.bank=bankAccount.bank, bankCard.cardNumber=bankCard.cardNumber, bankCard.nameOnCard=bankCard.nameOnCard, bankCard.type=bankCard.type, baseSiteId=baseSiteId, bucket=bucket, check.bank=check.bank, check.checkId=check.checkId, digitalWallet.id=digitalWallet.id, digitalWallet.service=digitalWallet.service, fields=fields, limit=limit, loyaltyAccount=loyaltyAccount, offset=offset, relatedParty.id=relatedParty.id, relatedParty.type=relatedParty.type, type=type, voucher.code=voucher.code, voucher.id=voucher.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodsApi->retrievePaymentMethods: %s\n" % e)

Parameters

Query parameters
Name Description
bankAccount.BIC
String
To retrieve the accounts of a specific bank
bankAccount.accountNumber
String
To retrieve a specific account
bankAccount.bank
String
To retrieve the accounts of a specific bank
bankCard.cardNumber
String
To retrieve a specific bank card
bankCard.nameOnCard
String
To retrieve cards with a specific name
bankCard.type
String
To retrieve cards of a specific type
baseSiteId
String
Identifier of the BaseSite
bucket
String
To retrieve a specific bucket
check.bank
String
To retrieve checks of a specific bank
check.checkId
String
To retrieve a specific check
digitalWallet.id
String
To retrieve a specific digital wallet
digitalWallet.service
String
To retrieve digital wallets of a specific service
fields
String
To apply a filter on every resource included in the response. It's value is a list of comma separated values of the different fields that are requested.
limit
Integer (int32)
To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response.
loyaltyAccount
String
To retrieve a specific loyalty account
offset
Integer (int32)
To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied.
relatedParty.id
String
To retrieve methods from a specific related party
relatedParty.type
String
To retrieve methods from a specific related party
type
String
To retrieve methods of a specific type
voucher.code
String
To retrieve voucher with a specific code
voucher.id
String
To retrieve a specific voucher

Responses

Status: 200 - Payment methods retrieved successfully

Status: 204 - No Content

Status: 400 - Invalid Token

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method not Allowed

Status: 500 - Internal Server Error


ProcessTypeManagement

listProcessType

Returns the list of available process types


/processTypeManagement/processType

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/processTypeManagement/processType?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessTypeManagementApi;

import java.io.File;
import java.util.*;

public class ProcessTypeManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProcessTypeManagementApi apiInstance = new ProcessTypeManagementApi();
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[ProcessType] result = apiInstance.listProcessType(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessTypeManagementApi#listProcessType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessTypeManagementApi;

public class ProcessTypeManagementApiExample {

    public static void main(String[] args) {
        ProcessTypeManagementApi apiInstance = new ProcessTypeManagementApi();
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[ProcessType] result = apiInstance.listProcessType(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessTypeManagementApi#listProcessType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)

ProcessTypeManagementApi *apiInstance = [[ProcessTypeManagementApi alloc] init];

// Returns the list of available process types
[apiInstance listProcessTypeWith:fields
              completionHandler: ^(array[ProcessType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProcessTypeManagementApi()
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProcessType(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProcessTypeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessTypeManagementApi();
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 

            try
            {
                // Returns the list of available process types
                array[ProcessType] result = apiInstance.listProcessType(fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessTypeManagementApi.listProcessType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProcessTypeManagementApi();
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body

try {
    $result = $api_instance->listProcessType($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessTypeManagementApi->listProcessType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessTypeManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProcessTypeManagementApi->new();
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body

eval { 
    my $result = $api_instance->listProcessType(fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProcessTypeManagementApi->listProcessType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProcessTypeManagementApi()
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)

try: 
    # Returns the list of available process types
    api_response = api_instance.list_process_type(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessTypeManagementApi->listProcessType: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


listQualifiedProcessType

Returns the list of available process types for a given customer


/processTypeManagement/qualifiedProcessType

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/processTypeManagement/qualifiedProcessType?fields=&relatedParty.Id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessTypeManagementApi;

import java.io.File;
import java.util.*;

public class ProcessTypeManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProcessTypeManagementApi apiInstance = new ProcessTypeManagementApi();
        String relatedParty.Id = relatedParty.Id_example; // String | The id of the customer for which we request the qualifiedProcessType
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[QualifiedProcessType] result = apiInstance.listQualifiedProcessType(relatedParty.Id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessTypeManagementApi#listQualifiedProcessType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessTypeManagementApi;

public class ProcessTypeManagementApiExample {

    public static void main(String[] args) {
        ProcessTypeManagementApi apiInstance = new ProcessTypeManagementApi();
        String relatedParty.Id = relatedParty.Id_example; // String | The id of the customer for which we request the qualifiedProcessType
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[QualifiedProcessType] result = apiInstance.listQualifiedProcessType(relatedParty.Id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessTypeManagementApi#listQualifiedProcessType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *relatedParty.Id = relatedParty.Id_example; // The id of the customer for which we request the qualifiedProcessType
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)

ProcessTypeManagementApi *apiInstance = [[ProcessTypeManagementApi alloc] init];

// Returns the list of available process types for a given customer
[apiInstance listQualifiedProcessTypeWith:relatedParty.Id
    fields:fields
              completionHandler: ^(array[QualifiedProcessType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProcessTypeManagementApi()
var relatedParty.Id = relatedParty.Id_example; // {{String}} The id of the customer for which we request the qualifiedProcessType
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listQualifiedProcessType(relatedParty.Id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listQualifiedProcessTypeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessTypeManagementApi();
            var relatedParty.Id = relatedParty.Id_example;  // String | The id of the customer for which we request the qualifiedProcessType
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 

            try
            {
                // Returns the list of available process types for a given customer
                array[QualifiedProcessType] result = apiInstance.listQualifiedProcessType(relatedParty.Id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessTypeManagementApi.listQualifiedProcessType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProcessTypeManagementApi();
$relatedParty.Id = relatedParty.Id_example; // String | The id of the customer for which we request the qualifiedProcessType
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body

try {
    $result = $api_instance->listQualifiedProcessType($relatedParty.Id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessTypeManagementApi->listQualifiedProcessType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessTypeManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProcessTypeManagementApi->new();
my $relatedParty.Id = relatedParty.Id_example; # String | The id of the customer for which we request the qualifiedProcessType
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body

eval { 
    my $result = $api_instance->listQualifiedProcessType(relatedParty.Id => $relatedParty.Id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProcessTypeManagementApi->listQualifiedProcessType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProcessTypeManagementApi()
relatedParty.Id = relatedParty.Id_example # String | The id of the customer for which we request the qualifiedProcessType
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)

try: 
    # Returns the list of available process types for a given customer
    api_response = api_instance.list_qualified_process_type(relatedParty.Id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessTypeManagementApi->listQualifiedProcessType: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body
relatedParty.Id*
String
The id of the customer for which we request the qualifiedProcessType
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


Product

productGet

Retrieve product

This operation retrieves a product entity. Attribute selection is enabled for all first level attributes. Filtering on sub-resources may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity


/product/{productId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/product/{productId}?baseSiteId=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductApi;

import java.io.File;
import java.util.*;

public class ProductApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductApi apiInstance = new ProductApi();
        String productId = productId_example; // String | Identifier of the Product 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. BASIC/FULL/DEFAULT
        try {
            Object result = apiInstance.productGet(productId, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductApi#productGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductApi;

public class ProductApiExample {

    public static void main(String[] args) {
        ProductApi apiInstance = new ProductApi();
        String productId = productId_example; // String | Identifier of the Product 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. BASIC/FULL/DEFAULT
        try {
            Object result = apiInstance.productGet(productId, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductApi#productGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *productId = productId_example; // Identifier of the Product 
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Response configuration. BASIC/FULL/DEFAULT (optional)

ProductApi *apiInstance = [[ProductApi alloc] init];

// Retrieve product
[apiInstance productGetWith:productId
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductApi()
var productId = productId_example; // {{String}} Identifier of the Product 
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example // {{String}} Response configuration. BASIC/FULL/DEFAULT
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.productGet(productId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class productGetExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductApi();
            var productId = productId_example;  // String | Identifier of the Product 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Response configuration. BASIC/FULL/DEFAULT (optional) 

            try
            {
                // Retrieve product
                Object result = apiInstance.productGet(productId, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductApi.productGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductApi();
$productId = productId_example; // String | Identifier of the Product 
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Response configuration. BASIC/FULL/DEFAULT

try {
    $result = $api_instance->productGet($productId, $baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductApi->productGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductApi->new();
my $productId = productId_example; # String | Identifier of the Product 
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Response configuration. BASIC/FULL/DEFAULT

eval { 
    my $result = $api_instance->productGet(productId => $productId, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductApi->productGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductApi()
productId = productId_example # String | Identifier of the Product 
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Response configuration. BASIC/FULL/DEFAULT (optional)

try: 
    # Retrieve product
    api_response = api_instance.product_get(productId, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductApi->productGet: %s\n" % e)

Parameters

Path parameters
Name Description
productId*
String
Identifier of the Product
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Response configuration. BASIC/FULL/DEFAULT

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 405 - Method Not Allowed List of supported error codes: - 61: Method not allowed

Status: 409 - Conflict The request could not be completed due to a conflict with the current state of the target resource.

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error


ProductCatalogManagement

listCatalog

List or find 'Catalog' objects


/catalog

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/json;charset=utf-8,application/xml,application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/catalog?@baseType=&@schemaLocation=&@type=&baseStore.id=&fields=&lastUpdate=&lifecycleStatus=&name=&validFor.endDateTime=&validFor.startDateTime=&version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCatalogManagementApi;

import java.io.File;
import java.util.*;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String @baseType = @baseType_example; // String | For filtering: Indicates the base (class) type of this REST resource
        String @schemaLocation = @schemaLocation_example; // String | For filtering: This field provides a link to the schema describing this REST resource
        String @type = @type_example; // String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
        String baseStore.id = baseStore.id_example; // String | Identifier of the BaseStore
        String fields = fields_example; // String | Comma separated properties to display in response
        Date lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        String name = name_example; // String | For filtering: Name of the catalog
        Date validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
        Date validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
        String version = version_example; // String | For filtering: Catalog version
        try {
            array[Catalog] result = apiInstance.listCatalog(@baseType, @schemaLocation, @type, baseStore.id, fields, lastUpdate, lifecycleStatus, name, validFor.endDateTime, validFor.startDateTime, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String @baseType = @baseType_example; // String | For filtering: Indicates the base (class) type of this REST resource
        String @schemaLocation = @schemaLocation_example; // String | For filtering: This field provides a link to the schema describing this REST resource
        String @type = @type_example; // String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
        String baseStore.id = baseStore.id_example; // String | Identifier of the BaseStore
        String fields = fields_example; // String | Comma separated properties to display in response
        Date lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        String name = name_example; // String | For filtering: Name of the catalog
        Date validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
        Date validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
        String version = version_example; // String | For filtering: Catalog version
        try {
            array[Catalog] result = apiInstance.listCatalog(@baseType, @schemaLocation, @type, baseStore.id, fields, lastUpdate, lifecycleStatus, name, validFor.endDateTime, validFor.startDateTime, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listCatalog");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *@baseType = @baseType_example; // For filtering: Indicates the base (class) type of this REST resource (optional)
String *@schemaLocation = @schemaLocation_example; // For filtering: This field provides a link to the schema describing this REST resource (optional)
String *@type = @type_example; // For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. (optional)
String *baseStore.id = baseStore.id_example; // Identifier of the BaseStore (optional)
String *fields = fields_example; // Comma separated properties to display in response (optional)
Date *lastUpdate = 2013-10-20T19:20:30+01:00; // For filtering: Date and time of the last update (optional)
String *lifecycleStatus = lifecycleStatus_example; // For filtering: Used to indicate the current lifecycle status (optional)
String *name = name_example; // For filtering: Name of the catalog (optional)
Date *validFor.endDateTime = 2013-10-20T19:20:30+01:00; // For filtering: An instant of time, ending at the TimePeriod. (optional)
Date *validFor.startDateTime = 2013-10-20T19:20:30+01:00; // For filtering: An instant of time, starting at the TimePeriod (optional)
String *version = version_example; // For filtering: Catalog version (optional)

ProductCatalogManagementApi *apiInstance = [[ProductCatalogManagementApi alloc] init];

// List or find 'Catalog' objects
[apiInstance listCatalogWith:@baseType
    @schemaLocation:@schemaLocation
    @type:@type
    baseStore.id:baseStore.id
    fields:fields
    lastUpdate:lastUpdate
    lifecycleStatus:lifecycleStatus
    name:name
    validFor.endDateTime:validFor.endDateTime
    validFor.startDateTime:validFor.startDateTime
    version:version
              completionHandler: ^(array[Catalog] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductCatalogManagementApi()
var opts = { 
  '@baseType': @baseType_example, // {{String}} For filtering: Indicates the base (class) type of this REST resource
  '@schemaLocation': @schemaLocation_example, // {{String}} For filtering: This field provides a link to the schema describing this REST resource
  '@type': @type_example, // {{String}} For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
  'baseStore.id': baseStore.id_example, // {{String}} Identifier of the BaseStore
  'fields': fields_example, // {{String}} Comma separated properties to display in response
  'lastUpdate': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: Date and time of the last update
  'lifecycleStatus': lifecycleStatus_example, // {{String}} For filtering: Used to indicate the current lifecycle status
  'name': name_example, // {{String}} For filtering: Name of the catalog
  'validFor.endDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: An instant of time, ending at the TimePeriod.
  'validFor.startDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: An instant of time, starting at the TimePeriod
  'version': version_example // {{String}} For filtering: Catalog version
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCatalog(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCatalogExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductCatalogManagementApi();
            var @baseType = @baseType_example;  // String | For filtering: Indicates the base (class) type of this REST resource (optional) 
            var @schemaLocation = @schemaLocation_example;  // String | For filtering: This field provides a link to the schema describing this REST resource (optional) 
            var @type = @type_example;  // String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. (optional) 
            var baseStore.id = baseStore.id_example;  // String | Identifier of the BaseStore (optional) 
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 
            var lastUpdate = 2013-10-20T19:20:30+01:00;  // Date | For filtering: Date and time of the last update (optional) 
            var lifecycleStatus = lifecycleStatus_example;  // String | For filtering: Used to indicate the current lifecycle status (optional) 
            var name = name_example;  // String | For filtering: Name of the catalog (optional) 
            var validFor.endDateTime = 2013-10-20T19:20:30+01:00;  // Date | For filtering: An instant of time, ending at the TimePeriod. (optional) 
            var validFor.startDateTime = 2013-10-20T19:20:30+01:00;  // Date | For filtering: An instant of time, starting at the TimePeriod (optional) 
            var version = version_example;  // String | For filtering: Catalog version (optional) 

            try
            {
                // List or find 'Catalog' objects
                array[Catalog] result = apiInstance.listCatalog(@baseType, @schemaLocation, @type, baseStore.id, fields, lastUpdate, lifecycleStatus, name, validFor.endDateTime, validFor.startDateTime, version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.listCatalog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductCatalogManagementApi();
$@baseType = @baseType_example; // String | For filtering: Indicates the base (class) type of this REST resource
$@schemaLocation = @schemaLocation_example; // String | For filtering: This field provides a link to the schema describing this REST resource
$@type = @type_example; // String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
$baseStore.id = baseStore.id_example; // String | Identifier of the BaseStore
$fields = fields_example; // String | Comma separated properties to display in response
$lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
$lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
$name = name_example; // String | For filtering: Name of the catalog
$validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
$validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
$version = version_example; // String | For filtering: Catalog version

try {
    $result = $api_instance->listCatalog($@baseType, $@schemaLocation, $@type, $baseStore.id, $fields, $lastUpdate, $lifecycleStatus, $name, $validFor.endDateTime, $validFor.startDateTime, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->listCatalog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductCatalogManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductCatalogManagementApi->new();
my $@baseType = @baseType_example; # String | For filtering: Indicates the base (class) type of this REST resource
my $@schemaLocation = @schemaLocation_example; # String | For filtering: This field provides a link to the schema describing this REST resource
my $@type = @type_example; # String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
my $baseStore.id = baseStore.id_example; # String | Identifier of the BaseStore
my $fields = fields_example; # String | Comma separated properties to display in response
my $lastUpdate = 2013-10-20T19:20:30+01:00; # Date | For filtering: Date and time of the last update
my $lifecycleStatus = lifecycleStatus_example; # String | For filtering: Used to indicate the current lifecycle status
my $name = name_example; # String | For filtering: Name of the catalog
my $validFor.endDateTime = 2013-10-20T19:20:30+01:00; # Date | For filtering: An instant of time, ending at the TimePeriod.
my $validFor.startDateTime = 2013-10-20T19:20:30+01:00; # Date | For filtering: An instant of time, starting at the TimePeriod
my $version = version_example; # String | For filtering: Catalog version

eval { 
    my $result = $api_instance->listCatalog(@baseType => $@baseType, @schemaLocation => $@schemaLocation, @type => $@type, baseStore.id => $baseStore.id, fields => $fields, lastUpdate => $lastUpdate, lifecycleStatus => $lifecycleStatus, name => $name, validFor.endDateTime => $validFor.endDateTime, validFor.startDateTime => $validFor.startDateTime, version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->listCatalog: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductCatalogManagementApi()
@baseType = @baseType_example # String | For filtering: Indicates the base (class) type of this REST resource (optional)
@schemaLocation = @schemaLocation_example # String | For filtering: This field provides a link to the schema describing this REST resource (optional)
@type = @type_example # String | For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. (optional)
baseStore.id = baseStore.id_example # String | Identifier of the BaseStore (optional)
fields = fields_example # String | Comma separated properties to display in response (optional)
lastUpdate = 2013-10-20T19:20:30+01:00 # Date | For filtering: Date and time of the last update (optional)
lifecycleStatus = lifecycleStatus_example # String | For filtering: Used to indicate the current lifecycle status (optional)
name = name_example # String | For filtering: Name of the catalog (optional)
validFor.endDateTime = 2013-10-20T19:20:30+01:00 # Date | For filtering: An instant of time, ending at the TimePeriod. (optional)
validFor.startDateTime = 2013-10-20T19:20:30+01:00 # Date | For filtering: An instant of time, starting at the TimePeriod (optional)
version = version_example # String | For filtering: Catalog version (optional)

try: 
    # List or find 'Catalog' objects
    api_response = api_instance.list_catalog(@baseType=@baseType, @schemaLocation=@schemaLocation, @type=@type, baseStore.id=baseStore.id, fields=fields, lastUpdate=lastUpdate, lifecycleStatus=lifecycleStatus, name=name, validFor.endDateTime=validFor.endDateTime, validFor.startDateTime=validFor.startDateTime, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->listCatalog: %s\n" % e)

Parameters

Query parameters
Name Description
@baseType
String
For filtering: Indicates<b> </b>the base (class) type of this REST resource
@schemaLocation
String
For filtering: This field provides a link to the schema describing this REST resource
@type
String
For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
baseStore.id
String
Identifier of the BaseStore
fields
String
Comma separated properties to display in response
lastUpdate
Date (date-time)
For filtering: Date and time of the last update
lifecycleStatus
String
For filtering: Used to indicate the current lifecycle status
name
String
For filtering: Name of the catalog
validFor.endDateTime
Date (date-time)
For filtering: An instant of time, ending at the TimePeriod.
validFor.startDateTime
Date (date-time)
For filtering: An instant of time, starting at the TimePeriod
version
String
For filtering: Catalog version

Responses

Status: 200 - Ok

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


listProductOffering

Retrieves a list of 'ProductOffering'


/productOffering

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/xml,application/json,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOffering?@baseType=&@schemaLocation=&@type=&agreement.@referredType=&agreement.name=&attachment.@baseType=&attachment.@schemaLocation=&attachment.@type=&attachment.mimeType=&attachment.type=&attachment.url=&baseSiteId=&bundledProductOffering.lifecycleStatus=&bundledProductOffering.name=&category.@referredType=&category.name=&category.version=&channel.@referredType=&channel.name=&facetSearchOption.id=&fields=&isBundle=&lastUpdate=&lifecycleStatus=&limit=&marketSegment.@referredType=&marketSegment.name=&name=&offeringGroup.id=&offset=&parentBundledProductOffering.id=&place.@referredType=&place.address=&place.name=&place.role=&prodSpecCharValueUse.maxCardinality=&prodSpecCharValueUse.minCardinality=&prodSpecCharValueUse.name=&prodSpecCharValueUse.valueType=&productOfferingPrice.@baseType=&productOfferingPrice.@schemaLocation=&productOfferingPrice.@type=&productOfferingPrice.isBundle=&productOfferingPrice.name=&productOfferingPrice.place.id=&productOfferingPrice.priceType=&productOfferingPrice.recurringChargePeriod=&productOfferingPrice.relatedParty.id=&productOfferingPrice.unitOfMeasure=&productOfferingPrice.version=&productOfferingTerm.@schemaLocation=&productOfferingTerm.@type=&productOfferingTerm.name=&productSpecification.@referredType=&productSpecification.name=&productSpecification.version=&resourceCandidate.@referredType=&resourceCandidate.name=&resourceCandidate.version=&serviceCandidate.@referredType=&serviceCandidate.name=&serviceCandidate.version=&serviceLevelAgreement.@referredType=&serviceLevelAgreement.name=&sort=&validFor.endDateTime=&validFor.startDateTime=&version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCatalogManagementApi;

import java.io.File;
import java.util.*;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String @baseType = @baseType_example; // String | For filtering: Immediate base (class) type of the product offering
        String @schemaLocation = @schemaLocation_example; // String | For filtering: A link to the schema describing this product offering
        String @type = @type_example; // String | For filtering: Class type of the product offering
        String agreement.@referredType = agreement.@referredType_example; // String | For filtering: class type of the referred Agreement
        String agreement.name = agreement.name_example; // String | For filtering: Name of the agreement
        String attachment.@baseType = attachment.@baseType_example; // String | For filtering: The immediate base class type of the attachment
        String attachment.@schemaLocation = attachment.@schemaLocation_example; // String | For filtering: A link to the schema describing this attachment entity
        String attachment.@type = attachment.@type_example; // String | For filtering: the class type of the Attachment
        String attachment.mimeType = attachment.mimeType_example; // String | For filtering: Attachment mime type such as extension file for video, picture and document
        String attachment.type = attachment.type_example; // String | For filtering: Attachment type such as video, picture
        String attachment.url = attachment.url_example; // String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        String bundledProductOffering.name = bundledProductOffering.name_example; // String | For filtering: Name of the BundledProductOffering
        String category.@referredType = category.@referredType_example; // String | For filtering: the class type of the referred Category
        String category.name = category.name_example; // String | For filtering: Name of the category
        String category.version = category.version_example; // String | For filtering: Category version
        String channel.@referredType = channel.@referredType_example; // String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
        String channel.name = channel.name_example; // String | For filtering: Name of the channel
        array[String] facetSearchOption.id = ; // array[String] | For filtering by facet options. The identifier of the facet search option.
        String fields = fields_example; // String | Comma separated properties to display in response
        Boolean isBundle = true; // Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
        Date lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
        String marketSegment.@referredType = marketSegment.@referredType_example; // String | For filtering: (Class) type of the referred market segment
        String marketSegment.name = marketSegment.name_example; // String | For filtering: Name of the market segment
        String name = name_example; // String | For filtering: Name of the productOffering
        String offeringGroup.id = offeringGroup.id_example; // String | For filtering: Id of the productOfferingGroup
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.
        String parentBundledProductOffering.id = parentBundledProductOffering.id_example; // String | For filtering: Id of the parentBundledProductOffering
        String place.@referredType = place.@referredType_example; // String | For filtering: class type of the referred Place object
        String place.address = place.address_example; // String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
        String place.name = place.name_example; // String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
        String place.role = place.role_example; // String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
        Integer prodSpecCharValueUse.maxCardinality = 56; // Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
        Integer prodSpecCharValueUse.minCardinality = 56; // Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
        String prodSpecCharValueUse.name = prodSpecCharValueUse.name_example; // String | For filtering: Name of the associated productSpecCharacteristic
        String prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example; // String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
        String productOfferingPrice.@baseType = productOfferingPrice.@baseType_example; // String | For filtering: the immediate base class of product offering price
        String productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example; // String | For filtering: hyperlink reference to the product offering price schema
        String productOfferingPrice.@type = productOfferingPrice.@type_example; // String | For filtering: The class type of the product offering price
        Boolean productOfferingPrice.isBundle = true; // Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not
        String productOfferingPrice.name = productOfferingPrice.name_example; // String | For filtering: Name of the productOfferingPrice
        String productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | For filtering: Identifier of the place for which product offering has prices available
        String productOfferingPrice.priceType = productOfferingPrice.priceType_example; // String | For filtering: Indicates the price type: recurring, one time, usage
        String productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example; // String | For filtering: Could be month, week...
        String productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        String productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example; // String | For filtering: Could be minutes, GB...
        String productOfferingPrice.version = productOfferingPrice.version_example; // String | For filtering: ProductOffering version
        String productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example; // String | For filtering: A link to the schema describing this product offering term
        String productOfferingTerm.@type = productOfferingTerm.@type_example; // String | For filtering: The class type of ProductOfferingTerm
        String productOfferingTerm.name = productOfferingTerm.name_example; // String | For filtering: Name of the productOfferingTerm
        String productSpecification.@referredType = productSpecification.@referredType_example; // String | For filtering: class type of referred Product Specification
        String productSpecification.name = productSpecification.name_example; // String | For filtering: Name of the product specification
        String productSpecification.version = productSpecification.version_example; // String | For filtering: Version of the product specification
        String resourceCandidate.@referredType = resourceCandidate.@referredType_example; // String | For filtering: The Class type of referred Resource Candidate
        String resourceCandidate.name = resourceCandidate.name_example; // String | For filtering: Name of the resource candidate
        String resourceCandidate.version = resourceCandidate.version_example; // String | For filtering: Version of the resource candidate
        String serviceCandidate.@referredType = serviceCandidate.@referredType_example; // String | For filtering: The Class type of  referred Service Candidate
        String serviceCandidate.name = serviceCandidate.name_example; // String | For filtering: Name of the service candidate
        String serviceCandidate.version = serviceCandidate.version_example; // String | For filtering: Version of the service candidate
        String serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example; // String | For filtering: class type of referred Service Level Agreement
        String serviceLevelAgreement.name = serviceLevelAgreement.name_example; // String | For filtering: Name of the service level agreement
        array[String] sort = ; // array[String] | For sorting: The options the product offerings can be sorted by.
        Date validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
        Date validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
        String version = version_example; // String | For filtering: ProductOffering version
        try {
            array[ProductOffering] result = apiInstance.listProductOffering(@baseType, @schemaLocation, @type, agreement.@referredType, agreement.name, attachment.@baseType, attachment.@schemaLocation, attachment.@type, attachment.mimeType, attachment.type, attachment.url, baseSiteId, bundledProductOffering.lifecycleStatus, bundledProductOffering.name, category.@referredType, category.name, category.version, channel.@referredType, channel.name, facetSearchOption.id, fields, isBundle, lastUpdate, lifecycleStatus, limit, marketSegment.@referredType, marketSegment.name, name, offeringGroup.id, offset, parentBundledProductOffering.id, place.@referredType, place.address, place.name, place.role, prodSpecCharValueUse.maxCardinality, prodSpecCharValueUse.minCardinality, prodSpecCharValueUse.name, prodSpecCharValueUse.valueType, productOfferingPrice.@baseType, productOfferingPrice.@schemaLocation, productOfferingPrice.@type, productOfferingPrice.isBundle, productOfferingPrice.name, productOfferingPrice.place.id, productOfferingPrice.priceType, productOfferingPrice.recurringChargePeriod, productOfferingPrice.relatedParty.id, productOfferingPrice.unitOfMeasure, productOfferingPrice.version, productOfferingTerm.@schemaLocation, productOfferingTerm.@type, productOfferingTerm.name, productSpecification.@referredType, productSpecification.name, productSpecification.version, resourceCandidate.@referredType, resourceCandidate.name, resourceCandidate.version, serviceCandidate.@referredType, serviceCandidate.name, serviceCandidate.version, serviceLevelAgreement.@referredType, serviceLevelAgreement.name, sort, validFor.endDateTime, validFor.startDateTime, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String @baseType = @baseType_example; // String | For filtering: Immediate base (class) type of the product offering
        String @schemaLocation = @schemaLocation_example; // String | For filtering: A link to the schema describing this product offering
        String @type = @type_example; // String | For filtering: Class type of the product offering
        String agreement.@referredType = agreement.@referredType_example; // String | For filtering: class type of the referred Agreement
        String agreement.name = agreement.name_example; // String | For filtering: Name of the agreement
        String attachment.@baseType = attachment.@baseType_example; // String | For filtering: The immediate base class type of the attachment
        String attachment.@schemaLocation = attachment.@schemaLocation_example; // String | For filtering: A link to the schema describing this attachment entity
        String attachment.@type = attachment.@type_example; // String | For filtering: the class type of the Attachment
        String attachment.mimeType = attachment.mimeType_example; // String | For filtering: Attachment mime type such as extension file for video, picture and document
        String attachment.type = attachment.type_example; // String | For filtering: Attachment type such as video, picture
        String attachment.url = attachment.url_example; // String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        String bundledProductOffering.name = bundledProductOffering.name_example; // String | For filtering: Name of the BundledProductOffering
        String category.@referredType = category.@referredType_example; // String | For filtering: the class type of the referred Category
        String category.name = category.name_example; // String | For filtering: Name of the category
        String category.version = category.version_example; // String | For filtering: Category version
        String channel.@referredType = channel.@referredType_example; // String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
        String channel.name = channel.name_example; // String | For filtering: Name of the channel
        array[String] facetSearchOption.id = ; // array[String] | For filtering by facet options. The identifier of the facet search option.
        String fields = fields_example; // String | Comma separated properties to display in response
        Boolean isBundle = true; // Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
        Date lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
        String marketSegment.@referredType = marketSegment.@referredType_example; // String | For filtering: (Class) type of the referred market segment
        String marketSegment.name = marketSegment.name_example; // String | For filtering: Name of the market segment
        String name = name_example; // String | For filtering: Name of the productOffering
        String offeringGroup.id = offeringGroup.id_example; // String | For filtering: Id of the productOfferingGroup
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.
        String parentBundledProductOffering.id = parentBundledProductOffering.id_example; // String | For filtering: Id of the parentBundledProductOffering
        String place.@referredType = place.@referredType_example; // String | For filtering: class type of the referred Place object
        String place.address = place.address_example; // String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
        String place.name = place.name_example; // String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
        String place.role = place.role_example; // String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
        Integer prodSpecCharValueUse.maxCardinality = 56; // Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
        Integer prodSpecCharValueUse.minCardinality = 56; // Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
        String prodSpecCharValueUse.name = prodSpecCharValueUse.name_example; // String | For filtering: Name of the associated productSpecCharacteristic
        String prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example; // String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
        String productOfferingPrice.@baseType = productOfferingPrice.@baseType_example; // String | For filtering: the immediate base class of product offering price
        String productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example; // String | For filtering: hyperlink reference to the product offering price schema
        String productOfferingPrice.@type = productOfferingPrice.@type_example; // String | For filtering: The class type of the product offering price
        Boolean productOfferingPrice.isBundle = true; // Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not
        String productOfferingPrice.name = productOfferingPrice.name_example; // String | For filtering: Name of the productOfferingPrice
        String productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | For filtering: Identifier of the place for which product offering has prices available
        String productOfferingPrice.priceType = productOfferingPrice.priceType_example; // String | For filtering: Indicates the price type: recurring, one time, usage
        String productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example; // String | For filtering: Could be month, week...
        String productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        String productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example; // String | For filtering: Could be minutes, GB...
        String productOfferingPrice.version = productOfferingPrice.version_example; // String | For filtering: ProductOffering version
        String productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example; // String | For filtering: A link to the schema describing this product offering term
        String productOfferingTerm.@type = productOfferingTerm.@type_example; // String | For filtering: The class type of ProductOfferingTerm
        String productOfferingTerm.name = productOfferingTerm.name_example; // String | For filtering: Name of the productOfferingTerm
        String productSpecification.@referredType = productSpecification.@referredType_example; // String | For filtering: class type of referred Product Specification
        String productSpecification.name = productSpecification.name_example; // String | For filtering: Name of the product specification
        String productSpecification.version = productSpecification.version_example; // String | For filtering: Version of the product specification
        String resourceCandidate.@referredType = resourceCandidate.@referredType_example; // String | For filtering: The Class type of referred Resource Candidate
        String resourceCandidate.name = resourceCandidate.name_example; // String | For filtering: Name of the resource candidate
        String resourceCandidate.version = resourceCandidate.version_example; // String | For filtering: Version of the resource candidate
        String serviceCandidate.@referredType = serviceCandidate.@referredType_example; // String | For filtering: The Class type of  referred Service Candidate
        String serviceCandidate.name = serviceCandidate.name_example; // String | For filtering: Name of the service candidate
        String serviceCandidate.version = serviceCandidate.version_example; // String | For filtering: Version of the service candidate
        String serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example; // String | For filtering: class type of referred Service Level Agreement
        String serviceLevelAgreement.name = serviceLevelAgreement.name_example; // String | For filtering: Name of the service level agreement
        array[String] sort = ; // array[String] | For sorting: The options the product offerings can be sorted by.
        Date validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
        Date validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
        String version = version_example; // String | For filtering: ProductOffering version
        try {
            array[ProductOffering] result = apiInstance.listProductOffering(@baseType, @schemaLocation, @type, agreement.@referredType, agreement.name, attachment.@baseType, attachment.@schemaLocation, attachment.@type, attachment.mimeType, attachment.type, attachment.url, baseSiteId, bundledProductOffering.lifecycleStatus, bundledProductOffering.name, category.@referredType, category.name, category.version, channel.@referredType, channel.name, facetSearchOption.id, fields, isBundle, lastUpdate, lifecycleStatus, limit, marketSegment.@referredType, marketSegment.name, name, offeringGroup.id, offset, parentBundledProductOffering.id, place.@referredType, place.address, place.name, place.role, prodSpecCharValueUse.maxCardinality, prodSpecCharValueUse.minCardinality, prodSpecCharValueUse.name, prodSpecCharValueUse.valueType, productOfferingPrice.@baseType, productOfferingPrice.@schemaLocation, productOfferingPrice.@type, productOfferingPrice.isBundle, productOfferingPrice.name, productOfferingPrice.place.id, productOfferingPrice.priceType, productOfferingPrice.recurringChargePeriod, productOfferingPrice.relatedParty.id, productOfferingPrice.unitOfMeasure, productOfferingPrice.version, productOfferingTerm.@schemaLocation, productOfferingTerm.@type, productOfferingTerm.name, productSpecification.@referredType, productSpecification.name, productSpecification.version, resourceCandidate.@referredType, resourceCandidate.name, resourceCandidate.version, serviceCandidate.@referredType, serviceCandidate.name, serviceCandidate.version, serviceLevelAgreement.@referredType, serviceLevelAgreement.name, sort, validFor.endDateTime, validFor.startDateTime, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductOffering");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *@baseType = @baseType_example; // For filtering: Immediate base (class) type of the product offering (optional)
String *@schemaLocation = @schemaLocation_example; // For filtering: A link to the schema describing this product offering (optional)
String *@type = @type_example; // For filtering: Class type of the product offering (optional)
String *agreement.@referredType = agreement.@referredType_example; // For filtering: class type of the referred Agreement (optional)
String *agreement.name = agreement.name_example; // For filtering: Name of the agreement (optional)
String *attachment.@baseType = attachment.@baseType_example; // For filtering: The immediate base class type of the attachment (optional)
String *attachment.@schemaLocation = attachment.@schemaLocation_example; // For filtering: A link to the schema describing this attachment entity (optional)
String *attachment.@type = attachment.@type_example; // For filtering: the class type of the Attachment (optional)
String *attachment.mimeType = attachment.mimeType_example; // For filtering: Attachment mime type such as extension file for video, picture and document (optional)
String *attachment.type = attachment.type_example; // For filtering: Attachment type such as video, picture (optional)
String *attachment.url = attachment.url_example; // For filtering: Uniform Resource Locator, is a web page address (a subset of URI) (optional)
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example; // For filtering: Used to indicate the current lifecycle status (optional)
String *bundledProductOffering.name = bundledProductOffering.name_example; // For filtering: Name of the BundledProductOffering (optional)
String *category.@referredType = category.@referredType_example; // For filtering: the class type of the referred Category (optional)
String *category.name = category.name_example; // For filtering: Name of the category (optional)
String *category.version = category.version_example; // For filtering: Category version (optional)
String *channel.@referredType = channel.@referredType_example; // For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on (optional)
String *channel.name = channel.name_example; // For filtering: Name of the channel (optional)
array[String] *facetSearchOption.id = ; // For filtering by facet options. The identifier of the facet search option. (optional)
String *fields = fields_example; // Comma separated properties to display in response (optional)
Boolean *isBundle = true; // For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true). (optional)
Date *lastUpdate = 2013-10-20T19:20:30+01:00; // For filtering: Date and time of the last update (optional)
String *lifecycleStatus = lifecycleStatus_example; // For filtering: Used to indicate the current lifecycle status (optional)
Integer *limit = 56; // Requested number of resources to be provided in response requested by client. (optional)
String *marketSegment.@referredType = marketSegment.@referredType_example; // For filtering: (Class) type of the referred market segment (optional)
String *marketSegment.name = marketSegment.name_example; // For filtering: Name of the market segment (optional)
String *name = name_example; // For filtering: Name of the productOffering (optional)
String *offeringGroup.id = offeringGroup.id_example; // For filtering: Id of the productOfferingGroup (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response requested by client. (optional)
String *parentBundledProductOffering.id = parentBundledProductOffering.id_example; // For filtering: Id of the parentBundledProductOffering (optional)
String *place.@referredType = place.@referredType_example; // For filtering: class type of the referred Place object (optional)
String *place.address = place.address_example; // For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API). (optional)
String *place.name = place.name_example; // For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home" (optional)
String *place.role = place.role_example; // For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval') (optional)
Integer *prodSpecCharValueUse.maxCardinality = 56; // For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. (optional)
Integer *prodSpecCharValueUse.minCardinality = 56; // For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. (optional)
String *prodSpecCharValueUse.name = prodSpecCharValueUse.name_example; // For filtering: Name of the associated productSpecCharacteristic (optional)
String *prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example; // For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth (optional)
String *productOfferingPrice.@baseType = productOfferingPrice.@baseType_example; // For filtering: the immediate base class of product offering price (optional)
String *productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example; // For filtering: hyperlink reference to the product offering price schema (optional)
String *productOfferingPrice.@type = productOfferingPrice.@type_example; // For filtering: The class type of the product offering price (optional)
Boolean *productOfferingPrice.isBundle = true; // For filtering: a flag indicating if this product offering price is bundle (composite) or not (optional)
String *productOfferingPrice.name = productOfferingPrice.name_example; // For filtering: Name of the productOfferingPrice (optional)
String *productOfferingPrice.place.id = productOfferingPrice.place.id_example; // For filtering: Identifier of the place for which product offering has prices available (optional)
String *productOfferingPrice.priceType = productOfferingPrice.priceType_example; // For filtering: Indicates the price type: recurring, one time, usage (optional)
String *productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example; // For filtering: Could be month, week... (optional)
String *productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // For filtering: Identifier of the related party for which the price applies. (optional)
String *productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example; // For filtering: Could be minutes, GB... (optional)
String *productOfferingPrice.version = productOfferingPrice.version_example; // For filtering: ProductOffering version (optional)
String *productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example; // For filtering: A link to the schema describing this product offering term (optional)
String *productOfferingTerm.@type = productOfferingTerm.@type_example; // For filtering: The class type of ProductOfferingTerm (optional)
String *productOfferingTerm.name = productOfferingTerm.name_example; // For filtering: Name of the productOfferingTerm (optional)
String *productSpecification.@referredType = productSpecification.@referredType_example; // For filtering: class type of referred Product Specification (optional)
String *productSpecification.name = productSpecification.name_example; // For filtering: Name of the product specification (optional)
String *productSpecification.version = productSpecification.version_example; // For filtering: Version of the product specification (optional)
String *resourceCandidate.@referredType = resourceCandidate.@referredType_example; // For filtering: The Class type of referred Resource Candidate (optional)
String *resourceCandidate.name = resourceCandidate.name_example; // For filtering: Name of the resource candidate (optional)
String *resourceCandidate.version = resourceCandidate.version_example; // For filtering: Version of the resource candidate (optional)
String *serviceCandidate.@referredType = serviceCandidate.@referredType_example; // For filtering: The Class type of  referred Service Candidate (optional)
String *serviceCandidate.name = serviceCandidate.name_example; // For filtering: Name of the service candidate (optional)
String *serviceCandidate.version = serviceCandidate.version_example; // For filtering: Version of the service candidate (optional)
String *serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example; // For filtering: class type of referred Service Level Agreement (optional)
String *serviceLevelAgreement.name = serviceLevelAgreement.name_example; // For filtering: Name of the service level agreement (optional)
array[String] *sort = ; // For sorting: The options the product offerings can be sorted by. (optional)
Date *validFor.endDateTime = 2013-10-20T19:20:30+01:00; // For filtering: An instant of time, ending at the TimePeriod. (optional)
Date *validFor.startDateTime = 2013-10-20T19:20:30+01:00; // For filtering: An instant of time, starting at the TimePeriod (optional)
String *version = version_example; // For filtering: ProductOffering version (optional)

ProductCatalogManagementApi *apiInstance = [[ProductCatalogManagementApi alloc] init];

// Retrieves a list of 'ProductOffering'
[apiInstance listProductOfferingWith:@baseType
    @schemaLocation:@schemaLocation
    @type:@type
    agreement.@referredType:agreement.@referredType
    agreement.name:agreement.name
    attachment.@baseType:attachment.@baseType
    attachment.@schemaLocation:attachment.@schemaLocation
    attachment.@type:attachment.@type
    attachment.mimeType:attachment.mimeType
    attachment.type:attachment.type
    attachment.url:attachment.url
    baseSiteId:baseSiteId
    bundledProductOffering.lifecycleStatus:bundledProductOffering.lifecycleStatus
    bundledProductOffering.name:bundledProductOffering.name
    category.@referredType:category.@referredType
    category.name:category.name
    category.version:category.version
    channel.@referredType:channel.@referredType
    channel.name:channel.name
    facetSearchOption.id:facetSearchOption.id
    fields:fields
    isBundle:isBundle
    lastUpdate:lastUpdate
    lifecycleStatus:lifecycleStatus
    limit:limit
    marketSegment.@referredType:marketSegment.@referredType
    marketSegment.name:marketSegment.name
    name:name
    offeringGroup.id:offeringGroup.id
    offset:offset
    parentBundledProductOffering.id:parentBundledProductOffering.id
    place.@referredType:place.@referredType
    place.address:place.address
    place.name:place.name
    place.role:place.role
    prodSpecCharValueUse.maxCardinality:prodSpecCharValueUse.maxCardinality
    prodSpecCharValueUse.minCardinality:prodSpecCharValueUse.minCardinality
    prodSpecCharValueUse.name:prodSpecCharValueUse.name
    prodSpecCharValueUse.valueType:prodSpecCharValueUse.valueType
    productOfferingPrice.@baseType:productOfferingPrice.@baseType
    productOfferingPrice.@schemaLocation:productOfferingPrice.@schemaLocation
    productOfferingPrice.@type:productOfferingPrice.@type
    productOfferingPrice.isBundle:productOfferingPrice.isBundle
    productOfferingPrice.name:productOfferingPrice.name
    productOfferingPrice.place.id:productOfferingPrice.place.id
    productOfferingPrice.priceType:productOfferingPrice.priceType
    productOfferingPrice.recurringChargePeriod:productOfferingPrice.recurringChargePeriod
    productOfferingPrice.relatedParty.id:productOfferingPrice.relatedParty.id
    productOfferingPrice.unitOfMeasure:productOfferingPrice.unitOfMeasure
    productOfferingPrice.version:productOfferingPrice.version
    productOfferingTerm.@schemaLocation:productOfferingTerm.@schemaLocation
    productOfferingTerm.@type:productOfferingTerm.@type
    productOfferingTerm.name:productOfferingTerm.name
    productSpecification.@referredType:productSpecification.@referredType
    productSpecification.name:productSpecification.name
    productSpecification.version:productSpecification.version
    resourceCandidate.@referredType:resourceCandidate.@referredType
    resourceCandidate.name:resourceCandidate.name
    resourceCandidate.version:resourceCandidate.version
    serviceCandidate.@referredType:serviceCandidate.@referredType
    serviceCandidate.name:serviceCandidate.name
    serviceCandidate.version:serviceCandidate.version
    serviceLevelAgreement.@referredType:serviceLevelAgreement.@referredType
    serviceLevelAgreement.name:serviceLevelAgreement.name
    sort:sort
    validFor.endDateTime:validFor.endDateTime
    validFor.startDateTime:validFor.startDateTime
    version:version
              completionHandler: ^(array[ProductOffering] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductCatalogManagementApi()
var opts = { 
  '@baseType': @baseType_example, // {{String}} For filtering: Immediate base (class) type of the product offering
  '@schemaLocation': @schemaLocation_example, // {{String}} For filtering: A link to the schema describing this product offering
  '@type': @type_example, // {{String}} For filtering: Class type of the product offering
  'agreement.@referredType': agreement.@referredType_example, // {{String}} For filtering: class type of the referred Agreement
  'agreement.name': agreement.name_example, // {{String}} For filtering: Name of the agreement
  'attachment.@baseType': attachment.@baseType_example, // {{String}} For filtering: The immediate base class type of the attachment
  'attachment.@schemaLocation': attachment.@schemaLocation_example, // {{String}} For filtering: A link to the schema describing this attachment entity
  'attachment.@type': attachment.@type_example, // {{String}} For filtering: the class type of the Attachment
  'attachment.mimeType': attachment.mimeType_example, // {{String}} For filtering: Attachment mime type such as extension file for video, picture and document
  'attachment.type': attachment.type_example, // {{String}} For filtering: Attachment type such as video, picture
  'attachment.url': attachment.url_example, // {{String}} For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'bundledProductOffering.lifecycleStatus': bundledProductOffering.lifecycleStatus_example, // {{String}} For filtering: Used to indicate the current lifecycle status
  'bundledProductOffering.name': bundledProductOffering.name_example, // {{String}} For filtering: Name of the BundledProductOffering
  'category.@referredType': category.@referredType_example, // {{String}} For filtering: the class type of the referred Category
  'category.name': category.name_example, // {{String}} For filtering: Name of the category
  'category.version': category.version_example, // {{String}} For filtering: Category version
  'channel.@referredType': channel.@referredType_example, // {{String}} For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
  'channel.name': channel.name_example, // {{String}} For filtering: Name of the channel
  'facetSearchOption.id': , // {{array[String]}} For filtering by facet options. The identifier of the facet search option.
  'fields': fields_example, // {{String}} Comma separated properties to display in response
  'isBundle': true, // {{Boolean}} For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
  'lastUpdate': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: Date and time of the last update
  'lifecycleStatus': lifecycleStatus_example, // {{String}} For filtering: Used to indicate the current lifecycle status
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response requested by client.
  'marketSegment.@referredType': marketSegment.@referredType_example, // {{String}} For filtering: (Class) type of the referred market segment
  'marketSegment.name': marketSegment.name_example, // {{String}} For filtering: Name of the market segment
  'name': name_example, // {{String}} For filtering: Name of the productOffering
  'offeringGroup.id': offeringGroup.id_example, // {{String}} For filtering: Id of the productOfferingGroup
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response requested by client.
  'parentBundledProductOffering.id': parentBundledProductOffering.id_example, // {{String}} For filtering: Id of the parentBundledProductOffering
  'place.@referredType': place.@referredType_example, // {{String}} For filtering: class type of the referred Place object
  'place.address': place.address_example, // {{String}} For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
  'place.name': place.name_example, // {{String}} For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
  'place.role': place.role_example, // {{String}} For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
  'prodSpecCharValueUse.maxCardinality': 56, // {{Integer}} For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
  'prodSpecCharValueUse.minCardinality': 56, // {{Integer}} For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
  'prodSpecCharValueUse.name': prodSpecCharValueUse.name_example, // {{String}} For filtering: Name of the associated productSpecCharacteristic
  'prodSpecCharValueUse.valueType': prodSpecCharValueUse.valueType_example, // {{String}} For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
  'productOfferingPrice.@baseType': productOfferingPrice.@baseType_example, // {{String}} For filtering: the immediate base class of product offering price
  'productOfferingPrice.@schemaLocation': productOfferingPrice.@schemaLocation_example, // {{String}} For filtering: hyperlink reference to the product offering price schema
  'productOfferingPrice.@type': productOfferingPrice.@type_example, // {{String}} For filtering: The class type of the product offering price
  'productOfferingPrice.isBundle': true, // {{Boolean}} For filtering: a flag indicating if this product offering price is bundle (composite) or not
  'productOfferingPrice.name': productOfferingPrice.name_example, // {{String}} For filtering: Name of the productOfferingPrice
  'productOfferingPrice.place.id': productOfferingPrice.place.id_example, // {{String}} For filtering: Identifier of the place for which product offering has prices available
  'productOfferingPrice.priceType': productOfferingPrice.priceType_example, // {{String}} For filtering: Indicates the price type: recurring, one time, usage
  'productOfferingPrice.recurringChargePeriod': productOfferingPrice.recurringChargePeriod_example, // {{String}} For filtering: Could be month, week...
  'productOfferingPrice.relatedParty.id': productOfferingPrice.relatedParty.id_example, // {{String}} For filtering: Identifier of the related party for which the price applies.
  'productOfferingPrice.unitOfMeasure': productOfferingPrice.unitOfMeasure_example, // {{String}} For filtering: Could be minutes, GB...
  'productOfferingPrice.version': productOfferingPrice.version_example, // {{String}} For filtering: ProductOffering version
  'productOfferingTerm.@schemaLocation': productOfferingTerm.@schemaLocation_example, // {{String}} For filtering: A link to the schema describing this product offering term
  'productOfferingTerm.@type': productOfferingTerm.@type_example, // {{String}} For filtering: The class type of ProductOfferingTerm
  'productOfferingTerm.name': productOfferingTerm.name_example, // {{String}} For filtering: Name of the productOfferingTerm
  'productSpecification.@referredType': productSpecification.@referredType_example, // {{String}} For filtering: class type of referred Product Specification
  'productSpecification.name': productSpecification.name_example, // {{String}} For filtering: Name of the product specification
  'productSpecification.version': productSpecification.version_example, // {{String}} For filtering: Version of the product specification
  'resourceCandidate.@referredType': resourceCandidate.@referredType_example, // {{String}} For filtering: The Class type of referred Resource Candidate
  'resourceCandidate.name': resourceCandidate.name_example, // {{String}} For filtering: Name of the resource candidate
  'resourceCandidate.version': resourceCandidate.version_example, // {{String}} For filtering: Version of the resource candidate
  'serviceCandidate.@referredType': serviceCandidate.@referredType_example, // {{String}} For filtering: The Class type of  referred Service Candidate
  'serviceCandidate.name': serviceCandidate.name_example, // {{String}} For filtering: Name of the service candidate
  'serviceCandidate.version': serviceCandidate.version_example, // {{String}} For filtering: Version of the service candidate
  'serviceLevelAgreement.@referredType': serviceLevelAgreement.@referredType_example, // {{String}} For filtering: class type of referred Service Level Agreement
  'serviceLevelAgreement.name': serviceLevelAgreement.name_example, // {{String}} For filtering: Name of the service level agreement
  'sort': , // {{array[String]}} For sorting: The options the product offerings can be sorted by.
  'validFor.endDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: An instant of time, ending at the TimePeriod.
  'validFor.startDateTime': 2013-10-20T19:20:30+01:00, // {{Date}} For filtering: An instant of time, starting at the TimePeriod
  'version': version_example // {{String}} For filtering: ProductOffering version
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProductOffering(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductOfferingExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductCatalogManagementApi();
            var @baseType = @baseType_example;  // String | For filtering: Immediate base (class) type of the product offering (optional) 
            var @schemaLocation = @schemaLocation_example;  // String | For filtering: A link to the schema describing this product offering (optional) 
            var @type = @type_example;  // String | For filtering: Class type of the product offering (optional) 
            var agreement.@referredType = agreement.@referredType_example;  // String | For filtering: class type of the referred Agreement (optional) 
            var agreement.name = agreement.name_example;  // String | For filtering: Name of the agreement (optional) 
            var attachment.@baseType = attachment.@baseType_example;  // String | For filtering: The immediate base class type of the attachment (optional) 
            var attachment.@schemaLocation = attachment.@schemaLocation_example;  // String | For filtering: A link to the schema describing this attachment entity (optional) 
            var attachment.@type = attachment.@type_example;  // String | For filtering: the class type of the Attachment (optional) 
            var attachment.mimeType = attachment.mimeType_example;  // String | For filtering: Attachment mime type such as extension file for video, picture and document (optional) 
            var attachment.type = attachment.type_example;  // String | For filtering: Attachment type such as video, picture (optional) 
            var attachment.url = attachment.url_example;  // String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI) (optional) 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example;  // String | For filtering: Used to indicate the current lifecycle status (optional) 
            var bundledProductOffering.name = bundledProductOffering.name_example;  // String | For filtering: Name of the BundledProductOffering (optional) 
            var category.@referredType = category.@referredType_example;  // String | For filtering: the class type of the referred Category (optional) 
            var category.name = category.name_example;  // String | For filtering: Name of the category (optional) 
            var category.version = category.version_example;  // String | For filtering: Category version (optional) 
            var channel.@referredType = channel.@referredType_example;  // String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on (optional) 
            var channel.name = channel.name_example;  // String | For filtering: Name of the channel (optional) 
            var facetSearchOption.id = new array[String](); // array[String] | For filtering by facet options. The identifier of the facet search option. (optional) 
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 
            var isBundle = true;  // Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true). (optional) 
            var lastUpdate = 2013-10-20T19:20:30+01:00;  // Date | For filtering: Date and time of the last update (optional) 
            var lifecycleStatus = lifecycleStatus_example;  // String | For filtering: Used to indicate the current lifecycle status (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response requested by client. (optional) 
            var marketSegment.@referredType = marketSegment.@referredType_example;  // String | For filtering: (Class) type of the referred market segment (optional) 
            var marketSegment.name = marketSegment.name_example;  // String | For filtering: Name of the market segment (optional) 
            var name = name_example;  // String | For filtering: Name of the productOffering (optional) 
            var offeringGroup.id = offeringGroup.id_example;  // String | For filtering: Id of the productOfferingGroup (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response requested by client. (optional) 
            var parentBundledProductOffering.id = parentBundledProductOffering.id_example;  // String | For filtering: Id of the parentBundledProductOffering (optional) 
            var place.@referredType = place.@referredType_example;  // String | For filtering: class type of the referred Place object (optional) 
            var place.address = place.address_example;  // String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API). (optional) 
            var place.name = place.name_example;  // String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home" (optional) 
            var place.role = place.role_example;  // String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval') (optional) 
            var prodSpecCharValueUse.maxCardinality = 56;  // Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. (optional) 
            var prodSpecCharValueUse.minCardinality = 56;  // Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. (optional) 
            var prodSpecCharValueUse.name = prodSpecCharValueUse.name_example;  // String | For filtering: Name of the associated productSpecCharacteristic (optional) 
            var prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example;  // String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth (optional) 
            var productOfferingPrice.@baseType = productOfferingPrice.@baseType_example;  // String | For filtering: the immediate base class of product offering price (optional) 
            var productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example;  // String | For filtering: hyperlink reference to the product offering price schema (optional) 
            var productOfferingPrice.@type = productOfferingPrice.@type_example;  // String | For filtering: The class type of the product offering price (optional) 
            var productOfferingPrice.isBundle = true;  // Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not (optional) 
            var productOfferingPrice.name = productOfferingPrice.name_example;  // String | For filtering: Name of the productOfferingPrice (optional) 
            var productOfferingPrice.place.id = productOfferingPrice.place.id_example;  // String | For filtering: Identifier of the place for which product offering has prices available (optional) 
            var productOfferingPrice.priceType = productOfferingPrice.priceType_example;  // String | For filtering: Indicates the price type: recurring, one time, usage (optional) 
            var productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example;  // String | For filtering: Could be month, week... (optional) 
            var productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example;  // String | For filtering: Identifier of the related party for which the price applies. (optional) 
            var productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example;  // String | For filtering: Could be minutes, GB... (optional) 
            var productOfferingPrice.version = productOfferingPrice.version_example;  // String | For filtering: ProductOffering version (optional) 
            var productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example;  // String | For filtering: A link to the schema describing this product offering term (optional) 
            var productOfferingTerm.@type = productOfferingTerm.@type_example;  // String | For filtering: The class type of ProductOfferingTerm (optional) 
            var productOfferingTerm.name = productOfferingTerm.name_example;  // String | For filtering: Name of the productOfferingTerm (optional) 
            var productSpecification.@referredType = productSpecification.@referredType_example;  // String | For filtering: class type of referred Product Specification (optional) 
            var productSpecification.name = productSpecification.name_example;  // String | For filtering: Name of the product specification (optional) 
            var productSpecification.version = productSpecification.version_example;  // String | For filtering: Version of the product specification (optional) 
            var resourceCandidate.@referredType = resourceCandidate.@referredType_example;  // String | For filtering: The Class type of referred Resource Candidate (optional) 
            var resourceCandidate.name = resourceCandidate.name_example;  // String | For filtering: Name of the resource candidate (optional) 
            var resourceCandidate.version = resourceCandidate.version_example;  // String | For filtering: Version of the resource candidate (optional) 
            var serviceCandidate.@referredType = serviceCandidate.@referredType_example;  // String | For filtering: The Class type of  referred Service Candidate (optional) 
            var serviceCandidate.name = serviceCandidate.name_example;  // String | For filtering: Name of the service candidate (optional) 
            var serviceCandidate.version = serviceCandidate.version_example;  // String | For filtering: Version of the service candidate (optional) 
            var serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example;  // String | For filtering: class type of referred Service Level Agreement (optional) 
            var serviceLevelAgreement.name = serviceLevelAgreement.name_example;  // String | For filtering: Name of the service level agreement (optional) 
            var sort = new array[String](); // array[String] | For sorting: The options the product offerings can be sorted by. (optional) 
            var validFor.endDateTime = 2013-10-20T19:20:30+01:00;  // Date | For filtering: An instant of time, ending at the TimePeriod. (optional) 
            var validFor.startDateTime = 2013-10-20T19:20:30+01:00;  // Date | For filtering: An instant of time, starting at the TimePeriod (optional) 
            var version = version_example;  // String | For filtering: ProductOffering version (optional) 

            try
            {
                // Retrieves a list of 'ProductOffering'
                array[ProductOffering] result = apiInstance.listProductOffering(@baseType, @schemaLocation, @type, agreement.@referredType, agreement.name, attachment.@baseType, attachment.@schemaLocation, attachment.@type, attachment.mimeType, attachment.type, attachment.url, baseSiteId, bundledProductOffering.lifecycleStatus, bundledProductOffering.name, category.@referredType, category.name, category.version, channel.@referredType, channel.name, facetSearchOption.id, fields, isBundle, lastUpdate, lifecycleStatus, limit, marketSegment.@referredType, marketSegment.name, name, offeringGroup.id, offset, parentBundledProductOffering.id, place.@referredType, place.address, place.name, place.role, prodSpecCharValueUse.maxCardinality, prodSpecCharValueUse.minCardinality, prodSpecCharValueUse.name, prodSpecCharValueUse.valueType, productOfferingPrice.@baseType, productOfferingPrice.@schemaLocation, productOfferingPrice.@type, productOfferingPrice.isBundle, productOfferingPrice.name, productOfferingPrice.place.id, productOfferingPrice.priceType, productOfferingPrice.recurringChargePeriod, productOfferingPrice.relatedParty.id, productOfferingPrice.unitOfMeasure, productOfferingPrice.version, productOfferingTerm.@schemaLocation, productOfferingTerm.@type, productOfferingTerm.name, productSpecification.@referredType, productSpecification.name, productSpecification.version, resourceCandidate.@referredType, resourceCandidate.name, resourceCandidate.version, serviceCandidate.@referredType, serviceCandidate.name, serviceCandidate.version, serviceLevelAgreement.@referredType, serviceLevelAgreement.name, sort, validFor.endDateTime, validFor.startDateTime, version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.listProductOffering: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductCatalogManagementApi();
$@baseType = @baseType_example; // String | For filtering: Immediate base (class) type of the product offering
$@schemaLocation = @schemaLocation_example; // String | For filtering: A link to the schema describing this product offering
$@type = @type_example; // String | For filtering: Class type of the product offering
$agreement.@referredType = agreement.@referredType_example; // String | For filtering: class type of the referred Agreement
$agreement.name = agreement.name_example; // String | For filtering: Name of the agreement
$attachment.@baseType = attachment.@baseType_example; // String | For filtering: The immediate base class type of the attachment
$attachment.@schemaLocation = attachment.@schemaLocation_example; // String | For filtering: A link to the schema describing this attachment entity
$attachment.@type = attachment.@type_example; // String | For filtering: the class type of the Attachment
$attachment.mimeType = attachment.mimeType_example; // String | For filtering: Attachment mime type such as extension file for video, picture and document
$attachment.type = attachment.type_example; // String | For filtering: Attachment type such as video, picture
$attachment.url = attachment.url_example; // String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
$bundledProductOffering.name = bundledProductOffering.name_example; // String | For filtering: Name of the BundledProductOffering
$category.@referredType = category.@referredType_example; // String | For filtering: the class type of the referred Category
$category.name = category.name_example; // String | For filtering: Name of the category
$category.version = category.version_example; // String | For filtering: Category version
$channel.@referredType = channel.@referredType_example; // String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
$channel.name = channel.name_example; // String | For filtering: Name of the channel
$facetSearchOption.id = ; // array[String] | For filtering by facet options. The identifier of the facet search option.
$fields = fields_example; // String | Comma separated properties to display in response
$isBundle = true; // Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
$lastUpdate = 2013-10-20T19:20:30+01:00; // Date | For filtering: Date and time of the last update
$lifecycleStatus = lifecycleStatus_example; // String | For filtering: Used to indicate the current lifecycle status
$limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
$marketSegment.@referredType = marketSegment.@referredType_example; // String | For filtering: (Class) type of the referred market segment
$marketSegment.name = marketSegment.name_example; // String | For filtering: Name of the market segment
$name = name_example; // String | For filtering: Name of the productOffering
$offeringGroup.id = offeringGroup.id_example; // String | For filtering: Id of the productOfferingGroup
$offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.
$parentBundledProductOffering.id = parentBundledProductOffering.id_example; // String | For filtering: Id of the parentBundledProductOffering
$place.@referredType = place.@referredType_example; // String | For filtering: class type of the referred Place object
$place.address = place.address_example; // String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
$place.name = place.name_example; // String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
$place.role = place.role_example; // String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
$prodSpecCharValueUse.maxCardinality = 56; // Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
$prodSpecCharValueUse.minCardinality = 56; // Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
$prodSpecCharValueUse.name = prodSpecCharValueUse.name_example; // String | For filtering: Name of the associated productSpecCharacteristic
$prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example; // String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
$productOfferingPrice.@baseType = productOfferingPrice.@baseType_example; // String | For filtering: the immediate base class of product offering price
$productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example; // String | For filtering: hyperlink reference to the product offering price schema
$productOfferingPrice.@type = productOfferingPrice.@type_example; // String | For filtering: The class type of the product offering price
$productOfferingPrice.isBundle = true; // Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not
$productOfferingPrice.name = productOfferingPrice.name_example; // String | For filtering: Name of the productOfferingPrice
$productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | For filtering: Identifier of the place for which product offering has prices available
$productOfferingPrice.priceType = productOfferingPrice.priceType_example; // String | For filtering: Indicates the price type: recurring, one time, usage
$productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example; // String | For filtering: Could be month, week...
$productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
$productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example; // String | For filtering: Could be minutes, GB...
$productOfferingPrice.version = productOfferingPrice.version_example; // String | For filtering: ProductOffering version
$productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example; // String | For filtering: A link to the schema describing this product offering term
$productOfferingTerm.@type = productOfferingTerm.@type_example; // String | For filtering: The class type of ProductOfferingTerm
$productOfferingTerm.name = productOfferingTerm.name_example; // String | For filtering: Name of the productOfferingTerm
$productSpecification.@referredType = productSpecification.@referredType_example; // String | For filtering: class type of referred Product Specification
$productSpecification.name = productSpecification.name_example; // String | For filtering: Name of the product specification
$productSpecification.version = productSpecification.version_example; // String | For filtering: Version of the product specification
$resourceCandidate.@referredType = resourceCandidate.@referredType_example; // String | For filtering: The Class type of referred Resource Candidate
$resourceCandidate.name = resourceCandidate.name_example; // String | For filtering: Name of the resource candidate
$resourceCandidate.version = resourceCandidate.version_example; // String | For filtering: Version of the resource candidate
$serviceCandidate.@referredType = serviceCandidate.@referredType_example; // String | For filtering: The Class type of  referred Service Candidate
$serviceCandidate.name = serviceCandidate.name_example; // String | For filtering: Name of the service candidate
$serviceCandidate.version = serviceCandidate.version_example; // String | For filtering: Version of the service candidate
$serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example; // String | For filtering: class type of referred Service Level Agreement
$serviceLevelAgreement.name = serviceLevelAgreement.name_example; // String | For filtering: Name of the service level agreement
$sort = ; // array[String] | For sorting: The options the product offerings can be sorted by.
$validFor.endDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, ending at the TimePeriod.
$validFor.startDateTime = 2013-10-20T19:20:30+01:00; // Date | For filtering: An instant of time, starting at the TimePeriod
$version = version_example; // String | For filtering: ProductOffering version

try {
    $result = $api_instance->listProductOffering($@baseType, $@schemaLocation, $@type, $agreement.@referredType, $agreement.name, $attachment.@baseType, $attachment.@schemaLocation, $attachment.@type, $attachment.mimeType, $attachment.type, $attachment.url, $baseSiteId, $bundledProductOffering.lifecycleStatus, $bundledProductOffering.name, $category.@referredType, $category.name, $category.version, $channel.@referredType, $channel.name, $facetSearchOption.id, $fields, $isBundle, $lastUpdate, $lifecycleStatus, $limit, $marketSegment.@referredType, $marketSegment.name, $name, $offeringGroup.id, $offset, $parentBundledProductOffering.id, $place.@referredType, $place.address, $place.name, $place.role, $prodSpecCharValueUse.maxCardinality, $prodSpecCharValueUse.minCardinality, $prodSpecCharValueUse.name, $prodSpecCharValueUse.valueType, $productOfferingPrice.@baseType, $productOfferingPrice.@schemaLocation, $productOfferingPrice.@type, $productOfferingPrice.isBundle, $productOfferingPrice.name, $productOfferingPrice.place.id, $productOfferingPrice.priceType, $productOfferingPrice.recurringChargePeriod, $productOfferingPrice.relatedParty.id, $productOfferingPrice.unitOfMeasure, $productOfferingPrice.version, $productOfferingTerm.@schemaLocation, $productOfferingTerm.@type, $productOfferingTerm.name, $productSpecification.@referredType, $productSpecification.name, $productSpecification.version, $resourceCandidate.@referredType, $resourceCandidate.name, $resourceCandidate.version, $serviceCandidate.@referredType, $serviceCandidate.name, $serviceCandidate.version, $serviceLevelAgreement.@referredType, $serviceLevelAgreement.name, $sort, $validFor.endDateTime, $validFor.startDateTime, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->listProductOffering: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductCatalogManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductCatalogManagementApi->new();
my $@baseType = @baseType_example; # String | For filtering: Immediate base (class) type of the product offering
my $@schemaLocation = @schemaLocation_example; # String | For filtering: A link to the schema describing this product offering
my $@type = @type_example; # String | For filtering: Class type of the product offering
my $agreement.@referredType = agreement.@referredType_example; # String | For filtering: class type of the referred Agreement
my $agreement.name = agreement.name_example; # String | For filtering: Name of the agreement
my $attachment.@baseType = attachment.@baseType_example; # String | For filtering: The immediate base class type of the attachment
my $attachment.@schemaLocation = attachment.@schemaLocation_example; # String | For filtering: A link to the schema describing this attachment entity
my $attachment.@type = attachment.@type_example; # String | For filtering: the class type of the Attachment
my $attachment.mimeType = attachment.mimeType_example; # String | For filtering: Attachment mime type such as extension file for video, picture and document
my $attachment.type = attachment.type_example; # String | For filtering: Attachment type such as video, picture
my $attachment.url = attachment.url_example; # String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example; # String | For filtering: Used to indicate the current lifecycle status
my $bundledProductOffering.name = bundledProductOffering.name_example; # String | For filtering: Name of the BundledProductOffering
my $category.@referredType = category.@referredType_example; # String | For filtering: the class type of the referred Category
my $category.name = category.name_example; # String | For filtering: Name of the category
my $category.version = category.version_example; # String | For filtering: Category version
my $channel.@referredType = channel.@referredType_example; # String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
my $channel.name = channel.name_example; # String | For filtering: Name of the channel
my $facetSearchOption.id = []; # array[String] | For filtering by facet options. The identifier of the facet search option.
my $fields = fields_example; # String | Comma separated properties to display in response
my $isBundle = true; # Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
my $lastUpdate = 2013-10-20T19:20:30+01:00; # Date | For filtering: Date and time of the last update
my $lifecycleStatus = lifecycleStatus_example; # String | For filtering: Used to indicate the current lifecycle status
my $limit = 56; # Integer | Requested number of resources to be provided in response requested by client.
my $marketSegment.@referredType = marketSegment.@referredType_example; # String | For filtering: (Class) type of the referred market segment
my $marketSegment.name = marketSegment.name_example; # String | For filtering: Name of the market segment
my $name = name_example; # String | For filtering: Name of the productOffering
my $offeringGroup.id = offeringGroup.id_example; # String | For filtering: Id of the productOfferingGroup
my $offset = 56; # Integer | Requested index for start of resources to be provided in response requested by client.
my $parentBundledProductOffering.id = parentBundledProductOffering.id_example; # String | For filtering: Id of the parentBundledProductOffering
my $place.@referredType = place.@referredType_example; # String | For filtering: class type of the referred Place object
my $place.address = place.address_example; # String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
my $place.name = place.name_example; # String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
my $place.role = place.role_example; # String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
my $prodSpecCharValueUse.maxCardinality = 56; # Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
my $prodSpecCharValueUse.minCardinality = 56; # Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
my $prodSpecCharValueUse.name = prodSpecCharValueUse.name_example; # String | For filtering: Name of the associated productSpecCharacteristic
my $prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example; # String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
my $productOfferingPrice.@baseType = productOfferingPrice.@baseType_example; # String | For filtering: the immediate base class of product offering price
my $productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example; # String | For filtering: hyperlink reference to the product offering price schema
my $productOfferingPrice.@type = productOfferingPrice.@type_example; # String | For filtering: The class type of the product offering price
my $productOfferingPrice.isBundle = true; # Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not
my $productOfferingPrice.name = productOfferingPrice.name_example; # String | For filtering: Name of the productOfferingPrice
my $productOfferingPrice.place.id = productOfferingPrice.place.id_example; # String | For filtering: Identifier of the place for which product offering has prices available
my $productOfferingPrice.priceType = productOfferingPrice.priceType_example; # String | For filtering: Indicates the price type: recurring, one time, usage
my $productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example; # String | For filtering: Could be month, week...
my $productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; # String | For filtering: Identifier of the related party for which the price applies.
my $productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example; # String | For filtering: Could be minutes, GB...
my $productOfferingPrice.version = productOfferingPrice.version_example; # String | For filtering: ProductOffering version
my $productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example; # String | For filtering: A link to the schema describing this product offering term
my $productOfferingTerm.@type = productOfferingTerm.@type_example; # String | For filtering: The class type of ProductOfferingTerm
my $productOfferingTerm.name = productOfferingTerm.name_example; # String | For filtering: Name of the productOfferingTerm
my $productSpecification.@referredType = productSpecification.@referredType_example; # String | For filtering: class type of referred Product Specification
my $productSpecification.name = productSpecification.name_example; # String | For filtering: Name of the product specification
my $productSpecification.version = productSpecification.version_example; # String | For filtering: Version of the product specification
my $resourceCandidate.@referredType = resourceCandidate.@referredType_example; # String | For filtering: The Class type of referred Resource Candidate
my $resourceCandidate.name = resourceCandidate.name_example; # String | For filtering: Name of the resource candidate
my $resourceCandidate.version = resourceCandidate.version_example; # String | For filtering: Version of the resource candidate
my $serviceCandidate.@referredType = serviceCandidate.@referredType_example; # String | For filtering: The Class type of  referred Service Candidate
my $serviceCandidate.name = serviceCandidate.name_example; # String | For filtering: Name of the service candidate
my $serviceCandidate.version = serviceCandidate.version_example; # String | For filtering: Version of the service candidate
my $serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example; # String | For filtering: class type of referred Service Level Agreement
my $serviceLevelAgreement.name = serviceLevelAgreement.name_example; # String | For filtering: Name of the service level agreement
my $sort = []; # array[String] | For sorting: The options the product offerings can be sorted by.
my $validFor.endDateTime = 2013-10-20T19:20:30+01:00; # Date | For filtering: An instant of time, ending at the TimePeriod.
my $validFor.startDateTime = 2013-10-20T19:20:30+01:00; # Date | For filtering: An instant of time, starting at the TimePeriod
my $version = version_example; # String | For filtering: ProductOffering version

eval { 
    my $result = $api_instance->listProductOffering(@baseType => $@baseType, @schemaLocation => $@schemaLocation, @type => $@type, agreement.@referredType => $agreement.@referredType, agreement.name => $agreement.name, attachment.@baseType => $attachment.@baseType, attachment.@schemaLocation => $attachment.@schemaLocation, attachment.@type => $attachment.@type, attachment.mimeType => $attachment.mimeType, attachment.type => $attachment.type, attachment.url => $attachment.url, baseSiteId => $baseSiteId, bundledProductOffering.lifecycleStatus => $bundledProductOffering.lifecycleStatus, bundledProductOffering.name => $bundledProductOffering.name, category.@referredType => $category.@referredType, category.name => $category.name, category.version => $category.version, channel.@referredType => $channel.@referredType, channel.name => $channel.name, facetSearchOption.id => $facetSearchOption.id, fields => $fields, isBundle => $isBundle, lastUpdate => $lastUpdate, lifecycleStatus => $lifecycleStatus, limit => $limit, marketSegment.@referredType => $marketSegment.@referredType, marketSegment.name => $marketSegment.name, name => $name, offeringGroup.id => $offeringGroup.id, offset => $offset, parentBundledProductOffering.id => $parentBundledProductOffering.id, place.@referredType => $place.@referredType, place.address => $place.address, place.name => $place.name, place.role => $place.role, prodSpecCharValueUse.maxCardinality => $prodSpecCharValueUse.maxCardinality, prodSpecCharValueUse.minCardinality => $prodSpecCharValueUse.minCardinality, prodSpecCharValueUse.name => $prodSpecCharValueUse.name, prodSpecCharValueUse.valueType => $prodSpecCharValueUse.valueType, productOfferingPrice.@baseType => $productOfferingPrice.@baseType, productOfferingPrice.@schemaLocation => $productOfferingPrice.@schemaLocation, productOfferingPrice.@type => $productOfferingPrice.@type, productOfferingPrice.isBundle => $productOfferingPrice.isBundle, productOfferingPrice.name => $productOfferingPrice.name, productOfferingPrice.place.id => $productOfferingPrice.place.id, productOfferingPrice.priceType => $productOfferingPrice.priceType, productOfferingPrice.recurringChargePeriod => $productOfferingPrice.recurringChargePeriod, productOfferingPrice.relatedParty.id => $productOfferingPrice.relatedParty.id, productOfferingPrice.unitOfMeasure => $productOfferingPrice.unitOfMeasure, productOfferingPrice.version => $productOfferingPrice.version, productOfferingTerm.@schemaLocation => $productOfferingTerm.@schemaLocation, productOfferingTerm.@type => $productOfferingTerm.@type, productOfferingTerm.name => $productOfferingTerm.name, productSpecification.@referredType => $productSpecification.@referredType, productSpecification.name => $productSpecification.name, productSpecification.version => $productSpecification.version, resourceCandidate.@referredType => $resourceCandidate.@referredType, resourceCandidate.name => $resourceCandidate.name, resourceCandidate.version => $resourceCandidate.version, serviceCandidate.@referredType => $serviceCandidate.@referredType, serviceCandidate.name => $serviceCandidate.name, serviceCandidate.version => $serviceCandidate.version, serviceLevelAgreement.@referredType => $serviceLevelAgreement.@referredType, serviceLevelAgreement.name => $serviceLevelAgreement.name, sort => $sort, validFor.endDateTime => $validFor.endDateTime, validFor.startDateTime => $validFor.startDateTime, version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->listProductOffering: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductCatalogManagementApi()
@baseType = @baseType_example # String | For filtering: Immediate base (class) type of the product offering (optional)
@schemaLocation = @schemaLocation_example # String | For filtering: A link to the schema describing this product offering (optional)
@type = @type_example # String | For filtering: Class type of the product offering (optional)
agreement.@referredType = agreement.@referredType_example # String | For filtering: class type of the referred Agreement (optional)
agreement.name = agreement.name_example # String | For filtering: Name of the agreement (optional)
attachment.@baseType = attachment.@baseType_example # String | For filtering: The immediate base class type of the attachment (optional)
attachment.@schemaLocation = attachment.@schemaLocation_example # String | For filtering: A link to the schema describing this attachment entity (optional)
attachment.@type = attachment.@type_example # String | For filtering: the class type of the Attachment (optional)
attachment.mimeType = attachment.mimeType_example # String | For filtering: Attachment mime type such as extension file for video, picture and document (optional)
attachment.type = attachment.type_example # String | For filtering: Attachment type such as video, picture (optional)
attachment.url = attachment.url_example # String | For filtering: Uniform Resource Locator, is a web page address (a subset of URI) (optional)
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
bundledProductOffering.lifecycleStatus = bundledProductOffering.lifecycleStatus_example # String | For filtering: Used to indicate the current lifecycle status (optional)
bundledProductOffering.name = bundledProductOffering.name_example # String | For filtering: Name of the BundledProductOffering (optional)
category.@referredType = category.@referredType_example # String | For filtering: the class type of the referred Category (optional)
category.name = category.name_example # String | For filtering: Name of the category (optional)
category.version = category.version_example # String | For filtering: Category version (optional)
channel.@referredType = channel.@referredType_example # String | For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on (optional)
channel.name = channel.name_example # String | For filtering: Name of the channel (optional)
facetSearchOption.id =  # array[String] | For filtering by facet options. The identifier of the facet search option. (optional)
fields = fields_example # String | Comma separated properties to display in response (optional)
isBundle = true # Boolean | For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true). (optional)
lastUpdate = 2013-10-20T19:20:30+01:00 # Date | For filtering: Date and time of the last update (optional)
lifecycleStatus = lifecycleStatus_example # String | For filtering: Used to indicate the current lifecycle status (optional)
limit = 56 # Integer | Requested number of resources to be provided in response requested by client. (optional)
marketSegment.@referredType = marketSegment.@referredType_example # String | For filtering: (Class) type of the referred market segment (optional)
marketSegment.name = marketSegment.name_example # String | For filtering: Name of the market segment (optional)
name = name_example # String | For filtering: Name of the productOffering (optional)
offeringGroup.id = offeringGroup.id_example # String | For filtering: Id of the productOfferingGroup (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response requested by client. (optional)
parentBundledProductOffering.id = parentBundledProductOffering.id_example # String | For filtering: Id of the parentBundledProductOffering (optional)
place.@referredType = place.@referredType_example # String | For filtering: class type of the referred Place object (optional)
place.address = place.address_example # String | For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API). (optional)
place.name = place.name_example # String | For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home" (optional)
place.role = place.role_example # String | For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval') (optional)
prodSpecCharValueUse.maxCardinality = 56 # Integer | For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. (optional)
prodSpecCharValueUse.minCardinality = 56 # Integer | For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. (optional)
prodSpecCharValueUse.name = prodSpecCharValueUse.name_example # String | For filtering: Name of the associated productSpecCharacteristic (optional)
prodSpecCharValueUse.valueType = prodSpecCharValueUse.valueType_example # String | For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth (optional)
productOfferingPrice.@baseType = productOfferingPrice.@baseType_example # String | For filtering: the immediate base class of product offering price (optional)
productOfferingPrice.@schemaLocation = productOfferingPrice.@schemaLocation_example # String | For filtering: hyperlink reference to the product offering price schema (optional)
productOfferingPrice.@type = productOfferingPrice.@type_example # String | For filtering: The class type of the product offering price (optional)
productOfferingPrice.isBundle = true # Boolean | For filtering: a flag indicating if this product offering price is bundle (composite) or not (optional)
productOfferingPrice.name = productOfferingPrice.name_example # String | For filtering: Name of the productOfferingPrice (optional)
productOfferingPrice.place.id = productOfferingPrice.place.id_example # String | For filtering: Identifier of the place for which product offering has prices available (optional)
productOfferingPrice.priceType = productOfferingPrice.priceType_example # String | For filtering: Indicates the price type: recurring, one time, usage (optional)
productOfferingPrice.recurringChargePeriod = productOfferingPrice.recurringChargePeriod_example # String | For filtering: Could be month, week... (optional)
productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example # String | For filtering: Identifier of the related party for which the price applies. (optional)
productOfferingPrice.unitOfMeasure = productOfferingPrice.unitOfMeasure_example # String | For filtering: Could be minutes, GB... (optional)
productOfferingPrice.version = productOfferingPrice.version_example # String | For filtering: ProductOffering version (optional)
productOfferingTerm.@schemaLocation = productOfferingTerm.@schemaLocation_example # String | For filtering: A link to the schema describing this product offering term (optional)
productOfferingTerm.@type = productOfferingTerm.@type_example # String | For filtering: The class type of ProductOfferingTerm (optional)
productOfferingTerm.name = productOfferingTerm.name_example # String | For filtering: Name of the productOfferingTerm (optional)
productSpecification.@referredType = productSpecification.@referredType_example # String | For filtering: class type of referred Product Specification (optional)
productSpecification.name = productSpecification.name_example # String | For filtering: Name of the product specification (optional)
productSpecification.version = productSpecification.version_example # String | For filtering: Version of the product specification (optional)
resourceCandidate.@referredType = resourceCandidate.@referredType_example # String | For filtering: The Class type of referred Resource Candidate (optional)
resourceCandidate.name = resourceCandidate.name_example # String | For filtering: Name of the resource candidate (optional)
resourceCandidate.version = resourceCandidate.version_example # String | For filtering: Version of the resource candidate (optional)
serviceCandidate.@referredType = serviceCandidate.@referredType_example # String | For filtering: The Class type of  referred Service Candidate (optional)
serviceCandidate.name = serviceCandidate.name_example # String | For filtering: Name of the service candidate (optional)
serviceCandidate.version = serviceCandidate.version_example # String | For filtering: Version of the service candidate (optional)
serviceLevelAgreement.@referredType = serviceLevelAgreement.@referredType_example # String | For filtering: class type of referred Service Level Agreement (optional)
serviceLevelAgreement.name = serviceLevelAgreement.name_example # String | For filtering: Name of the service level agreement (optional)
sort =  # array[String] | For sorting: The options the product offerings can be sorted by. (optional)
validFor.endDateTime = 2013-10-20T19:20:30+01:00 # Date | For filtering: An instant of time, ending at the TimePeriod. (optional)
validFor.startDateTime = 2013-10-20T19:20:30+01:00 # Date | For filtering: An instant of time, starting at the TimePeriod (optional)
version = version_example # String | For filtering: ProductOffering version (optional)

try: 
    # Retrieves a list of 'ProductOffering'
    api_response = api_instance.list_product_offering(@baseType=@baseType, @schemaLocation=@schemaLocation, @type=@type, agreement.@referredType=agreement.@referredType, agreement.name=agreement.name, attachment.@baseType=attachment.@baseType, attachment.@schemaLocation=attachment.@schemaLocation, attachment.@type=attachment.@type, attachment.mimeType=attachment.mimeType, attachment.type=attachment.type, attachment.url=attachment.url, baseSiteId=baseSiteId, bundledProductOffering.lifecycleStatus=bundledProductOffering.lifecycleStatus, bundledProductOffering.name=bundledProductOffering.name, category.@referredType=category.@referredType, category.name=category.name, category.version=category.version, channel.@referredType=channel.@referredType, channel.name=channel.name, facetSearchOption.id=facetSearchOption.id, fields=fields, isBundle=isBundle, lastUpdate=lastUpdate, lifecycleStatus=lifecycleStatus, limit=limit, marketSegment.@referredType=marketSegment.@referredType, marketSegment.name=marketSegment.name, name=name, offeringGroup.id=offeringGroup.id, offset=offset, parentBundledProductOffering.id=parentBundledProductOffering.id, place.@referredType=place.@referredType, place.address=place.address, place.name=place.name, place.role=place.role, prodSpecCharValueUse.maxCardinality=prodSpecCharValueUse.maxCardinality, prodSpecCharValueUse.minCardinality=prodSpecCharValueUse.minCardinality, prodSpecCharValueUse.name=prodSpecCharValueUse.name, prodSpecCharValueUse.valueType=prodSpecCharValueUse.valueType, productOfferingPrice.@baseType=productOfferingPrice.@baseType, productOfferingPrice.@schemaLocation=productOfferingPrice.@schemaLocation, productOfferingPrice.@type=productOfferingPrice.@type, productOfferingPrice.isBundle=productOfferingPrice.isBundle, productOfferingPrice.name=productOfferingPrice.name, productOfferingPrice.place.id=productOfferingPrice.place.id, productOfferingPrice.priceType=productOfferingPrice.priceType, productOfferingPrice.recurringChargePeriod=productOfferingPrice.recurringChargePeriod, productOfferingPrice.relatedParty.id=productOfferingPrice.relatedParty.id, productOfferingPrice.unitOfMeasure=productOfferingPrice.unitOfMeasure, productOfferingPrice.version=productOfferingPrice.version, productOfferingTerm.@schemaLocation=productOfferingTerm.@schemaLocation, productOfferingTerm.@type=productOfferingTerm.@type, productOfferingTerm.name=productOfferingTerm.name, productSpecification.@referredType=productSpecification.@referredType, productSpecification.name=productSpecification.name, productSpecification.version=productSpecification.version, resourceCandidate.@referredType=resourceCandidate.@referredType, resourceCandidate.name=resourceCandidate.name, resourceCandidate.version=resourceCandidate.version, serviceCandidate.@referredType=serviceCandidate.@referredType, serviceCandidate.name=serviceCandidate.name, serviceCandidate.version=serviceCandidate.version, serviceLevelAgreement.@referredType=serviceLevelAgreement.@referredType, serviceLevelAgreement.name=serviceLevelAgreement.name, sort=sort, validFor.endDateTime=validFor.endDateTime, validFor.startDateTime=validFor.startDateTime, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->listProductOffering: %s\n" % e)

Parameters

Query parameters
Name Description
@baseType
String
For filtering: Immediate base (class) type of the product offering
@schemaLocation
String
For filtering: A link to the schema describing this product offering
@type
String
For filtering: Class type of the product offering
agreement.@referredType
String
For filtering: class type of the referred Agreement
agreement.name
String
For filtering: Name of the agreement
attachment.@baseType
String
For filtering: The immediate base class type of the attachment
attachment.@schemaLocation
String
For filtering: A link to the schema describing this attachment entity
attachment.@type
String
For filtering: the class type of the Attachment
attachment.mimeType
String
For filtering: Attachment mime type such as extension file for video, picture and document
attachment.type
String
For filtering: Attachment type such as video, picture
attachment.url
String
For filtering: Uniform Resource Locator, is a web page address (a subset of URI)
baseSiteId
String
Identifier of the BaseSite
bundledProductOffering.lifecycleStatus
String
For filtering: Used to indicate the current lifecycle status
bundledProductOffering.name
String
For filtering: Name of the BundledProductOffering
category.@referredType
String
For filtering: the class type of the referred Category
category.name
String
For filtering: Name of the category
category.version
String
For filtering: Category version
channel.@referredType
String
For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on
channel.name
String
For filtering: Name of the channel
facetSearchOption.id
array[String]
For filtering by facet options. The identifier of the facet search option.
fields
String
Comma separated properties to display in response
isBundle
Boolean
For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
lastUpdate
Date (date-time)
For filtering: Date and time of the last update
lifecycleStatus
String
For filtering: Used to indicate the current lifecycle status
limit
Integer (int32)
Requested number of resources to be provided in response requested by client.
marketSegment.@referredType
String
For filtering: (Class) type of the referred market segment
marketSegment.name
String
For filtering: Name of the market segment
name
String
For filtering: Name of the productOffering
offeringGroup.id
String
For filtering: Id of the productOfferingGroup
offset
Integer (int32)
Requested index for start of resources to be provided in response requested by client.
parentBundledProductOffering.id
String
For filtering: Id of the parentBundledProductOffering
place.@referredType
String
For filtering: class type of the referred Place object
place.address
String
For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).
place.name
String
For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"
place.role
String
For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')
prodSpecCharValueUse.maxCardinality
Integer (int32)
For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
prodSpecCharValueUse.minCardinality
Integer (int32)
For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
prodSpecCharValueUse.name
String
For filtering: Name of the associated productSpecCharacteristic
prodSpecCharValueUse.valueType
String
For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth
productOfferingPrice.@baseType
String
For filtering: the immediate base class of product offering price
productOfferingPrice.@schemaLocation
String
For filtering: hyperlink reference to the product offering price schema
productOfferingPrice.@type
String
For filtering: The class type of the product offering price
productOfferingPrice.isBundle
Boolean
For filtering: a flag indicating if this product offering price is bundle (composite) or not
productOfferingPrice.name
String
For filtering: Name of the productOfferingPrice
productOfferingPrice.place.id
String
For filtering: Identifier of the place for which product offering has prices available
productOfferingPrice.priceType
String
For filtering: Indicates the price type: recurring, one time, usage
productOfferingPrice.recurringChargePeriod
String
For filtering: Could be month, week...
productOfferingPrice.relatedParty.id
String
For filtering: Identifier of the related party for which the price applies.
productOfferingPrice.unitOfMeasure
String
For filtering: Could be minutes, GB...
productOfferingPrice.version
String
For filtering: ProductOffering version
productOfferingTerm.@schemaLocation
String
For filtering: A link to the schema describing this product offering term
productOfferingTerm.@type
String
For filtering: The class type of ProductOfferingTerm
productOfferingTerm.name
String
For filtering: Name of the productOfferingTerm
productSpecification.@referredType
String
For filtering: class type of referred Product Specification
productSpecification.name
String
For filtering: Name of the product specification
productSpecification.version
String
For filtering: Version of the product specification
resourceCandidate.@referredType
String
For filtering: The Class type of referred Resource Candidate
resourceCandidate.name
String
For filtering: Name of the resource candidate
resourceCandidate.version
String
For filtering: Version of the resource candidate
serviceCandidate.@referredType
String
For filtering: The Class type of referred Service Candidate
serviceCandidate.name
String
For filtering: Name of the service candidate
serviceCandidate.version
String
For filtering: Version of the service candidate
serviceLevelAgreement.@referredType
String
For filtering: class type of referred Service Level Agreement
serviceLevelAgreement.name
String
For filtering: Name of the service level agreement
sort
array[String]
For sorting: The options the product offerings can be sorted by.
validFor.endDateTime
Date (date-time)
For filtering: An instant of time, ending at the TimePeriod.
validFor.startDateTime
Date (date-time)
For filtering: An instant of time, starting at the TimePeriod
version
String
For filtering: ProductOffering version

Responses

Status: 200 - Ok

Status: 206 - Partial Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


retrieveCategory

Retrieves a 'Category' by Id


/category/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/category/{id}?baseSiteId=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCatalogManagementApi;

import java.io.File;
import java.util.*;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the Category
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[Category] result = apiInstance.retrieveCategory(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveCategory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the Category
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            array[Category] result = apiInstance.retrieveCategory(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveCategory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the Category
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)

ProductCatalogManagementApi *apiInstance = [[ProductCatalogManagementApi alloc] init];

// Retrieves a 'Category' by Id
[apiInstance retrieveCategoryWith:id
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(array[Category] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the Category
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveCategory(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveCategoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductCatalogManagementApi();
            var id = id_example;  // String | Identifier of the Category
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 

            try
            {
                // Retrieves a 'Category' by Id
                array[Category] result = apiInstance.retrieveCategory(id, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.retrieveCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductCatalogManagementApi();
$id = id_example; // String | Identifier of the Category
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body

try {
    $result = $api_instance->retrieveCategory($id, $baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->retrieveCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductCatalogManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductCatalogManagementApi->new();
my $id = id_example; # String | Identifier of the Category
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body

eval { 
    my $result = $api_instance->retrieveCategory(id => $id, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->retrieveCategory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductCatalogManagementApi()
id = id_example # String | Identifier of the Category
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)

try: 
    # Retrieves a 'Category' by Id
    api_response = api_instance.retrieve_category(id, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->retrieveCategory: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Category
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Response configuration. This is the list of fields that should be returned in the response body

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


retrieveProductOffering

Retrieves a 'ProductOffering' by Id


/productOffering/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOffering/{id}?baseSiteId=&fields=&productOfferingPrice.place.id=&productOfferingPrice.processType.id=&productOfferingPrice.relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCatalogManagementApi;

import java.io.File;
import java.util.*;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the Product Offering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | Identifier of the place for which product offering has prices available
        array[String] productOfferingPrice.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
        String productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        try {
            array[ProductOffering] result = apiInstance.retrieveProductOffering(id, baseSiteId, fields, productOfferingPrice.place.id, productOfferingPrice.processType.id, productOfferingPrice.relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the Product Offering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | Identifier of the place for which product offering has prices available
        array[String] productOfferingPrice.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
        String productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        try {
            array[ProductOffering] result = apiInstance.retrieveProductOffering(id, baseSiteId, fields, productOfferingPrice.place.id, productOfferingPrice.processType.id, productOfferingPrice.relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductOffering");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the Product Offering
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *productOfferingPrice.place.id = productOfferingPrice.place.id_example; // Identifier of the place for which product offering has prices available (optional)
array[String] *productOfferingPrice.processType.id = ; // For filtering by the process type of the product offering price. (optional)
String *productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // For filtering: Identifier of the related party for which the price applies. (optional)

ProductCatalogManagementApi *apiInstance = [[ProductCatalogManagementApi alloc] init];

// Retrieves a 'ProductOffering' by Id
[apiInstance retrieveProductOfferingWith:id
    baseSiteId:baseSiteId
    fields:fields
    productOfferingPrice.place.id:productOfferingPrice.place.id
    productOfferingPrice.processType.id:productOfferingPrice.processType.id
    productOfferingPrice.relatedParty.id:productOfferingPrice.relatedParty.id
              completionHandler: ^(array[ProductOffering] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the Product Offering
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'productOfferingPrice.place.id': productOfferingPrice.place.id_example, // {{String}} Identifier of the place for which product offering has prices available
  'productOfferingPrice.processType.id': , // {{array[String]}} For filtering by the process type of the product offering price.
  'productOfferingPrice.relatedParty.id': productOfferingPrice.relatedParty.id_example // {{String}} For filtering: Identifier of the related party for which the price applies.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveProductOffering(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProductOfferingExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductCatalogManagementApi();
            var id = id_example;  // String | Identifier of the Product Offering
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var productOfferingPrice.place.id = productOfferingPrice.place.id_example;  // String | Identifier of the place for which product offering has prices available (optional) 
            var productOfferingPrice.processType.id = new array[String](); // array[String] | For filtering by the process type of the product offering price. (optional) 
            var productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example;  // String | For filtering: Identifier of the related party for which the price applies. (optional) 

            try
            {
                // Retrieves a 'ProductOffering' by Id
                array[ProductOffering] result = apiInstance.retrieveProductOffering(id, baseSiteId, fields, productOfferingPrice.place.id, productOfferingPrice.processType.id, productOfferingPrice.relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.retrieveProductOffering: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductCatalogManagementApi();
$id = id_example; // String | Identifier of the Product Offering
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$productOfferingPrice.place.id = productOfferingPrice.place.id_example; // String | Identifier of the place for which product offering has prices available
$productOfferingPrice.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
$productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.

try {
    $result = $api_instance->retrieveProductOffering($id, $baseSiteId, $fields, $productOfferingPrice.place.id, $productOfferingPrice.processType.id, $productOfferingPrice.relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->retrieveProductOffering: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductCatalogManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductCatalogManagementApi->new();
my $id = id_example; # String | Identifier of the Product Offering
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $productOfferingPrice.place.id = productOfferingPrice.place.id_example; # String | Identifier of the place for which product offering has prices available
my $productOfferingPrice.processType.id = []; # array[String] | For filtering by the process type of the product offering price.
my $productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example; # String | For filtering: Identifier of the related party for which the price applies.

eval { 
    my $result = $api_instance->retrieveProductOffering(id => $id, baseSiteId => $baseSiteId, fields => $fields, productOfferingPrice.place.id => $productOfferingPrice.place.id, productOfferingPrice.processType.id => $productOfferingPrice.processType.id, productOfferingPrice.relatedParty.id => $productOfferingPrice.relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->retrieveProductOffering: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductCatalogManagementApi()
id = id_example # String | Identifier of the Product Offering
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
productOfferingPrice.place.id = productOfferingPrice.place.id_example # String | Identifier of the place for which product offering has prices available (optional)
productOfferingPrice.processType.id =  # array[String] | For filtering by the process type of the product offering price. (optional)
productOfferingPrice.relatedParty.id = productOfferingPrice.relatedParty.id_example # String | For filtering: Identifier of the related party for which the price applies. (optional)

try: 
    # Retrieves a 'ProductOffering' by Id
    api_response = api_instance.retrieve_product_offering(id, baseSiteId=baseSiteId, fields=fields, productOfferingPrice.place.id=productOfferingPrice.place.id, productOfferingPrice.processType.id=productOfferingPrice.processType.id, productOfferingPrice.relatedParty.id=productOfferingPrice.relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->retrieveProductOffering: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Product Offering
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Response configuration. This is the list of fields that should be returned in the response body
productOfferingPrice.place.id
String
Identifier of the place for which product offering has prices available
productOfferingPrice.processType.id
array[String]
For filtering by the process type of the product offering price.
productOfferingPrice.relatedParty.id
String
For filtering: Identifier of the related party for which the price applies.

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


retrieveProductSpecification

Retrieves a ProductSpecification by ID

This operation retrieves a ProductSpecification entity. Attribute selection is enabled for all first level attributes.


/productSpecification/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productSpecification/{id}?baseSiteId=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCatalogManagementApi;

import java.io.File;
import java.util.*;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the ProductSpecification
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductSpecification result = apiInstance.retrieveProductSpecification(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String id = id_example; // String | Identifier of the ProductSpecification
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductSpecification result = apiInstance.retrieveProductSpecification(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductSpecification");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the ProductSpecification
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Comma-separated properties to provide in response (optional)

ProductCatalogManagementApi *apiInstance = [[ProductCatalogManagementApi alloc] init];

// Retrieves a ProductSpecification by ID
[apiInstance retrieveProductSpecificationWith:id
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(ProductSpecification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the ProductSpecification
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example // {{String}} Comma-separated properties to provide in response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveProductSpecification(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProductSpecificationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductCatalogManagementApi();
            var id = id_example;  // String | Identifier of the ProductSpecification
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

            try
            {
                // Retrieves a ProductSpecification by ID
                ProductSpecification result = apiInstance.retrieveProductSpecification(id, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.retrieveProductSpecification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductCatalogManagementApi();
$id = id_example; // String | Identifier of the ProductSpecification
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma-separated properties to provide in response

try {
    $result = $api_instance->retrieveProductSpecification($id, $baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->retrieveProductSpecification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductCatalogManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductCatalogManagementApi->new();
my $id = id_example; # String | Identifier of the ProductSpecification
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveProductSpecification(id => $id, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->retrieveProductSpecification: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductCatalogManagementApi()
id = id_example # String | Identifier of the ProductSpecification
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma-separated properties to provide in response (optional)

try: 
    # Retrieves a ProductSpecification by ID
    api_response = api_instance.retrieve_product_specification(id, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->retrieveProductSpecification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductSpecification
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Comma-separated properties to provide in response

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


ProductOrder

patchProductOrder

Updates partially a ProductOrder

This operation updates partially a ProductOrder entity.


/productOrdering/productOrder/{id}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOrdering/productOrder/{id}?baseSiteId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductOrderApi;

import java.io.File;
import java.util.*;

public class ProductOrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductOrderApi apiInstance = new ProductOrderApi();
        ProductOrder body = ; // ProductOrder | 
        String id = id_example; // String | Identifier of the ProductOrder
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderApi#patchProductOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderApi;

public class ProductOrderApiExample {

    public static void main(String[] args) {
        ProductOrderApi apiInstance = new ProductOrderApi();
        ProductOrder body = ; // ProductOrder | 
        String id = id_example; // String | Identifier of the ProductOrder
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderApi#patchProductOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProductOrder *body = ; // 
String *id = id_example; // Identifier of the ProductOrder
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)

ProductOrderApi *apiInstance = [[ProductOrderApi alloc] init];

// Updates partially a ProductOrder
[apiInstance patchProductOrderWith:body
    id:id
    baseSiteId:baseSiteId
              completionHandler: ^(ProductOrder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductOrderApi()
var body = ; // {{ProductOrder}} 
var id = id_example; // {{String}} Identifier of the ProductOrder
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProductOrder(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProductOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductOrderApi();
            var body = new ProductOrder(); // ProductOrder | 
            var id = id_example;  // String | Identifier of the ProductOrder
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 

            try
            {
                // Updates partially a ProductOrder
                ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderApi.patchProductOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductOrderApi();
$body = ; // ProductOrder | 
$id = id_example; // String | Identifier of the ProductOrder
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite

try {
    $result = $api_instance->patchProductOrder($body, $id, $baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderApi->patchProductOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductOrderApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductOrderApi->new();
my $body = WWW::SwaggerClient::Object::ProductOrder->new(); # ProductOrder | 
my $id = id_example; # String | Identifier of the ProductOrder
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite

eval { 
    my $result = $api_instance->patchProductOrder(body => $body, id => $id, baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderApi->patchProductOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductOrderApi()
body =  # ProductOrder | 
id = id_example # String | Identifier of the ProductOrder
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)

try: 
    # Updates partially a ProductOrder
    api_response = api_instance.patch_product_order(body, id, baseSiteId=baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderApi->patchProductOrder: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOrder
Required
Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


ProductOrdering

listProductOrders

List product orders

This operation list product order entities. Attribute selection is enabled for all first level attributes. Filtering may be available depending on the compliance level supported by an implementation.


/productOrdering/productOrder

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOrdering/productOrder?baseSiteId=&fields=&limit=&offset=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductOrderingApi;

import java.io.File;
import java.util.*;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductOrderingApi apiInstance = new ProductOrderingApi();
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attributes selection
        Integer limit = 56; // Integer | Number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        try {
            array[ProductOrder] result = apiInstance.listProductOrders(relatedParty.id, baseSiteId, fields, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#listProductOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderingApi;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ProductOrderingApi apiInstance = new ProductOrderingApi();
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attributes selection
        Integer limit = 56; // Integer | Number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        try {
            array[ProductOrder] result = apiInstance.listProductOrders(relatedParty.id, baseSiteId, fields, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#listProductOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *relatedParty.id = relatedParty.id_example; // Identifier of the PartyRole
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Attributes selection (optional)
Integer *limit = 56; // Number of resources to be provided in response (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)

ProductOrderingApi *apiInstance = [[ProductOrderingApi alloc] init];

// List product orders
[apiInstance listProductOrdersWith:relatedParty.id
    baseSiteId:baseSiteId
    fields:fields
    limit:limit
    offset:offset
              completionHandler: ^(array[ProductOrder] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductOrderingApi()
var relatedParty.id = relatedParty.id_example; // {{String}} Identifier of the PartyRole
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Attributes selection
  'limit': 56, // {{Integer}} Number of resources to be provided in response
  'offset': 56 // {{Integer}} Requested index for start of resources to be provided in response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProductOrders(relatedParty.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductOrderingApi();
            var relatedParty.id = relatedParty.id_example;  // String | Identifier of the PartyRole
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Attributes selection (optional) 
            var limit = 56;  // Integer | Number of resources to be provided in response (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 

            try
            {
                // List product orders
                array[ProductOrder] result = apiInstance.listProductOrders(relatedParty.id, baseSiteId, fields, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderingApi.listProductOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductOrderingApi();
$relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Attributes selection
$limit = 56; // Integer | Number of resources to be provided in response
$offset = 56; // Integer | Requested index for start of resources to be provided in response

try {
    $result = $api_instance->listProductOrders($relatedParty.id, $baseSiteId, $fields, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderingApi->listProductOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductOrderingApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductOrderingApi->new();
my $relatedParty.id = relatedParty.id_example; # String | Identifier of the PartyRole
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Attributes selection
my $limit = 56; # Integer | Number of resources to be provided in response
my $offset = 56; # Integer | Requested index for start of resources to be provided in response

eval { 
    my $result = $api_instance->listProductOrders(relatedParty.id => $relatedParty.id, baseSiteId => $baseSiteId, fields => $fields, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderingApi->listProductOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductOrderingApi()
relatedParty.id = relatedParty.id_example # String | Identifier of the PartyRole
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Attributes selection (optional)
limit = 56 # Integer | Number of resources to be provided in response (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)

try: 
    # List product orders
    api_response = api_instance.list_product_orders(relatedParty.id, baseSiteId=baseSiteId, fields=fields, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderingApi->listProductOrders: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Attributes selection
limit
Integer (int32)
Number of resources to be provided in response
offset
Integer (int32)
Requested index for start of resources to be provided in response
relatedParty.id*
String
Identifier of the PartyRole
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials

Status: 403 - Forbidden List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error

Status: 503 - Service Unavailable List of supported error codes: - 5: The service is temporarily unavailable - 6: API is over capacity, retry later !


patchProductOrder

Updates partially a ProductOrder

This operation updates partially a ProductOrder entity.


/productOrdering/productOrder/{id}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOrdering/productOrder/{id}?baseSiteId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductOrderingApi;

import java.io.File;
import java.util.*;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductOrderingApi apiInstance = new ProductOrderingApi();
        ProductOrder body = ; // ProductOrder | 
        String id = id_example; // String | Identifier of the ProductOrder
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#patchProductOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderingApi;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ProductOrderingApi apiInstance = new ProductOrderingApi();
        ProductOrder body = ; // ProductOrder | 
        String id = id_example; // String | Identifier of the ProductOrder
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#patchProductOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProductOrder *body = ; // 
String *id = id_example; // Identifier of the ProductOrder
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)

ProductOrderingApi *apiInstance = [[ProductOrderingApi alloc] init];

// Updates partially a ProductOrder
[apiInstance patchProductOrderWith:body
    id:id
    baseSiteId:baseSiteId
              completionHandler: ^(ProductOrder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductOrderingApi()
var body = ; // {{ProductOrder}} 
var id = id_example; // {{String}} Identifier of the ProductOrder
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProductOrder(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProductOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductOrderingApi();
            var body = new ProductOrder(); // ProductOrder | 
            var id = id_example;  // String | Identifier of the ProductOrder
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 

            try
            {
                // Updates partially a ProductOrder
                ProductOrder result = apiInstance.patchProductOrder(body, id, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderingApi.patchProductOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductOrderingApi();
$body = ; // ProductOrder | 
$id = id_example; // String | Identifier of the ProductOrder
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite

try {
    $result = $api_instance->patchProductOrder($body, $id, $baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderingApi->patchProductOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductOrderingApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductOrderingApi->new();
my $body = WWW::SwaggerClient::Object::ProductOrder->new(); # ProductOrder | 
my $id = id_example; # String | Identifier of the ProductOrder
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite

eval { 
    my $result = $api_instance->patchProductOrder(body => $body, id => $id, baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderingApi->patchProductOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductOrderingApi()
body =  # ProductOrder | 
id = id_example # String | Identifier of the ProductOrder
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)

try: 
    # Updates partially a ProductOrder
    api_response = api_instance.patch_product_order(body, id, baseSiteId=baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderingApi->patchProductOrder: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOrder
Required
Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


productOrderCreate

Creates a 'ProductOrder' resource

This operation creates a product order entity and triggers the place order process


/productOrdering/productOrder

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOrdering/productOrder?baseSiteId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductOrderingApi;

import java.io.File;
import java.util.*;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductOrderingApi apiInstance = new ProductOrderingApi();
        ProductOrder body = ; // ProductOrder | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.productOrderCreate(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#productOrderCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderingApi;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ProductOrderingApi apiInstance = new ProductOrderingApi();
        ProductOrder body = ; // ProductOrder | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        try {
            ProductOrder result = apiInstance.productOrderCreate(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#productOrderCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ProductOrder *body = ; // 
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)

ProductOrderingApi *apiInstance = [[ProductOrderingApi alloc] init];

// Creates a 'ProductOrder' resource
[apiInstance productOrderCreateWith:body
    baseSiteId:baseSiteId
              completionHandler: ^(ProductOrder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductOrderingApi()
var body = ; // {{ProductOrder}} 
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.productOrderCreate(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class productOrderCreateExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductOrderingApi();
            var body = new ProductOrder(); // ProductOrder | 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 

            try
            {
                // Creates a 'ProductOrder' resource
                ProductOrder result = apiInstance.productOrderCreate(body, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderingApi.productOrderCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductOrderingApi();
$body = ; // ProductOrder | 
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite

try {
    $result = $api_instance->productOrderCreate($body, $baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderingApi->productOrderCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductOrderingApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductOrderingApi->new();
my $body = WWW::SwaggerClient::Object::ProductOrder->new(); # ProductOrder | 
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite

eval { 
    my $result = $api_instance->productOrderCreate(body => $body, baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderingApi->productOrderCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductOrderingApi()
body =  # ProductOrder | 
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)

try: 
    # Creates a 'ProductOrder' resource
    api_response = api_instance.product_order_create(body, baseSiteId=baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderingApi->productOrderCreate: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite

Responses

Status: 201 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials

Status: 403 - Forbidden List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error

Status: 503 - Service Unavailable List of supported error codes: - 5: The service is temporarily unavailable


retrieveProductOrder

Retrieves a ProductOrder by ID

This operation retrieves a ProductOrder entity. Attribute selection is enabled for all first level attributes.


/productOrdering/productOrder/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/productOrdering/productOrder/{id}?baseSiteId=&fields=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductOrderingApi;

import java.io.File;
import java.util.*;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductOrderingApi apiInstance = new ProductOrderingApi();
        String id = id_example; // String | Identifier of the ProductOrder
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductOrder result = apiInstance.retrieveProductOrder(id, relatedParty.id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#retrieveProductOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderingApi;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ProductOrderingApi apiInstance = new ProductOrderingApi();
        String id = id_example; // String | Identifier of the ProductOrder
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductOrder result = apiInstance.retrieveProductOrder(id, relatedParty.id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#retrieveProductOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the ProductOrder
String *relatedParty.id = relatedParty.id_example; // Identifier of the Customer
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Comma-separated properties to provide in response (optional)

ProductOrderingApi *apiInstance = [[ProductOrderingApi alloc] init];

// Retrieves a ProductOrder by ID
[apiInstance retrieveProductOrderWith:id
    relatedParty.id:relatedParty.id
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(ProductOrder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ProductOrderingApi()
var id = id_example; // {{String}} Identifier of the ProductOrder
var relatedParty.id = relatedParty.id_example; // {{String}} Identifier of the Customer
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example // {{String}} Comma-separated properties to provide in response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveProductOrder(id, relatedParty.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProductOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductOrderingApi();
            var id = id_example;  // String | Identifier of the ProductOrder
            var relatedParty.id = relatedParty.id_example;  // String | Identifier of the Customer
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

            try
            {
                // Retrieves a ProductOrder by ID
                ProductOrder result = apiInstance.retrieveProductOrder(id, relatedParty.id, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderingApi.retrieveProductOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductOrderingApi();
$id = id_example; // String | Identifier of the ProductOrder
$relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma-separated properties to provide in response

try {
    $result = $api_instance->retrieveProductOrder($id, $relatedParty.id, $baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderingApi->retrieveProductOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductOrderingApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductOrderingApi->new();
my $id = id_example; # String | Identifier of the ProductOrder
my $relatedParty.id = relatedParty.id_example; # String | Identifier of the Customer
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveProductOrder(id => $id, relatedParty.id => $relatedParty.id, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderingApi->retrieveProductOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductOrderingApi()
id = id_example # String | Identifier of the ProductOrder
relatedParty.id = relatedParty.id_example # String | Identifier of the Customer
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma-separated properties to provide in response (optional)

try: 
    # Retrieves a ProductOrder by ID
    api_response = api_instance.retrieve_product_order(id, relatedParty.id, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderingApi->retrieveProductOrder: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOrder
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Comma-separated properties to provide in response
relatedParty.id*
String
Identifier of the Customer
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


Recommendation

listRecommendation

List or find 'Recommendation' objects


/recommendation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/recommendation?fields=&limit=&offset=&processType.id=&productOfferingTerm.id=&relatedParty.id=&relatedProductOffering.id=&subscriptionBase.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecommendationApi;

import java.io.File;
import java.util.*;

public class RecommendationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        RecommendationApi apiInstance = new RecommendationApi();
        String fields = fields_example; // String | Comma separated properties to display in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String processType.id = processType.id_example; // String | The identifier of the process type
        String productOfferingTerm.id = productOfferingTerm.id_example; // String | The identifier of the product offering term
        String relatedParty.id = relatedParty.id_example; // String | The identifier of the related party
        String relatedProductOffering.id = relatedProductOffering.id_example; // String | The identifier of the related product offering
        String subscriptionBase.id = subscriptionBase.id_example; // String | The identifier of the subscription base
        try {
            array[Recommendation] result = apiInstance.listRecommendation(fields, limit, offset, processType.id, productOfferingTerm.id, relatedParty.id, relatedProductOffering.id, subscriptionBase.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecommendationApi#listRecommendation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RecommendationApi;

public class RecommendationApiExample {

    public static void main(String[] args) {
        RecommendationApi apiInstance = new RecommendationApi();
        String fields = fields_example; // String | Comma separated properties to display in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String processType.id = processType.id_example; // String | The identifier of the process type
        String productOfferingTerm.id = productOfferingTerm.id_example; // String | The identifier of the product offering term
        String relatedParty.id = relatedParty.id_example; // String | The identifier of the related party
        String relatedProductOffering.id = relatedProductOffering.id_example; // String | The identifier of the related product offering
        String subscriptionBase.id = subscriptionBase.id_example; // String | The identifier of the subscription base
        try {
            array[Recommendation] result = apiInstance.listRecommendation(fields, limit, offset, processType.id, productOfferingTerm.id, relatedParty.id, relatedProductOffering.id, subscriptionBase.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecommendationApi#listRecommendation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *fields = fields_example; // Comma separated properties to display in response (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *processType.id = processType.id_example; // The identifier of the process type (optional)
String *productOfferingTerm.id = productOfferingTerm.id_example; // The identifier of the product offering term (optional)
String *relatedParty.id = relatedParty.id_example; // The identifier of the related party (optional)
String *relatedProductOffering.id = relatedProductOffering.id_example; // The identifier of the related product offering (optional)
String *subscriptionBase.id = subscriptionBase.id_example; // The identifier of the subscription base (optional)

RecommendationApi *apiInstance = [[RecommendationApi alloc] init];

// List or find 'Recommendation' objects
[apiInstance listRecommendationWith:fields
    limit:limit
    offset:offset
    processType.id:processType.id
    productOfferingTerm.id:productOfferingTerm.id
    relatedParty.id:relatedParty.id
    relatedProductOffering.id:relatedProductOffering.id
    subscriptionBase.id:subscriptionBase.id
              completionHandler: ^(array[Recommendation] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.RecommendationApi()
var opts = { 
  'fields': fields_example, // {{String}} Comma separated properties to display in response
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'processType.id': processType.id_example, // {{String}} The identifier of the process type
  'productOfferingTerm.id': productOfferingTerm.id_example, // {{String}} The identifier of the product offering term
  'relatedParty.id': relatedParty.id_example, // {{String}} The identifier of the related party
  'relatedProductOffering.id': relatedProductOffering.id_example, // {{String}} The identifier of the related product offering
  'subscriptionBase.id': subscriptionBase.id_example // {{String}} The identifier of the subscription base
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRecommendation(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRecommendationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new RecommendationApi();
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var processType.id = processType.id_example;  // String | The identifier of the process type (optional) 
            var productOfferingTerm.id = productOfferingTerm.id_example;  // String | The identifier of the product offering term (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | The identifier of the related party (optional) 
            var relatedProductOffering.id = relatedProductOffering.id_example;  // String | The identifier of the related product offering (optional) 
            var subscriptionBase.id = subscriptionBase.id_example;  // String | The identifier of the subscription base (optional) 

            try
            {
                // List or find 'Recommendation' objects
                array[Recommendation] result = apiInstance.listRecommendation(fields, limit, offset, processType.id, productOfferingTerm.id, relatedParty.id, relatedProductOffering.id, subscriptionBase.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecommendationApi.listRecommendation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiRecommendationApi();
$fields = fields_example; // String | Comma separated properties to display in response
$limit = 56; // Integer | Requested number of resources to be provided in response
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$processType.id = processType.id_example; // String | The identifier of the process type
$productOfferingTerm.id = productOfferingTerm.id_example; // String | The identifier of the product offering term
$relatedParty.id = relatedParty.id_example; // String | The identifier of the related party
$relatedProductOffering.id = relatedProductOffering.id_example; // String | The identifier of the related product offering
$subscriptionBase.id = subscriptionBase.id_example; // String | The identifier of the subscription base

try {
    $result = $api_instance->listRecommendation($fields, $limit, $offset, $processType.id, $productOfferingTerm.id, $relatedParty.id, $relatedProductOffering.id, $subscriptionBase.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecommendationApi->listRecommendation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RecommendationApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::RecommendationApi->new();
my $fields = fields_example; # String | Comma separated properties to display in response
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $processType.id = processType.id_example; # String | The identifier of the process type
my $productOfferingTerm.id = productOfferingTerm.id_example; # String | The identifier of the product offering term
my $relatedParty.id = relatedParty.id_example; # String | The identifier of the related party
my $relatedProductOffering.id = relatedProductOffering.id_example; # String | The identifier of the related product offering
my $subscriptionBase.id = subscriptionBase.id_example; # String | The identifier of the subscription base

eval { 
    my $result = $api_instance->listRecommendation(fields => $fields, limit => $limit, offset => $offset, processType.id => $processType.id, productOfferingTerm.id => $productOfferingTerm.id, relatedParty.id => $relatedParty.id, relatedProductOffering.id => $relatedProductOffering.id, subscriptionBase.id => $subscriptionBase.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecommendationApi->listRecommendation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.RecommendationApi()
fields = fields_example # String | Comma separated properties to display in response (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
processType.id = processType.id_example # String | The identifier of the process type (optional)
productOfferingTerm.id = productOfferingTerm.id_example # String | The identifier of the product offering term (optional)
relatedParty.id = relatedParty.id_example # String | The identifier of the related party (optional)
relatedProductOffering.id = relatedProductOffering.id_example # String | The identifier of the related product offering (optional)
subscriptionBase.id = subscriptionBase.id_example # String | The identifier of the subscription base (optional)

try: 
    # List or find 'Recommendation' objects
    api_response = api_instance.list_recommendation(fields=fields, limit=limit, offset=offset, processType.id=processType.id, productOfferingTerm.id=productOfferingTerm.id, relatedParty.id=relatedParty.id, relatedProductOffering.id=relatedProductOffering.id, subscriptionBase.id=subscriptionBase.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecommendationApi->listRecommendation: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Comma separated properties to display in response
limit
Integer (int32)
Requested number of resources to be provided in response
offset
Integer (int32)
Requested index for start of resources to be provided in response
processType.id
String
The identifier of the process type
productOfferingTerm.id
String
The identifier of the product offering term
relatedParty.id
String
The identifier of the related party
relatedProductOffering.id
String
The identifier of the related product offering
subscriptionBase.id
String
The identifier of the subscription base

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


Review

createReview

Creates a 'Review'


/review

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/review?productOffering.id=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReviewApi;

import java.io.File;
import java.util.*;

public class ReviewApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReviewApi apiInstance = new ReviewApi();
        Review body = ; // Review | 
        String productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            Review result = apiInstance.createReview(body, productOffering.id, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewApi#createReview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReviewApi;

public class ReviewApiExample {

    public static void main(String[] args) {
        ReviewApi apiInstance = new ReviewApi();
        Review body = ; // Review | 
        String productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            Review result = apiInstance.createReview(body, productOffering.id, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewApi#createReview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Review *body = ; // 
String *productOffering.id = productOffering.id_example; // Identifier of the Product Offering
String *relatedParty.id = relatedParty.id_example; // The id of the related party.

ReviewApi *apiInstance = [[ReviewApi alloc] init];

// Creates a 'Review'
[apiInstance createReviewWith:body
    productOffering.id:productOffering.id
    relatedParty.id:relatedParty.id
              completionHandler: ^(Review output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ReviewApi()
var body = ; // {{Review}} 
var productOffering.id = productOffering.id_example; // {{String}} Identifier of the Product Offering
var relatedParty.id = relatedParty.id_example; // {{String}} The id of the related party.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createReview(bodyproductOffering.idrelatedParty.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createReviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReviewApi();
            var body = new Review(); // Review | 
            var productOffering.id = productOffering.id_example;  // String | Identifier of the Product Offering
            var relatedParty.id = relatedParty.id_example;  // String | The id of the related party.

            try
            {
                // Creates a 'Review'
                Review result = apiInstance.createReview(body, productOffering.id, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReviewApi.createReview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReviewApi();
$body = ; // Review | 
$productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
$relatedParty.id = relatedParty.id_example; // String | The id of the related party.

try {
    $result = $api_instance->createReview($body, $productOffering.id, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReviewApi->createReview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReviewApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReviewApi->new();
my $body = WWW::SwaggerClient::Object::Review->new(); # Review | 
my $productOffering.id = productOffering.id_example; # String | Identifier of the Product Offering
my $relatedParty.id = relatedParty.id_example; # String | The id of the related party.

eval { 
    my $result = $api_instance->createReview(body => $body, productOffering.id => $productOffering.id, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReviewApi->createReview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReviewApi()
body =  # Review | 
productOffering.id = productOffering.id_example # String | Identifier of the Product Offering
relatedParty.id = relatedParty.id_example # String | The id of the related party.

try: 
    # Creates a 'Review'
    api_response = api_instance.create_review(body, productOffering.id, relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReviewApi->createReview: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
productOffering.id*
String
Identifier of the Product Offering
Required
relatedParty.id*
String
The id of the related party.
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error


listReview

List reviews


/review

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/review?fields=&limit=&offset=&productOffering.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReviewApi;

import java.io.File;
import java.util.*;

public class ReviewApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReviewApi apiInstance = new ReviewApi();
        String productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        Integer limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.
        try {
            array[Review] result = apiInstance.listReview(productOffering.id, fields, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewApi#listReview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReviewApi;

public class ReviewApiExample {

    public static void main(String[] args) {
        ReviewApi apiInstance = new ReviewApi();
        String productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        Integer limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.
        try {
            array[Review] result = apiInstance.listReview(productOffering.id, fields, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewApi#listReview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *productOffering.id = productOffering.id_example; // Identifier of the Product Offering
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
Integer *limit = 56; // Requested number of resources to be provided in response requested by client. (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response requested by client. (optional)

ReviewApi *apiInstance = [[ReviewApi alloc] init];

// List reviews
[apiInstance listReviewWith:productOffering.id
    fields:fields
    limit:limit
    offset:offset
              completionHandler: ^(array[Review] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ReviewApi()
var productOffering.id = productOffering.id_example; // {{String}} Identifier of the Product Offering
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response requested by client.
  'offset': 56 // {{Integer}} Requested index for start of resources to be provided in response requested by client.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listReview(productOffering.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listReviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReviewApi();
            var productOffering.id = productOffering.id_example;  // String | Identifier of the Product Offering
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response requested by client. (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response requested by client. (optional) 

            try
            {
                // List reviews
                array[Review] result = apiInstance.listReview(productOffering.id, fields, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReviewApi.listReview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReviewApi();
$productOffering.id = productOffering.id_example; // String | Identifier of the Product Offering
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$limit = 56; // Integer | Requested number of resources to be provided in response requested by client.
$offset = 56; // Integer | Requested index for start of resources to be provided in response requested by client.

try {
    $result = $api_instance->listReview($productOffering.id, $fields, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReviewApi->listReview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReviewApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReviewApi->new();
my $productOffering.id = productOffering.id_example; # String | Identifier of the Product Offering
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $limit = 56; # Integer | Requested number of resources to be provided in response requested by client.
my $offset = 56; # Integer | Requested index for start of resources to be provided in response requested by client.

eval { 
    my $result = $api_instance->listReview(productOffering.id => $productOffering.id, fields => $fields, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReviewApi->listReview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReviewApi()
productOffering.id = productOffering.id_example # String | Identifier of the Product Offering
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
limit = 56 # Integer | Requested number of resources to be provided in response requested by client. (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response requested by client. (optional)

try: 
    # List reviews
    api_response = api_instance.list_review(productOffering.id, fields=fields, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReviewApi->listReview: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body
limit
Integer (int32)
Requested number of resources to be provided in response requested by client.
offset
Integer (int32)
Requested index for start of resources to be provided in response requested by client.
productOffering.id*
String
Identifier of the Product Offering
Required

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Internal Server Error


ShoppingCart

createShoppingCart

Creates a 'ShoppingCart'

Creates a ShoppingCart. This API supports Location Based Pricing which means the prices will be applied based on the region of customer and stores other details of the customer like formerSuplier.


/shoppingCart

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/shoppingCart?baseSiteId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShoppingCartApi;

import java.io.File;
import java.util.*;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ShoppingCartApi apiInstance = new ShoppingCartApi();
        ShoppingCart body = ; // ShoppingCart | 
        String baseSiteId = baseSiteId_example; // String | The id of the base site.
        try {
            ShoppingCart result = apiInstance.createShoppingCart(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#createShoppingCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShoppingCartApi;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ShoppingCartApi apiInstance = new ShoppingCartApi();
        ShoppingCart body = ; // ShoppingCart | 
        String baseSiteId = baseSiteId_example; // String | The id of the base site.
        try {
            ShoppingCart result = apiInstance.createShoppingCart(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#createShoppingCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ShoppingCart *body = ; // 
String *baseSiteId = baseSiteId_example; // The id of the base site. (optional)

ShoppingCartApi *apiInstance = [[ShoppingCartApi alloc] init];

// Creates a 'ShoppingCart'
[apiInstance createShoppingCartWith:body
    baseSiteId:baseSiteId
              completionHandler: ^(ShoppingCart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ShoppingCartApi()
var body = ; // {{ShoppingCart}} 
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} The id of the base site.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createShoppingCart(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createShoppingCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShoppingCartApi();
            var body = new ShoppingCart(); // ShoppingCart | 
            var baseSiteId = baseSiteId_example;  // String | The id of the base site. (optional) 

            try
            {
                // Creates a 'ShoppingCart'
                ShoppingCart result = apiInstance.createShoppingCart(body, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShoppingCartApi.createShoppingCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiShoppingCartApi();
$body = ; // ShoppingCart | 
$baseSiteId = baseSiteId_example; // String | The id of the base site.

try {
    $result = $api_instance->createShoppingCart($body, $baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShoppingCartApi->createShoppingCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShoppingCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ShoppingCartApi->new();
my $body = WWW::SwaggerClient::Object::ShoppingCart->new(); # ShoppingCart | 
my $baseSiteId = baseSiteId_example; # String | The id of the base site.

eval { 
    my $result = $api_instance->createShoppingCart(body => $body, baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShoppingCartApi->createShoppingCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ShoppingCartApi()
body =  # ShoppingCart | 
baseSiteId = baseSiteId_example # String | The id of the base site. (optional)

try: 
    # Creates a 'ShoppingCart'
    api_response = api_instance.create_shopping_cart(body, baseSiteId=baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShoppingCartApi->createShoppingCart: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
The id of the base site.

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


listShoppingCart

List or find 'ShoppingCart' objects

This operation retrieves a list of shopping cart entities for the related party.


/shoppingCart

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/shoppingCart?baseSiteId=&fields=&limit=&offset=&relatedParty.Id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShoppingCartApi;

import java.io.File;
import java.util.*;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ShoppingCartApi apiInstance = new ShoppingCartApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma separated properties to display in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer
        try {
            array[ShoppingCart] result = apiInstance.listShoppingCart(baseSiteId, fields, limit, offset, relatedParty.Id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#listShoppingCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShoppingCartApi;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ShoppingCartApi apiInstance = new ShoppingCartApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma separated properties to display in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer
        try {
            array[ShoppingCart] result = apiInstance.listShoppingCart(baseSiteId, fields, limit, offset, relatedParty.Id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#listShoppingCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Comma separated properties to display in response (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *relatedParty.Id = relatedParty.Id_example; // Identifier of the Customer (optional)

ShoppingCartApi *apiInstance = [[ShoppingCartApi alloc] init];

// List or find 'ShoppingCart' objects
[apiInstance listShoppingCartWith:baseSiteId
    fields:fields
    limit:limit
    offset:offset
    relatedParty.Id:relatedParty.Id
              completionHandler: ^(array[ShoppingCart] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ShoppingCartApi()
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Comma separated properties to display in response
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'relatedParty.Id': relatedParty.Id_example // {{String}} Identifier of the Customer
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listShoppingCart(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listShoppingCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShoppingCartApi();
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma separated properties to display in response (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var relatedParty.Id = relatedParty.Id_example;  // String | Identifier of the Customer (optional) 

            try
            {
                // List or find 'ShoppingCart' objects
                array[ShoppingCart] result = apiInstance.listShoppingCart(baseSiteId, fields, limit, offset, relatedParty.Id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShoppingCartApi.listShoppingCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiShoppingCartApi();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma separated properties to display in response
$limit = 56; // Integer | Requested number of resources to be provided in response
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer

try {
    $result = $api_instance->listShoppingCart($baseSiteId, $fields, $limit, $offset, $relatedParty.Id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShoppingCartApi->listShoppingCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShoppingCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ShoppingCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma separated properties to display in response
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $relatedParty.Id = relatedParty.Id_example; # String | Identifier of the Customer

eval { 
    my $result = $api_instance->listShoppingCart(baseSiteId => $baseSiteId, fields => $fields, limit => $limit, offset => $offset, relatedParty.Id => $relatedParty.Id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShoppingCartApi->listShoppingCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ShoppingCartApi()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma separated properties to display in response (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
relatedParty.Id = relatedParty.Id_example # String | Identifier of the Customer (optional)

try: 
    # List or find 'ShoppingCart' objects
    api_response = api_instance.list_shopping_cart(baseSiteId=baseSiteId, fields=fields, limit=limit, offset=offset, relatedParty.Id=relatedParty.Id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShoppingCartApi->listShoppingCart: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Comma separated properties to display in response
limit
Integer (int32)
Requested number of resources to be provided in response
offset
Integer (int32)
Requested index for start of resources to be provided in response
relatedParty.Id
String
Identifier of the Customer

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


patchShoppingCart

Updates partially a 'ShoppingCart' by Id

This API updates the place, process type, cart status and other details like formerSupplier of the customer.


/shoppingCart/{id}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/json;charset=utf-8"\
-H "Content-Type: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/shoppingCart/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShoppingCartApi;

import java.io.File;
import java.util.*;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ShoppingCartApi apiInstance = new ShoppingCartApi();
        ShoppingCart body = ; // ShoppingCart | 
        String id = id_example; // String | Identifier of the Shopping Cart
        try {
            ShoppingCart result = apiInstance.patchShoppingCart(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#patchShoppingCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShoppingCartApi;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ShoppingCartApi apiInstance = new ShoppingCartApi();
        ShoppingCart body = ; // ShoppingCart | 
        String id = id_example; // String | Identifier of the Shopping Cart
        try {
            ShoppingCart result = apiInstance.patchShoppingCart(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#patchShoppingCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ShoppingCart *body = ; // 
String *id = id_example; // Identifier of the Shopping Cart

ShoppingCartApi *apiInstance = [[ShoppingCartApi alloc] init];

// Updates partially a 'ShoppingCart' by Id
[apiInstance patchShoppingCartWith:body
    id:id
              completionHandler: ^(ShoppingCart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ShoppingCartApi()
var body = ; // {{ShoppingCart}} 
var id = id_example; // {{String}} Identifier of the Shopping Cart

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchShoppingCart(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchShoppingCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShoppingCartApi();
            var body = new ShoppingCart(); // ShoppingCart | 
            var id = id_example;  // String | Identifier of the Shopping Cart

            try
            {
                // Updates partially a 'ShoppingCart' by Id
                ShoppingCart result = apiInstance.patchShoppingCart(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShoppingCartApi.patchShoppingCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiShoppingCartApi();
$body = ; // ShoppingCart | 
$id = id_example; // String | Identifier of the Shopping Cart

try {
    $result = $api_instance->patchShoppingCart($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShoppingCartApi->patchShoppingCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShoppingCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ShoppingCartApi->new();
my $body = WWW::SwaggerClient::Object::ShoppingCart->new(); # ShoppingCart | 
my $id = id_example; # String | Identifier of the Shopping Cart

eval { 
    my $result = $api_instance->patchShoppingCart(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShoppingCartApi->patchShoppingCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ShoppingCartApi()
body =  # ShoppingCart | 
id = id_example # String | Identifier of the Shopping Cart

try: 
    # Updates partially a 'ShoppingCart' by Id
    api_response = api_instance.patch_shopping_cart(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShoppingCartApi->patchShoppingCart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Shopping Cart
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


retrieveShoppingCart

Retrieves a 'ShoppingCart' by Id

This operation retrieves a shopping cart entity using its unique ID.


/shoppingCart/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/shoppingCart/{id}?baseSiteId=&fields=&relatedParty.Id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShoppingCartApi;

import java.io.File;
import java.util.*;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ShoppingCartApi apiInstance = new ShoppingCartApi();
        String id = id_example; // String | Identifier of the Shopping Cart
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer
        try {
            array[ShoppingCart] result = apiInstance.retrieveShoppingCart(id, baseSiteId, fields, relatedParty.Id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#retrieveShoppingCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShoppingCartApi;

public class ShoppingCartApiExample {

    public static void main(String[] args) {
        ShoppingCartApi apiInstance = new ShoppingCartApi();
        String id = id_example; // String | Identifier of the Shopping Cart
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer
        try {
            array[ShoppingCart] result = apiInstance.retrieveShoppingCart(id, baseSiteId, fields, relatedParty.Id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShoppingCartApi#retrieveShoppingCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the Shopping Cart
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *relatedParty.Id = relatedParty.Id_example; // Identifier of the Customer (optional)

ShoppingCartApi *apiInstance = [[ShoppingCartApi alloc] init];

// Retrieves a 'ShoppingCart' by Id
[apiInstance retrieveShoppingCartWith:id
    baseSiteId:baseSiteId
    fields:fields
    relatedParty.Id:relatedParty.Id
              completionHandler: ^(array[ShoppingCart] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.ShoppingCartApi()
var id = id_example; // {{String}} Identifier of the Shopping Cart
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'relatedParty.Id': relatedParty.Id_example // {{String}} Identifier of the Customer
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveShoppingCart(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveShoppingCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShoppingCartApi();
            var id = id_example;  // String | Identifier of the Shopping Cart
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var relatedParty.Id = relatedParty.Id_example;  // String | Identifier of the Customer (optional) 

            try
            {
                // Retrieves a 'ShoppingCart' by Id
                array[ShoppingCart] result = apiInstance.retrieveShoppingCart(id, baseSiteId, fields, relatedParty.Id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShoppingCartApi.retrieveShoppingCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiShoppingCartApi();
$id = id_example; // String | Identifier of the Shopping Cart
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$relatedParty.Id = relatedParty.Id_example; // String | Identifier of the Customer

try {
    $result = $api_instance->retrieveShoppingCart($id, $baseSiteId, $fields, $relatedParty.Id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShoppingCartApi->retrieveShoppingCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShoppingCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ShoppingCartApi->new();
my $id = id_example; # String | Identifier of the Shopping Cart
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $relatedParty.Id = relatedParty.Id_example; # String | Identifier of the Customer

eval { 
    my $result = $api_instance->retrieveShoppingCart(id => $id, baseSiteId => $baseSiteId, fields => $fields, relatedParty.Id => $relatedParty.Id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShoppingCartApi->retrieveShoppingCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ShoppingCartApi()
id = id_example # String | Identifier of the Shopping Cart
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
relatedParty.Id = relatedParty.Id_example # String | Identifier of the Customer (optional)

try: 
    # Retrieves a 'ShoppingCart' by Id
    api_response = api_instance.retrieve_shopping_cart(id, baseSiteId=baseSiteId, fields=fields, relatedParty.Id=relatedParty.Id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShoppingCartApi->retrieveShoppingCart: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Shopping Cart
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Response configuration. This is the list of fields that should be returned in the response body
relatedParty.Id
String
Identifier of the Customer

Responses

Status: 200 - Ok

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


Subscription

findSubscriptionbaseForId

get Subscriptionbase for given Id

This operation get Subscriptionbase entity. Attribute selection is enabled for all first level attributes. Filtering may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity


/subscriptionbase/{subscriptionBaseId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/subscriptionbase/{subscriptionBaseId}?baseSiteId=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubscriptionApi;

import java.io.File;
import java.util.*;

public class SubscriptionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SubscriptionApi apiInstance = new SubscriptionApi();
        String subscriptionBaseId = subscriptionBaseId_example; // String | Id for subscriptionBase selection
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attributes selection
        try {
            Object result = apiInstance.findSubscriptionbaseForId(subscriptionBaseId, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionApi#findSubscriptionbaseForId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SubscriptionApi;

public class SubscriptionApiExample {

    public static void main(String[] args) {
        SubscriptionApi apiInstance = new SubscriptionApi();
        String subscriptionBaseId = subscriptionBaseId_example; // String | Id for subscriptionBase selection
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attributes selection
        try {
            Object result = apiInstance.findSubscriptionbaseForId(subscriptionBaseId, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionApi#findSubscriptionbaseForId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *subscriptionBaseId = subscriptionBaseId_example; // Id for subscriptionBase selection
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Attributes selection (optional)

SubscriptionApi *apiInstance = [[SubscriptionApi alloc] init];

// get Subscriptionbase for given Id
[apiInstance findSubscriptionbaseForIdWith:subscriptionBaseId
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.SubscriptionApi()
var subscriptionBaseId = subscriptionBaseId_example; // {{String}} Id for subscriptionBase selection
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example // {{String}} Attributes selection
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findSubscriptionbaseForId(subscriptionBaseId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findSubscriptionbaseForIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi();
            var subscriptionBaseId = subscriptionBaseId_example;  // String | Id for subscriptionBase selection
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Attributes selection (optional) 

            try
            {
                // get Subscriptionbase for given Id
                Object result = apiInstance.findSubscriptionbaseForId(subscriptionBaseId, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubscriptionApi.findSubscriptionbaseForId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSubscriptionApi();
$subscriptionBaseId = subscriptionBaseId_example; // String | Id for subscriptionBase selection
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Attributes selection

try {
    $result = $api_instance->findSubscriptionbaseForId($subscriptionBaseId, $baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionApi->findSubscriptionbaseForId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubscriptionApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SubscriptionApi->new();
my $subscriptionBaseId = subscriptionBaseId_example; # String | Id for subscriptionBase selection
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Attributes selection

eval { 
    my $result = $api_instance->findSubscriptionbaseForId(subscriptionBaseId => $subscriptionBaseId, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionApi->findSubscriptionbaseForId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SubscriptionApi()
subscriptionBaseId = subscriptionBaseId_example # String | Id for subscriptionBase selection
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Attributes selection (optional)

try: 
    # get Subscriptionbase for given Id
    api_response = api_instance.find_subscriptionbase_for_id(subscriptionBaseId, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->findSubscriptionbaseForId: %s\n" % e)

Parameters

Path parameters
Name Description
subscriptionBaseId*
String
Id for subscriptionBase selection
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Attributes selection

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 405 - Method Not Allowed List of supported error codes: - 61: Method not allowed

Status: 409 - Conflict The request could not be completed due to a conflict with the current state of the target resource.

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error


UsageConsumptionReport

usageConsumptionReportFind

Query the calculation of an usage consumption report in synchronous mode

This operation is used to request the calculation of a new usage consumption report for a specific product identified by a msisdn number for example. Attribute selection is enabled for all first level attributes. Filtering may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity


/usageConsumptionReport

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v2/usageConsumptionReport?baseSiteId=&fields=&product.id=&subscriptionBase.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsageConsumptionReportApi;

import java.io.File;
import java.util.*;

public class UsageConsumptionReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        UsageConsumptionReportApi apiInstance = new UsageConsumptionReportApi();
        String subscriptionBase.id = subscriptionBase.id_example; // String | SubscriberIdentity contains Id of subcriptionbase
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attribute selection
        String product.id = product.id_example; // String | Susbcribed Product ID
        try {
            Object result = apiInstance.usageConsumptionReportFind(subscriptionBase.id, baseSiteId, fields, product.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsageConsumptionReportApi#usageConsumptionReportFind");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsageConsumptionReportApi;

public class UsageConsumptionReportApiExample {

    public static void main(String[] args) {
        UsageConsumptionReportApi apiInstance = new UsageConsumptionReportApi();
        String subscriptionBase.id = subscriptionBase.id_example; // String | SubscriberIdentity contains Id of subcriptionbase
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Attribute selection
        String product.id = product.id_example; // String | Susbcribed Product ID
        try {
            Object result = apiInstance.usageConsumptionReportFind(subscriptionBase.id, baseSiteId, fields, product.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsageConsumptionReportApi#usageConsumptionReportFind");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *subscriptionBase.id = subscriptionBase.id_example; // SubscriberIdentity contains Id of subcriptionbase
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Attribute selection (optional)
String *product.id = product.id_example; // Susbcribed Product ID (optional)

UsageConsumptionReportApi *apiInstance = [[UsageConsumptionReportApi alloc] init];

// Query the calculation of an usage consumption report in synchronous mode
[apiInstance usageConsumptionReportFindWith:subscriptionBase.id
    baseSiteId:baseSiteId
    fields:fields
    product.id:product.id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var B2ctelcoTmfWebservices = require('b2ctelco_tmf_webservices');
var defaultClient = B2ctelcoTmfWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new B2ctelcoTmfWebservices.UsageConsumptionReportApi()
var subscriptionBase.id = subscriptionBase.id_example; // {{String}} SubscriberIdentity contains Id of subcriptionbase
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Attribute selection
  'product.id': product.id_example // {{String}} Susbcribed Product ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usageConsumptionReportFind(subscriptionBase.id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class usageConsumptionReportFindExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UsageConsumptionReportApi();
            var subscriptionBase.id = subscriptionBase.id_example;  // String | SubscriberIdentity contains Id of subcriptionbase
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Attribute selection (optional) 
            var product.id = product.id_example;  // String | Susbcribed Product ID (optional) 

            try
            {
                // Query the calculation of an usage consumption report in synchronous mode
                Object result = apiInstance.usageConsumptionReportFind(subscriptionBase.id, baseSiteId, fields, product.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsageConsumptionReportApi.usageConsumptionReportFind: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUsageConsumptionReportApi();
$subscriptionBase.id = subscriptionBase.id_example; // String | SubscriberIdentity contains Id of subcriptionbase
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Attribute selection
$product.id = product.id_example; // String | Susbcribed Product ID

try {
    $result = $api_instance->usageConsumptionReportFind($subscriptionBase.id, $baseSiteId, $fields, $product.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsageConsumptionReportApi->usageConsumptionReportFind: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsageConsumptionReportApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UsageConsumptionReportApi->new();
my $subscriptionBase.id = subscriptionBase.id_example; # String | SubscriberIdentity contains Id of subcriptionbase
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Attribute selection
my $product.id = product.id_example; # String | Susbcribed Product ID

eval { 
    my $result = $api_instance->usageConsumptionReportFind(subscriptionBase.id => $subscriptionBase.id, baseSiteId => $baseSiteId, fields => $fields, product.id => $product.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsageConsumptionReportApi->usageConsumptionReportFind: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UsageConsumptionReportApi()
subscriptionBase.id = subscriptionBase.id_example # String | SubscriberIdentity contains Id of subcriptionbase
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Attribute selection (optional)
product.id = product.id_example # String | Susbcribed Product ID (optional)

try: 
    # Query the calculation of an usage consumption report in synchronous mode
    api_response = api_instance.usage_consumption_report_find(subscriptionBase.id, baseSiteId=baseSiteId, fields=fields, product.id=product.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsageConsumptionReportApi->usageConsumptionReportFind: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Attribute selection
product.id
String
Susbcribed Product ID
subscriptionBase.id*
String
SubscriberIdentity contains Id of subcriptionbase
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found List of supported error codes: - 60: Resource not found

Status: 405 - Method Not Allowed List of supported error codes: - 61: Method not allowed

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error List of supported error codes: - 1: Internal error