B2ctelco Tmf Webservices

GeographicAddressManagement

createGeographicAddressValidation

Creates a GeographicAddressValidation

This operation creates a GeographicAddressValidation entity.


/geographicAddressValidation

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json;charset=utf-8,application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/geographicAddressValidation?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();
        GeographicAddressValidation body = ; // GeographicAddressValidation | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            GeographicAddressValidation result = apiInstance.createGeographicAddressValidation(body, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#createGeographicAddressValidation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        GeographicAddressValidation body = ; // GeographicAddressValidation | 
        String relatedParty.id = relatedParty.id_example; // String | The id of the related party.
        try {
            GeographicAddressValidation result = apiInstance.createGeographicAddressValidation(body, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#createGeographicAddressValidation");
            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"];
GeographicAddressValidation *body = ; // 
String *relatedParty.id = relatedParty.id_example; // The id of the related party. (optional)

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

// Creates a GeographicAddressValidation
[apiInstance createGeographicAddressValidationWith:body
    relatedParty.id:relatedParty.id
              completionHandler: ^(GeographicAddressValidation 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 = ; // {{GeographicAddressValidation}} 
var opts = { 
  '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.createGeographicAddressValidation(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createGeographicAddressValidationExample
    {
        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 GeographicAddressValidation(); // GeographicAddressValidation | 
            var relatedParty.id = relatedParty.id_example;  // String | The id of the related party. (optional) 

            try
            {
                // Creates a GeographicAddressValidation
                GeographicAddressValidation result = apiInstance.createGeographicAddressValidation(body, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.createGeographicAddressValidation: " + 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 = ; // GeographicAddressValidation | 
$relatedParty.id = relatedParty.id_example; // String | The id of the related party.

try {
    $result = $api_instance->createGeographicAddressValidation($body, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->createGeographicAddressValidation: ', $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::GeographicAddressValidation->new(); # GeographicAddressValidation | 
my $relatedParty.id = relatedParty.id_example; # String | The id of the related party.

eval { 
    my $result = $api_instance->createGeographicAddressValidation(body => $body, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->createGeographicAddressValidation: $@\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 =  # GeographicAddressValidation | 
relatedParty.id = relatedParty.id_example # String | The id of the related party. (optional)

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

Parameters

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

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


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,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

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

Status: 409 - Conflict

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error


listGeographicAddressValidation

List or find GeographicAddressValidation objects

This operation list or find GeographicAddressValidation entities


/geographicAddressValidation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/geographicAddressValidation?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 fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicAddressValidation] result = apiInstance.listGeographicAddressValidation(fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicAddressValidation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicAddressValidation] result = apiInstance.listGeographicAddressValidation(fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicAddressValidation");
            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 be provided 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; // Id of a specific party role for which the addresses should be provided (optional)

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

// List or find GeographicAddressValidation objects
[apiInstance listGeographicAddressValidationWith:fields
    limit:limit
    offset:offset
    relatedParty.id:relatedParty.id
              completionHandler: ^(array[GeographicAddressValidation] 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 = { 
  'fields': fields_example, // {{String}} Comma-separated properties to be provided 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}} 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.listGeographicAddressValidation(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listGeographicAddressValidationExample
    {
        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 fields = fields_example;  // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided (optional) 

            try
            {
                // List or find GeographicAddressValidation objects
                array[GeographicAddressValidation] result = apiInstance.listGeographicAddressValidation(fields, limit, offset, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.listGeographicAddressValidation: " + 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();
$fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->listGeographicAddressValidation($fields, $limit, $offset, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->listGeographicAddressValidation: ', $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 $fields = fields_example; # String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided

eval { 
    my $result = $api_instance->listGeographicAddressValidation(fields => $fields, limit => $limit, offset => $offset, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->listGeographicAddressValidation: $@\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()
fields = fields_example # String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # List or find GeographicAddressValidation objects
    api_response = api_instance.list_geographic_address_validation(fields=fields, limit=limit, offset=offset, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->listGeographicAddressValidation: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Comma-separated properties to be provided 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
Id of a specific party role for which the addresses should be provided

Responses

Status: 200 - Success

Status: 206 - Partial

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


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,application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/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
        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
        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
        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
        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)
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)
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': 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
  '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 = 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) 
            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 = 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
$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 = 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
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 = 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)
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
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
relatedParty.id
String
Id of a specific party role for which the addresses should be provided

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

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

Status: 409 - Conflict

Status: 422 - Unprocessable entity Functional error

Status: 500 - Internal Server Error


listGeographicSubAddress

List or find GeographicSubAddress objects

This operation list or find GeographicSubAddress entities


/geographicAddress/{geographicAddressId}/geographicSubAddress

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/geographicAddress/{geographicAddressId}/geographicSubAddress?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 geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
        String fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicSubAddress] result = apiInstance.listGeographicSubAddress(geographicAddressId, fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicSubAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
        String fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided
        try {
            array[GeographicSubAddress] result = apiInstance.listGeographicSubAddress(geographicAddressId, fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#listGeographicSubAddress");
            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 *geographicAddressId = geographicAddressId_example; // Identifier of the parent GeographicAddress entity
String *fields = fields_example; // Comma-separated properties to be provided 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; // Id of a specific party role for which the addresses should be provided (optional)

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

// List or find GeographicSubAddress objects
[apiInstance listGeographicSubAddressWith:geographicAddressId
    fields:fields
    limit:limit
    offset:offset
    relatedParty.id:relatedParty.id
              completionHandler: ^(array[GeographicSubAddress] 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 geographicAddressId = geographicAddressId_example; // {{String}} Identifier of the parent GeographicAddress entity
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to be provided 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}} 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.listGeographicSubAddress(geographicAddressId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listGeographicSubAddressExample
    {
        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 geographicAddressId = geographicAddressId_example;  // String | Identifier of the parent GeographicAddress entity
            var fields = fields_example;  // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided (optional) 

            try
            {
                // List or find GeographicSubAddress objects
                array[GeographicSubAddress] result = apiInstance.listGeographicSubAddress(geographicAddressId, fields, limit, offset, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.listGeographicSubAddress: " + 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();
$geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
$fields = fields_example; // String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->listGeographicSubAddress($geographicAddressId, $fields, $limit, $offset, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->listGeographicSubAddress: ', $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 $geographicAddressId = geographicAddressId_example; # String | Identifier of the parent GeographicAddress entity
my $fields = fields_example; # String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided

eval { 
    my $result = $api_instance->listGeographicSubAddress(geographicAddressId => $geographicAddressId, fields => $fields, limit => $limit, offset => $offset, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->listGeographicSubAddress: $@\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()
geographicAddressId = geographicAddressId_example # String | Identifier of the parent GeographicAddress entity
fields = fields_example # String | Comma-separated properties to be provided 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 | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # List or find GeographicSubAddress objects
    api_response = api_instance.list_geographic_sub_address(geographicAddressId, fields=fields, limit=limit, offset=offset, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->listGeographicSubAddress: %s\n" % e)

Parameters

Path parameters
Name Description
geographicAddressId*
String
Identifier of the parent GeographicAddress entity
Required
Query parameters
Name Description
fields
String
Comma-separated properties to be provided 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
Id of a specific party role for which the addresses should be provided

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


retrieveGeographicAddressValidation

Retrieves a GeographicAddressValidation by ID

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


/geographicAddressValidation/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/geographicAddressValidation/{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 GeographicAddressValidation
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicAddressValidation result = apiInstance.retrieveGeographicAddressValidation(id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#retrieveGeographicAddressValidation");
            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 GeographicAddressValidation
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicAddressValidation result = apiInstance.retrieveGeographicAddressValidation(id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#retrieveGeographicAddressValidation");
            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 GeographicAddressValidation
String *fields = fields_example; // Comma-separated properties to provide in response (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 GeographicAddressValidation by ID
[apiInstance retrieveGeographicAddressValidationWith:id
    fields:fields
    relatedParty.id:relatedParty.id
              completionHandler: ^(GeographicAddressValidation 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 GeographicAddressValidation
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to provide in response
  '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.retrieveGeographicAddressValidation(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveGeographicAddressValidationExample
    {
        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 GeographicAddressValidation
            var fields = fields_example;  // String | Comma-separated properties to provide in response (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 GeographicAddressValidation by ID
                GeographicAddressValidation result = apiInstance.retrieveGeographicAddressValidation(id, fields, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.retrieveGeographicAddressValidation: " + 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 GeographicAddressValidation
$fields = fields_example; // String | Comma-separated properties to provide in response
$relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->retrieveGeographicAddressValidation($id, $fields, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->retrieveGeographicAddressValidation: ', $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 GeographicAddressValidation
my $fields = fields_example; # String | Comma-separated properties to provide in response
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->retrieveGeographicAddressValidation(id => $id, fields => $fields, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->retrieveGeographicAddressValidation: $@\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 GeographicAddressValidation
fields = fields_example # String | Comma-separated properties to provide in response (optional)
relatedParty.id = relatedParty.id_example # String | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # Retrieves a GeographicAddressValidation by ID
    api_response = api_instance.retrieve_geographic_address_validation(id, fields=fields, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->retrieveGeographicAddressValidation: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the GeographicAddressValidation
Required
Query parameters
Name Description
fields
String
Comma-separated properties to provide in response
relatedParty.id
String
Id of a specific party role for which the addresses should be provided

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


retrieveGeographicSubAddress

Retrieves a GeographicSubAddress by ID

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


/geographicAddress/{geographicAddressId}/geographicSubAddress/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/geographicAddress/{geographicAddressId}/geographicSubAddress/{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 geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
        String id = id_example; // String | Identifier of the GeographicSubAddress
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicSubAddress result = apiInstance.retrieveGeographicSubAddress(geographicAddressId, id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#retrieveGeographicSubAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GeographicAddressManagementApi;

public class GeographicAddressManagementApiExample {

    public static void main(String[] args) {
        GeographicAddressManagementApi apiInstance = new GeographicAddressManagementApi();
        String geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
        String id = id_example; // String | Identifier of the GeographicSubAddress
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided
        try {
            GeographicSubAddress result = apiInstance.retrieveGeographicSubAddress(geographicAddressId, id, fields, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeographicAddressManagementApi#retrieveGeographicSubAddress");
            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 *geographicAddressId = geographicAddressId_example; // Identifier of the parent GeographicAddress entity
String *id = id_example; // Identifier of the GeographicSubAddress
String *fields = fields_example; // Comma-separated properties to provide in response (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 GeographicSubAddress by ID
[apiInstance retrieveGeographicSubAddressWith:geographicAddressId
    id:id
    fields:fields
    relatedParty.id:relatedParty.id
              completionHandler: ^(GeographicSubAddress 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 geographicAddressId = geographicAddressId_example; // {{String}} Identifier of the parent GeographicAddress entity
var id = id_example; // {{String}} Identifier of the GeographicSubAddress
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to provide in response
  '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.retrieveGeographicSubAddress(geographicAddressId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveGeographicSubAddressExample
    {
        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 geographicAddressId = geographicAddressId_example;  // String | Identifier of the parent GeographicAddress entity
            var id = id_example;  // String | Identifier of the GeographicSubAddress
            var fields = fields_example;  // String | Comma-separated properties to provide in response (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 GeographicSubAddress by ID
                GeographicSubAddress result = apiInstance.retrieveGeographicSubAddress(geographicAddressId, id, fields, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeographicAddressManagementApi.retrieveGeographicSubAddress: " + 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();
$geographicAddressId = geographicAddressId_example; // String | Identifier of the parent GeographicAddress entity
$id = id_example; // String | Identifier of the GeographicSubAddress
$fields = fields_example; // String | Comma-separated properties to provide in response
$relatedParty.id = relatedParty.id_example; // String | Id of a specific party role for which the addresses should be provided

try {
    $result = $api_instance->retrieveGeographicSubAddress($geographicAddressId, $id, $fields, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeographicAddressManagementApi->retrieveGeographicSubAddress: ', $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 $geographicAddressId = geographicAddressId_example; # String | Identifier of the parent GeographicAddress entity
my $id = id_example; # String | Identifier of the GeographicSubAddress
my $fields = fields_example; # String | Comma-separated properties to provide in response
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->retrieveGeographicSubAddress(geographicAddressId => $geographicAddressId, id => $id, fields => $fields, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeographicAddressManagementApi->retrieveGeographicSubAddress: $@\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()
geographicAddressId = geographicAddressId_example # String | Identifier of the parent GeographicAddress entity
id = id_example # String | Identifier of the GeographicSubAddress
fields = fields_example # String | Comma-separated properties to provide in response (optional)
relatedParty.id = relatedParty.id_example # String | Id of a specific party role for which the addresses should be provided (optional)

try: 
    # Retrieves a GeographicSubAddress by ID
    api_response = api_instance.retrieve_geographic_sub_address(geographicAddressId, id, fields=fields, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeographicAddressManagementApi->retrieveGeographicSubAddress: %s\n" % e)

Parameters

Path parameters
Name Description
geographicAddressId*
String
Identifier of the parent GeographicAddress entity
Required
id*
String
Identifier of the GeographicSubAddress
Required
Query parameters
Name Description
fields
String
Comma-separated properties to provide in response
relatedParty.id
String
Id of a specific party role for which the addresses should be provided

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


ProductCatalogManagement

createProductOffering

Creates a ProductOffering

This operation creates a ProductOffering entity.


/productOffering

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/v3/productOffering?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductOffering body = ; // ProductOffering | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOffering result = apiInstance.createProductOffering(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductOffering body = ; // ProductOffering | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOffering result = apiInstance.createProductOffering(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductOffering");
            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"];
ProductOffering *body = ; // 
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Creates a ProductOffering
[apiInstance createProductOfferingWith:body
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              completionHandler: ^(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 body = ; // {{ProductOffering}} 
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProductOffering(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProductOfferingExample
    {
        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 body = new ProductOffering(); // ProductOffering | 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Creates a ProductOffering
                ProductOffering result = apiInstance.createProductOffering(body, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.createProductOffering: " + 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();
$body = ; // ProductOffering | 
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->createProductOffering($body, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->createProductOffering: ', $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 $body = WWW::SwaggerClient::Object::ProductOffering->new(); # ProductOffering | 
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->createProductOffering(body => $body, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->createProductOffering: $@\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()
body =  # ProductOffering | 
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Creates a ProductOffering
    api_response = api_instance.create_product_offering(body, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->createProductOffering: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


createProductOfferingPrice

Creates a ProductOfferingPrice

This operation creates a ProductOfferingPrice entity.


/productOfferingPrice

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/v3/productOfferingPrice?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductOfferingPrice body = ; // ProductOfferingPrice | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOfferingPrice result = apiInstance.createProductOfferingPrice(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductOfferingPrice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductOfferingPrice body = ; // ProductOfferingPrice | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOfferingPrice result = apiInstance.createProductOfferingPrice(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductOfferingPrice");
            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"];
ProductOfferingPrice *body = ; // 
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Creates a ProductOfferingPrice
[apiInstance createProductOfferingPriceWith:body
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              completionHandler: ^(ProductOfferingPrice 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 body = ; // {{ProductOfferingPrice}} 
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProductOfferingPrice(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProductOfferingPriceExample
    {
        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 body = new ProductOfferingPrice(); // ProductOfferingPrice | 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Creates a ProductOfferingPrice
                ProductOfferingPrice result = apiInstance.createProductOfferingPrice(body, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.createProductOfferingPrice: " + 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();
$body = ; // ProductOfferingPrice | 
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->createProductOfferingPrice($body, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->createProductOfferingPrice: ', $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 $body = WWW::SwaggerClient::Object::ProductOfferingPrice->new(); # ProductOfferingPrice | 
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->createProductOfferingPrice(body => $body, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->createProductOfferingPrice: $@\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()
body =  # ProductOfferingPrice | 
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Creates a ProductOfferingPrice
    api_response = api_instance.create_product_offering_price(body, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->createProductOfferingPrice: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


createProductSpecification

Creates a ProductSpecification

This operation creates a ProductSpecification entity.


/productSpecification

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/v3/productSpecification?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductSpecification body = ; // ProductSpecification | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductSpecification result = apiInstance.createProductSpecification(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductSpecification body = ; // ProductSpecification | 
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductSpecification result = apiInstance.createProductSpecification(body, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#createProductSpecification");
            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"];
ProductSpecification *body = ; // 
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Creates a ProductSpecification
[apiInstance createProductSpecificationWith:body
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              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 body = ; // {{ProductSpecification}} 
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProductSpecification(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProductSpecificationExample
    {
        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 body = new ProductSpecification(); // ProductSpecification | 
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Creates a ProductSpecification
                ProductSpecification result = apiInstance.createProductSpecification(body, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.createProductSpecification: " + 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();
$body = ; // ProductSpecification | 
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->createProductSpecification($body, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->createProductSpecification: ', $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 $body = WWW::SwaggerClient::Object::ProductSpecification->new(); # ProductSpecification | 
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->createProductSpecification(body => $body, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->createProductSpecification: $@\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()
body =  # ProductSpecification | 
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Creates a ProductSpecification
    api_response = api_instance.create_product_specification(body, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->createProductSpecification: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


deleteProductOffering

Deletes a ProductOffering

This operation deletes a ProductOffering entity.


/productOffering/{id}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOffering/{id}?baseSiteId=&catalogId=&catalogVersion="
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 ProductOffering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version o the catalog
        try {
            apiInstance.deleteProductOffering(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductOffering");
            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 ProductOffering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version o the catalog
        try {
            apiInstance.deleteProductOffering(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductOffering");
            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 ProductOffering
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version o the catalog (optional)

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

// Deletes a ProductOffering
[apiInstance deleteProductOfferingWith:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              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.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the ProductOffering
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version o the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProductOffering(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProductOfferingExample
    {
        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 ProductOffering
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version o the catalog (optional) 

            try
            {
                // Deletes a ProductOffering
                apiInstance.deleteProductOffering(id, baseSiteId, catalogId, catalogVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.deleteProductOffering: " + 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 ProductOffering
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version o the catalog

try {
    $api_instance->deleteProductOffering($id, $baseSiteId, $catalogId, $catalogVersion);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->deleteProductOffering: ', $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 ProductOffering
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version o the catalog

eval { 
    $api_instance->deleteProductOffering(id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->deleteProductOffering: $@\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 ProductOffering
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version o the catalog (optional)

try: 
    # Deletes a ProductOffering
    api_instance.delete_product_offering(id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->deleteProductOffering: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOffering
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version o the catalog

Responses

Status: 204 - Deleted

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


deleteProductOfferingPrice

Deletes a ProductOfferingPrice

This operation deletes a ProductOfferingPrice entity.


/productOfferingPrice/{id}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOfferingPrice/{id}?baseSiteId=&catalogId=&catalogVersion="
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 ProductOfferingPrice
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            apiInstance.deleteProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductOfferingPrice");
            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 ProductOfferingPrice
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            apiInstance.deleteProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductOfferingPrice");
            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 ProductOfferingPrice
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Deletes a ProductOfferingPrice
[apiInstance deleteProductOfferingPriceWith:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              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.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the ProductOfferingPrice
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProductOfferingPrice(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProductOfferingPriceExample
    {
        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 ProductOfferingPrice
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Deletes a ProductOfferingPrice
                apiInstance.deleteProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.deleteProductOfferingPrice: " + 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 ProductOfferingPrice
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $api_instance->deleteProductOfferingPrice($id, $baseSiteId, $catalogId, $catalogVersion);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->deleteProductOfferingPrice: ', $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 ProductOfferingPrice
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    $api_instance->deleteProductOfferingPrice(id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->deleteProductOfferingPrice: $@\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 ProductOfferingPrice
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Deletes a ProductOfferingPrice
    api_instance.delete_product_offering_price(id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->deleteProductOfferingPrice: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOfferingPrice
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

Responses

Status: 204 - Deleted

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


deleteProductSpecification

Deletes a ProductSpecification

This operation deletes a ProductSpecification entity.


/productSpecification/{id}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productSpecification/{id}?baseSiteId=&catalogId=&catalogVersion="
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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            apiInstance.deleteProductSpecification(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductSpecification");
            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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            apiInstance.deleteProductSpecification(id, baseSiteId, catalogId, catalogVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#deleteProductSpecification");
            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 *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Deletes a ProductSpecification
[apiInstance deleteProductSpecificationWith:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              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.ProductCatalogManagementApi()
var id = id_example; // {{String}} Identifier of the ProductSpecification
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProductSpecification(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProductSpecificationExample
    {
        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 catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Deletes a ProductSpecification
                apiInstance.deleteProductSpecification(id, baseSiteId, catalogId, catalogVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.deleteProductSpecification: " + 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
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $api_instance->deleteProductSpecification($id, $baseSiteId, $catalogId, $catalogVersion);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->deleteProductSpecification: ', $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 $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    $api_instance->deleteProductSpecification(id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->deleteProductSpecification: $@\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)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Deletes a ProductSpecification
    api_instance.delete_product_specification(id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->deleteProductSpecification: %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
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

Responses

Status: 204 - Deleted

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


listProductOffering

Retrieves a list of 'ProductOffering'

This operation retrieves a list of product offering entities


/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/v3/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).
        String lastUpdate = lastUpdate_example; // String | 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).
        String lastUpdate = lastUpdate_example; // String | 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)
String *lastUpdate = lastUpdate_example; // 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': lastUpdate_example, // {{String}} 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 = lastUpdate_example;  // String | 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 = lastUpdate_example; // String | 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 = lastUpdate_example; # String | 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 = lastUpdate_example # String | 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
String
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


listProductOfferingPrice

List or find ProductOfferingPrice objects

This operation list or find ProductOfferingPrice entities


/productOfferingPrice

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOfferingPrice?baseSiteId=&catalogId=&catalogVersion=&fields=&isBundle=&lastUpdate=&lifecycleStatus=&limit=&name=&offset=&priceType="
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 baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Boolean isBundle = true; // Boolean | For filtering to get only the product offering prices that are composite(true) or component(false)
        String lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        String name = name_example; // String | Name of the Product Offering Price
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String priceType = priceType_example; // String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc)
        try {
            array[ProductOfferingPrice] result = apiInstance.listProductOfferingPrice(baseSiteId, catalogId, catalogVersion, fields, isBundle, lastUpdate, lifecycleStatus, limit, name, offset, priceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductOfferingPrice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Boolean isBundle = true; // Boolean | For filtering to get only the product offering prices that are composite(true) or component(false)
        String lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        String name = name_example; // String | Name of the Product Offering Price
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String priceType = priceType_example; // String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc)
        try {
            array[ProductOfferingPrice] result = apiInstance.listProductOfferingPrice(baseSiteId, catalogId, catalogVersion, fields, isBundle, lastUpdate, lifecycleStatus, limit, name, offset, priceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductOfferingPrice");
            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 *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)
String *fields = fields_example; // Comma-separated properties to be provided in response (optional)
Boolean *isBundle = true; // For filtering to get only the product offering prices that are composite(true) or component(false) (optional)
String *lastUpdate = lastUpdate_example; // For filtering: Date and time of the last update (optional)
String *lifecycleStatus = lifecycleStatus_example; // Used to indicate the current lifecycle status (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
String *name = name_example; // Name of the Product Offering Price (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *priceType = priceType_example; // For filtering to get only the product offering prices with a given price type(recurring, usage, etc) (optional)

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

// List or find ProductOfferingPrice objects
[apiInstance listProductOfferingPriceWith:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
    fields:fields
    isBundle:isBundle
    lastUpdate:lastUpdate
    lifecycleStatus:lifecycleStatus
    limit:limit
    name:name
    offset:offset
    priceType:priceType
              completionHandler: ^(array[ProductOfferingPrice] 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 = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example, // {{String}} Version of the catalog
  'fields': fields_example, // {{String}} Comma-separated properties to be provided in response
  'isBundle': true, // {{Boolean}} For filtering to get only the product offering prices that are composite(true) or component(false)
  'lastUpdate': lastUpdate_example, // {{String}} For filtering: Date and time of the last update
  'lifecycleStatus': lifecycleStatus_example, // {{String}} Used to indicate the current lifecycle status
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'name': name_example, // {{String}} Name of the Product Offering Price
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'priceType': priceType_example // {{String}} For filtering to get only the product offering prices with a given price type(recurring, usage, etc)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProductOfferingPrice(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductOfferingPriceExample
    {
        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 baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 
            var fields = fields_example;  // String | Comma-separated properties to be provided in response (optional) 
            var isBundle = true;  // Boolean | For filtering to get only the product offering prices that are composite(true) or component(false) (optional) 
            var lastUpdate = lastUpdate_example;  // String | For filtering: Date and time of the last update (optional) 
            var lifecycleStatus = lifecycleStatus_example;  // String | Used to indicate the current lifecycle status (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var name = name_example;  // String | Name of the Product Offering Price (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var priceType = priceType_example;  // String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc) (optional) 

            try
            {
                // List or find ProductOfferingPrice objects
                array[ProductOfferingPrice] result = apiInstance.listProductOfferingPrice(baseSiteId, catalogId, catalogVersion, fields, isBundle, lastUpdate, lifecycleStatus, limit, name, offset, priceType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.listProductOfferingPrice: " + 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();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog
$fields = fields_example; // String | Comma-separated properties to be provided in response
$isBundle = true; // Boolean | For filtering to get only the product offering prices that are composite(true) or component(false)
$lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
$lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
$limit = 56; // Integer | Requested number of resources to be provided in response
$name = name_example; // String | Name of the Product Offering Price
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$priceType = priceType_example; // String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc)

try {
    $result = $api_instance->listProductOfferingPrice($baseSiteId, $catalogId, $catalogVersion, $fields, $isBundle, $lastUpdate, $lifecycleStatus, $limit, $name, $offset, $priceType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->listProductOfferingPrice: ', $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 $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog
my $fields = fields_example; # String | Comma-separated properties to be provided in response
my $isBundle = true; # Boolean | For filtering to get only the product offering prices that are composite(true) or component(false)
my $lastUpdate = lastUpdate_example; # String | For filtering: Date and time of the last update
my $lifecycleStatus = lifecycleStatus_example; # String | Used to indicate the current lifecycle status
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $name = name_example; # String | Name of the Product Offering Price
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $priceType = priceType_example; # String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc)

eval { 
    my $result = $api_instance->listProductOfferingPrice(baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion, fields => $fields, isBundle => $isBundle, lastUpdate => $lastUpdate, lifecycleStatus => $lifecycleStatus, limit => $limit, name => $name, offset => $offset, priceType => $priceType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->listProductOfferingPrice: $@\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()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)
fields = fields_example # String | Comma-separated properties to be provided in response (optional)
isBundle = true # Boolean | For filtering to get only the product offering prices that are composite(true) or component(false) (optional)
lastUpdate = lastUpdate_example # String | For filtering: Date and time of the last update (optional)
lifecycleStatus = lifecycleStatus_example # String | Used to indicate the current lifecycle status (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
name = name_example # String | Name of the Product Offering Price (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
priceType = priceType_example # String | For filtering to get only the product offering prices with a given price type(recurring, usage, etc) (optional)

try: 
    # List or find ProductOfferingPrice objects
    api_response = api_instance.list_product_offering_price(baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion, fields=fields, isBundle=isBundle, lastUpdate=lastUpdate, lifecycleStatus=lifecycleStatus, limit=limit, name=name, offset=offset, priceType=priceType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->listProductOfferingPrice: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog
fields
String
Comma-separated properties to be provided in response
isBundle
Boolean
For filtering to get only the product offering prices that are composite(true) or component(false)
lastUpdate
String
For filtering: Date and time of the last update
lifecycleStatus
String
Used to indicate the current lifecycle status
limit
Integer (int32)
Requested number of resources to be provided in response
name
String
Name of the Product Offering Price
offset
Integer (int32)
Requested index for start of resources to be provided in response
priceType
String
For filtering to get only the product offering prices with a given price type(recurring, usage, etc)

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


listProductSpecification

List or find ProductSpecification objects

This operation list or find ProductSpecification entities


/productSpecification

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productSpecification?baseSiteId=&catalogId=&catalogVersion=&fields=&lastUpdate=&lifecycleStatus=&limit=&name=&offset=&productSpecCharacteristic.id=&productSpecCharacteristic.name=&productSpecType.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 baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        String lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        String name = name_example; // String | Name of the catalog
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        array[String] productSpecCharacteristic.id = ; // array[String] | For filtering by the productSpecCharacteristic Id.
        array[String] productSpecCharacteristic.name = ; // array[String] | For filtering by the productSpecCharacteristic Name.
        array[String] productSpecType.id = ; // array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc
        try {
            array[ProductSpecification] result = apiInstance.listProductSpecification(baseSiteId, catalogId, catalogVersion, fields, lastUpdate, lifecycleStatus, limit, name, offset, productSpecCharacteristic.id, productSpecCharacteristic.name, productSpecType.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        String lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
        String lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        String name = name_example; // String | Name of the catalog
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        array[String] productSpecCharacteristic.id = ; // array[String] | For filtering by the productSpecCharacteristic Id.
        array[String] productSpecCharacteristic.name = ; // array[String] | For filtering by the productSpecCharacteristic Name.
        array[String] productSpecType.id = ; // array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc
        try {
            array[ProductSpecification] result = apiInstance.listProductSpecification(baseSiteId, catalogId, catalogVersion, fields, lastUpdate, lifecycleStatus, limit, name, offset, productSpecCharacteristic.id, productSpecCharacteristic.name, productSpecType.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#listProductSpecification");
            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 *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)
String *fields = fields_example; // Comma-separated properties to be provided in response (optional)
String *lastUpdate = lastUpdate_example; // For filtering: Date and time of the last update (optional)
String *lifecycleStatus = lifecycleStatus_example; // Used to indicate the current lifecycle status (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
String *name = name_example; // Name of the catalog (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
array[String] *productSpecCharacteristic.id = ; // For filtering by the productSpecCharacteristic Id. (optional)
array[String] *productSpecCharacteristic.name = ; // For filtering by the productSpecCharacteristic Name. (optional)
array[String] *productSpecType.id = ; // For filtering only the product specifications having the given type - can be internet, GSM, etc (optional)

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

// List or find ProductSpecification objects
[apiInstance listProductSpecificationWith:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
    fields:fields
    lastUpdate:lastUpdate
    lifecycleStatus:lifecycleStatus
    limit:limit
    name:name
    offset:offset
    productSpecCharacteristic.id:productSpecCharacteristic.id
    productSpecCharacteristic.name:productSpecCharacteristic.name
    productSpecType.id:productSpecType.id
              completionHandler: ^(array[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 opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example, // {{String}} Version of the catalog
  'fields': fields_example, // {{String}} Comma-separated properties to be provided in response
  'lastUpdate': lastUpdate_example, // {{String}} For filtering: Date and time of the last update
  'lifecycleStatus': lifecycleStatus_example, // {{String}} Used to indicate the current lifecycle status
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'name': name_example, // {{String}} Name of the catalog
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'productSpecCharacteristic.id': , // {{array[String]}} For filtering by the productSpecCharacteristic Id.
  'productSpecCharacteristic.name': , // {{array[String]}} For filtering by the productSpecCharacteristic Name.
  'productSpecType.id':  // {{array[String]}} For filtering only the product specifications having the given type - can be internet, GSM, etc
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProductSpecification(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductSpecificationExample
    {
        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 baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 
            var fields = fields_example;  // String | Comma-separated properties to be provided in response (optional) 
            var lastUpdate = lastUpdate_example;  // String | For filtering: Date and time of the last update (optional) 
            var lifecycleStatus = lifecycleStatus_example;  // String | Used to indicate the current lifecycle status (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var name = name_example;  // String | Name of the catalog (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var productSpecCharacteristic.id = new array[String](); // array[String] | For filtering by the productSpecCharacteristic Id. (optional) 
            var productSpecCharacteristic.name = new array[String](); // array[String] | For filtering by the productSpecCharacteristic Name. (optional) 
            var productSpecType.id = new array[String](); // array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc (optional) 

            try
            {
                // List or find ProductSpecification objects
                array[ProductSpecification] result = apiInstance.listProductSpecification(baseSiteId, catalogId, catalogVersion, fields, lastUpdate, lifecycleStatus, limit, name, offset, productSpecCharacteristic.id, productSpecCharacteristic.name, productSpecType.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.listProductSpecification: " + 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();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog
$fields = fields_example; // String | Comma-separated properties to be provided in response
$lastUpdate = lastUpdate_example; // String | For filtering: Date and time of the last update
$lifecycleStatus = lifecycleStatus_example; // String | Used to indicate the current lifecycle status
$limit = 56; // Integer | Requested number of resources to be provided in response
$name = name_example; // String | Name of the catalog
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$productSpecCharacteristic.id = ; // array[String] | For filtering by the productSpecCharacteristic Id.
$productSpecCharacteristic.name = ; // array[String] | For filtering by the productSpecCharacteristic Name.
$productSpecType.id = ; // array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc

try {
    $result = $api_instance->listProductSpecification($baseSiteId, $catalogId, $catalogVersion, $fields, $lastUpdate, $lifecycleStatus, $limit, $name, $offset, $productSpecCharacteristic.id, $productSpecCharacteristic.name, $productSpecType.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->listProductSpecification: ', $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 $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog
my $fields = fields_example; # String | Comma-separated properties to be provided in response
my $lastUpdate = lastUpdate_example; # String | For filtering: Date and time of the last update
my $lifecycleStatus = lifecycleStatus_example; # String | Used to indicate the current lifecycle status
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $name = name_example; # String | Name of the catalog
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $productSpecCharacteristic.id = []; # array[String] | For filtering by the productSpecCharacteristic Id.
my $productSpecCharacteristic.name = []; # array[String] | For filtering by the productSpecCharacteristic Name.
my $productSpecType.id = []; # array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc

eval { 
    my $result = $api_instance->listProductSpecification(baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion, fields => $fields, lastUpdate => $lastUpdate, lifecycleStatus => $lifecycleStatus, limit => $limit, name => $name, offset => $offset, productSpecCharacteristic.id => $productSpecCharacteristic.id, productSpecCharacteristic.name => $productSpecCharacteristic.name, productSpecType.id => $productSpecType.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->listProductSpecification: $@\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()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)
fields = fields_example # String | Comma-separated properties to be provided in response (optional)
lastUpdate = lastUpdate_example # String | For filtering: Date and time of the last update (optional)
lifecycleStatus = lifecycleStatus_example # String | Used to indicate the current lifecycle status (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
name = name_example # String | Name of the catalog (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
productSpecCharacteristic.id =  # array[String] | For filtering by the productSpecCharacteristic Id. (optional)
productSpecCharacteristic.name =  # array[String] | For filtering by the productSpecCharacteristic Name. (optional)
productSpecType.id =  # array[String] | For filtering only the product specifications having the given type - can be internet, GSM, etc (optional)

try: 
    # List or find ProductSpecification objects
    api_response = api_instance.list_product_specification(baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion, fields=fields, lastUpdate=lastUpdate, lifecycleStatus=lifecycleStatus, limit=limit, name=name, offset=offset, productSpecCharacteristic.id=productSpecCharacteristic.id, productSpecCharacteristic.name=productSpecCharacteristic.name, productSpecType.id=productSpecType.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->listProductSpecification: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog
fields
String
Comma-separated properties to be provided in response
lastUpdate
String
For filtering: Date and time of the last update
lifecycleStatus
String
Used to indicate the current lifecycle status
limit
Integer (int32)
Requested number of resources to be provided in response
name
String
Name of the catalog
offset
Integer (int32)
Requested index for start of resources to be provided in response
productSpecCharacteristic.id
array[String]
For filtering by the productSpecCharacteristic Id.
productSpecCharacteristic.name
array[String]
For filtering by the productSpecCharacteristic Name.
productSpecType.id
array[String]
For filtering only the product specifications having the given type - can be internet, GSM, etc

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


patchProductOffering

Updates partially a ProductOffering

This operation updates partially a ProductOffering entity.


/productOffering/{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/v3/productOffering/{id}?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductOffering body = ; // ProductOffering | 
        String id = id_example; // String | Identifier of the ProductOffering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOffering result = apiInstance.patchProductOffering(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductOffering body = ; // ProductOffering | 
        String id = id_example; // String | Identifier of the ProductOffering
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOffering result = apiInstance.patchProductOffering(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductOffering");
            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"];
ProductOffering *body = ; // 
String *id = id_example; // Identifier of the ProductOffering
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Updates partially a ProductOffering
[apiInstance patchProductOfferingWith:body
    id:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              completionHandler: ^(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 body = ; // {{ProductOffering}} 
var id = id_example; // {{String}} Identifier of the ProductOffering
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProductOffering(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProductOfferingExample
    {
        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 body = new ProductOffering(); // ProductOffering | 
            var id = id_example;  // String | Identifier of the ProductOffering
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Updates partially a ProductOffering
                ProductOffering result = apiInstance.patchProductOffering(body, id, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.patchProductOffering: " + 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();
$body = ; // ProductOffering | 
$id = id_example; // String | Identifier of the ProductOffering
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->patchProductOffering($body, $id, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->patchProductOffering: ', $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 $body = WWW::SwaggerClient::Object::ProductOffering->new(); # ProductOffering | 
my $id = id_example; # String | Identifier of the ProductOffering
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->patchProductOffering(body => $body, id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->patchProductOffering: $@\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()
body =  # ProductOffering | 
id = id_example # String | Identifier of the ProductOffering
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Updates partially a ProductOffering
    api_response = api_instance.patch_product_offering(body, id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->patchProductOffering: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOffering
Required
Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


patchProductOfferingPrice

Updates partially a ProductOfferingPrice

This operation updates partially a ProductOfferingPrice entity.


/productOfferingPrice/{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/v3/productOfferingPrice/{id}?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductOfferingPrice body = ; // ProductOfferingPrice | 
        String id = id_example; // String | Identifier of the ProductOfferingPrice
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOfferingPrice result = apiInstance.patchProductOfferingPrice(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductOfferingPrice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductOfferingPrice body = ; // ProductOfferingPrice | 
        String id = id_example; // String | Identifier of the ProductOfferingPrice
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductOfferingPrice result = apiInstance.patchProductOfferingPrice(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductOfferingPrice");
            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"];
ProductOfferingPrice *body = ; // 
String *id = id_example; // Identifier of the ProductOfferingPrice
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Updates partially a ProductOfferingPrice
[apiInstance patchProductOfferingPriceWith:body
    id:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              completionHandler: ^(ProductOfferingPrice 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 body = ; // {{ProductOfferingPrice}} 
var id = id_example; // {{String}} Identifier of the ProductOfferingPrice
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProductOfferingPrice(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProductOfferingPriceExample
    {
        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 body = new ProductOfferingPrice(); // ProductOfferingPrice | 
            var id = id_example;  // String | Identifier of the ProductOfferingPrice
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Updates partially a ProductOfferingPrice
                ProductOfferingPrice result = apiInstance.patchProductOfferingPrice(body, id, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.patchProductOfferingPrice: " + 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();
$body = ; // ProductOfferingPrice | 
$id = id_example; // String | Identifier of the ProductOfferingPrice
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->patchProductOfferingPrice($body, $id, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->patchProductOfferingPrice: ', $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 $body = WWW::SwaggerClient::Object::ProductOfferingPrice->new(); # ProductOfferingPrice | 
my $id = id_example; # String | Identifier of the ProductOfferingPrice
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->patchProductOfferingPrice(body => $body, id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->patchProductOfferingPrice: $@\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()
body =  # ProductOfferingPrice | 
id = id_example # String | Identifier of the ProductOfferingPrice
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Updates partially a ProductOfferingPrice
    api_response = api_instance.patch_product_offering_price(body, id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->patchProductOfferingPrice: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductOfferingPrice
Required
Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


patchProductSpecification

Updates partially a ProductSpecification

This operation updates partially a ProductSpecification entity.


/productSpecification/{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/v3/productSpecification/{id}?baseSiteId=&catalogId=&catalogVersion="
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();
        ProductSpecification body = ; // ProductSpecification | 
        String id = id_example; // String | Identifier of the ProductSpecification
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductSpecification result = apiInstance.patchProductSpecification(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCatalogManagementApi;

public class ProductCatalogManagementApiExample {

    public static void main(String[] args) {
        ProductCatalogManagementApi apiInstance = new ProductCatalogManagementApi();
        ProductSpecification body = ; // ProductSpecification | 
        String id = id_example; // String | Identifier of the ProductSpecification
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        try {
            ProductSpecification result = apiInstance.patchProductSpecification(body, id, baseSiteId, catalogId, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#patchProductSpecification");
            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"];
ProductSpecification *body = ; // 
String *id = id_example; // Identifier of the ProductSpecification
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)

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

// Updates partially a ProductSpecification
[apiInstance patchProductSpecificationWith:body
    id:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
              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 body = ; // {{ProductSpecification}} 
var id = id_example; // {{String}} Identifier of the ProductSpecification
var opts = { 
  'baseSiteId': baseSiteId_example // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example // {{String}} Version of the catalog
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProductSpecification(bodyid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProductSpecificationExample
    {
        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 body = new ProductSpecification(); // ProductSpecification | 
            var id = id_example;  // String | Identifier of the ProductSpecification
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 

            try
            {
                // Updates partially a ProductSpecification
                ProductSpecification result = apiInstance.patchProductSpecification(body, id, baseSiteId, catalogId, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.patchProductSpecification: " + 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();
$body = ; // ProductSpecification | 
$id = id_example; // String | Identifier of the ProductSpecification
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog

try {
    $result = $api_instance->patchProductSpecification($body, $id, $baseSiteId, $catalogId, $catalogVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->patchProductSpecification: ', $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 $body = WWW::SwaggerClient::Object::ProductSpecification->new(); # ProductSpecification | 
my $id = id_example; # String | Identifier of the ProductSpecification
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog

eval { 
    my $result = $api_instance->patchProductSpecification(body => $body, id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->patchProductSpecification: $@\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()
body =  # ProductSpecification | 
id = id_example # String | Identifier of the ProductSpecification
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)

try: 
    # Updates partially a ProductSpecification
    api_response = api_instance.patch_product_specification(body, id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->patchProductSpecification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the ProductSpecification
Required
Body parameters
Name Description
body *
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog

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


retrieveProductOffering

Retrieves a 'ProductOffering' by Id

This operation retrieves a product offering entity using its unique ID


/productOffering/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOffering/{id}?baseSiteId=&catalogId=&catalogVersion=&fields=&priceContext.place.id=&priceContext.processType.id=&priceContext.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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String priceContext.place.id = priceContext.place.id_example; // String | Identifier of the place for which product offering has prices available
        array[String] priceContext.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
        String priceContext.relatedParty.id = priceContext.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        try {
            array[ProductOffering] result = apiInstance.retrieveProductOffering(id, baseSiteId, catalogId, catalogVersion, fields, priceContext.place.id, priceContext.processType.id, priceContext.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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        String priceContext.place.id = priceContext.place.id_example; // String | Identifier of the place for which product offering has prices available
        array[String] priceContext.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
        String priceContext.relatedParty.id = priceContext.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.
        try {
            array[ProductOffering] result = apiInstance.retrieveProductOffering(id, baseSiteId, catalogId, catalogVersion, fields, priceContext.place.id, priceContext.processType.id, priceContext.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 *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body (optional)
String *priceContext.place.id = priceContext.place.id_example; // Identifier of the place for which product offering has prices available (optional)
array[String] *priceContext.processType.id = ; // For filtering by the process type of the product offering price. (optional)
String *priceContext.relatedParty.id = priceContext.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
    catalogId:catalogId
    catalogVersion:catalogVersion
    fields:fields
    priceContext.place.id:priceContext.place.id
    priceContext.processType.id:priceContext.processType.id
    priceContext.relatedParty.id:priceContext.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
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example, // {{String}} Version of the catalog
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body
  'priceContext.place.id': priceContext.place.id_example, // {{String}} Identifier of the place for which product offering has prices available
  'priceContext.processType.id': , // {{array[String]}} For filtering by the process type of the product offering price.
  'priceContext.relatedParty.id': priceContext.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 catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body (optional) 
            var priceContext.place.id = priceContext.place.id_example;  // String | Identifier of the place for which product offering has prices available (optional) 
            var priceContext.processType.id = new array[String](); // array[String] | For filtering by the process type of the product offering price. (optional) 
            var priceContext.relatedParty.id = priceContext.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, catalogId, catalogVersion, fields, priceContext.place.id, priceContext.processType.id, priceContext.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
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
$priceContext.place.id = priceContext.place.id_example; // String | Identifier of the place for which product offering has prices available
$priceContext.processType.id = ; // array[String] | For filtering by the process type of the product offering price.
$priceContext.relatedParty.id = priceContext.relatedParty.id_example; // String | For filtering: Identifier of the related party for which the price applies.

try {
    $result = $api_instance->retrieveProductOffering($id, $baseSiteId, $catalogId, $catalogVersion, $fields, $priceContext.place.id, $priceContext.processType.id, $priceContext.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 $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body
my $priceContext.place.id = priceContext.place.id_example; # String | Identifier of the place for which product offering has prices available
my $priceContext.processType.id = []; # array[String] | For filtering by the process type of the product offering price.
my $priceContext.relatedParty.id = priceContext.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, catalogId => $catalogId, catalogVersion => $catalogVersion, fields => $fields, priceContext.place.id => $priceContext.place.id, priceContext.processType.id => $priceContext.processType.id, priceContext.relatedParty.id => $priceContext.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)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body (optional)
priceContext.place.id = priceContext.place.id_example # String | Identifier of the place for which product offering has prices available (optional)
priceContext.processType.id =  # array[String] | For filtering by the process type of the product offering price. (optional)
priceContext.relatedParty.id = priceContext.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, catalogId=catalogId, catalogVersion=catalogVersion, fields=fields, priceContext.place.id=priceContext.place.id, priceContext.processType.id=priceContext.processType.id, priceContext.relatedParty.id=priceContext.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
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog
fields
String
Response configuration. This is the list of fields that should be returned in the response body
priceContext.place.id
String
Identifier of the place for which product offering has prices available
priceContext.processType.id
array[String]
For filtering by the process type of the product offering price.
priceContext.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


retrieveProductOfferingPrice

Retrieves a ProductOfferingPrice by ID

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


/productOfferingPrice/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOfferingPrice/{id}?baseSiteId=&catalogId=&catalogVersion=&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 Product Offering Price
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            ProductOfferingPrice result = apiInstance.retrieveProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductOfferingPrice");
            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 Price
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body
        try {
            ProductOfferingPrice result = apiInstance.retrieveProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCatalogManagementApi#retrieveProductOfferingPrice");
            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 Price
String *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (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 ProductOfferingPrice by ID
[apiInstance retrieveProductOfferingPriceWith:id
    baseSiteId:baseSiteId
    catalogId:catalogId
    catalogVersion:catalogVersion
    fields:fields
              completionHandler: ^(ProductOfferingPrice 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 Price
var opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example, // {{String}} Version of the catalog
  '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.retrieveProductOfferingPrice(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProductOfferingPriceExample
    {
        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 Price
            var baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (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 ProductOfferingPrice by ID
                ProductOfferingPrice result = apiInstance.retrieveProductOfferingPrice(id, baseSiteId, catalogId, catalogVersion, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCatalogManagementApi.retrieveProductOfferingPrice: " + 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 Price
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body

try {
    $result = $api_instance->retrieveProductOfferingPrice($id, $baseSiteId, $catalogId, $catalogVersion, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductCatalogManagementApi->retrieveProductOfferingPrice: ', $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 Price
my $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog
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->retrieveProductOfferingPrice(id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCatalogManagementApi->retrieveProductOfferingPrice: $@\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 Price
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (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 ProductOfferingPrice by ID
    api_response = api_instance.retrieve_product_offering_price(id, baseSiteId=baseSiteId, catalogId=catalogId, catalogVersion=catalogVersion, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCatalogManagementApi->retrieveProductOfferingPrice: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Product Offering Price
Required
Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog
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: 405 - Method Not allowed

Status: 409 - Conflict

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/v3/productSpecification/{id}?baseSiteId=&catalogId=&catalogVersion=&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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductSpecification result = apiInstance.retrieveProductSpecification(id, baseSiteId, catalogId, catalogVersion, 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 catalogId = catalogId_example; // String | Id of the catalog
        String catalogVersion = catalogVersion_example; // String | Version of the catalog
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            ProductSpecification result = apiInstance.retrieveProductSpecification(id, baseSiteId, catalogId, catalogVersion, 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 *catalogId = catalogId_example; // Id of the catalog (optional)
String *catalogVersion = catalogVersion_example; // Version of the catalog (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
    catalogId:catalogId
    catalogVersion:catalogVersion
    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
  'catalogId': catalogId_example, // {{String}} Id of the catalog
  'catalogVersion': catalogVersion_example, // {{String}} Version of the catalog
  '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 catalogId = catalogId_example;  // String | Id of the catalog (optional) 
            var catalogVersion = catalogVersion_example;  // String | Version of the catalog (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, catalogId, catalogVersion, 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
$catalogId = catalogId_example; // String | Id of the catalog
$catalogVersion = catalogVersion_example; // String | Version of the catalog
$fields = fields_example; // String | Comma-separated properties to provide in response

try {
    $result = $api_instance->retrieveProductSpecification($id, $baseSiteId, $catalogId, $catalogVersion, $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 $catalogId = catalogId_example; # String | Id of the catalog
my $catalogVersion = catalogVersion_example; # String | Version of the catalog
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveProductSpecification(id => $id, baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersion => $catalogVersion, 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)
catalogId = catalogId_example # String | Id of the catalog (optional)
catalogVersion = catalogVersion_example # String | Version of the catalog (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, catalogId=catalogId, catalogVersion=catalogVersion, 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
catalogId
String
Id of the catalog
catalogVersion
String
Version of the catalog
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


ProductInventoryManagement

retrieveProduct

Retrieves a Product by Id

This operation retrieves a subscribed product using its unique ID


/product/{id}

Usage and SDK Samples

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

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

public class ProductInventoryManagementApiExample {

    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");

        ProductInventoryManagementApi apiInstance = new ProductInventoryManagementApi();
        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
        try {
            Product result = apiInstance.retrieveProduct(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductInventoryManagementApi#retrieveProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductInventoryManagementApi;

public class ProductInventoryManagementApiExample {

    public static void main(String[] args) {
        ProductInventoryManagementApi apiInstance = new ProductInventoryManagementApi();
        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
        try {
            Product result = apiInstance.retrieveProduct(id, baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductInventoryManagementApi#retrieveProduct");
            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)

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

// Retrieves a Product by Id
[apiInstance retrieveProductWith:id
    baseSiteId:baseSiteId
    fields:fields
              completionHandler: ^(Product 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.ProductInventoryManagementApi()
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
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveProduct(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProductExample
    {
        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 ProductInventoryManagementApi();
            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) 

            try
            {
                // Retrieves a Product by Id
                Product result = apiInstance.retrieveProduct(id, baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductInventoryManagementApi.retrieveProduct: " + 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\ApiProductInventoryManagementApi();
$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

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

# 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::ProductInventoryManagementApi->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

eval { 
    my $result = $api_instance->retrieveProduct(id => $id, baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductInventoryManagementApi->retrieveProduct: $@\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.ProductInventoryManagementApi()
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)

try: 
    # Retrieves a Product by Id
    api_response = api_instance.retrieve_product(id, baseSiteId=baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductInventoryManagementApi->retrieveProduct: %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

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


ProductOrdering

listProductOrder

List or find ProductOrder objects

This operation list or find ProductOrder entities


/productOrder

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/productOrder?baseSiteId=&fields=&limit=&offset=&orderDate=&relatedParty.id=&state="
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 baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to be provided 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 orderDate = orderDate_example; // String | For filtering: Date when the order was created.
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
        String state = state_example; // String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.
        try {
            array[ProductOrder] result = apiInstance.listProductOrder(baseSiteId, fields, limit, offset, orderDate, relatedParty.id, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#listProductOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductOrderingApi;

public class ProductOrderingApiExample {

    public static void main(String[] args) {
        ProductOrderingApi apiInstance = new ProductOrderingApi();
        String baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to be provided 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 orderDate = orderDate_example; // String | For filtering: Date when the order was created.
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
        String state = state_example; // String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.
        try {
            array[ProductOrder] result = apiInstance.listProductOrder(baseSiteId, fields, limit, offset, orderDate, relatedParty.id, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductOrderingApi#listProductOrder");
            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 be provided 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 *orderDate = orderDate_example; // For filtering: Date when the order was created. (optional)
String *relatedParty.id = relatedParty.id_example; // Identifier of the PartyRole (optional)
String *state = state_example; // For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on. (optional)

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

// List or find ProductOrder objects
[apiInstance listProductOrderWith:baseSiteId
    fields:fields
    limit:limit
    offset:offset
    orderDate:orderDate
    relatedParty.id:relatedParty.id
    state:state
              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 opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Comma-separated properties to be provided 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
  'orderDate': orderDate_example, // {{String}} For filtering: Date when the order was created.
  'relatedParty.id': relatedParty.id_example, // {{String}} Identifier of the PartyRole
  'state': state_example // {{String}} For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProductOrder(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductOrderExample
    {
        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 baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma-separated properties to be provided 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 orderDate = orderDate_example;  // String | For filtering: Date when the order was created. (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Identifier of the PartyRole (optional) 
            var state = state_example;  // String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on. (optional) 

            try
            {
                // List or find ProductOrder objects
                array[ProductOrder] result = apiInstance.listProductOrder(baseSiteId, fields, limit, offset, orderDate, relatedParty.id, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductOrderingApi.listProductOrder: " + 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();
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma-separated properties to be provided 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
$orderDate = orderDate_example; // String | For filtering: Date when the order was created.
$relatedParty.id = relatedParty.id_example; // String | Identifier of the PartyRole
$state = state_example; // String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.

try {
    $result = $api_instance->listProductOrder($baseSiteId, $fields, $limit, $offset, $orderDate, $relatedParty.id, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductOrderingApi->listProductOrder: ', $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 $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma-separated properties to be provided 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 $orderDate = orderDate_example; # String | For filtering: Date when the order was created.
my $relatedParty.id = relatedParty.id_example; # String | Identifier of the PartyRole
my $state = state_example; # String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.

eval { 
    my $result = $api_instance->listProductOrder(baseSiteId => $baseSiteId, fields => $fields, limit => $limit, offset => $offset, orderDate => $orderDate, relatedParty.id => $relatedParty.id, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductOrderingApi->listProductOrder: $@\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()
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma-separated properties to be provided 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)
orderDate = orderDate_example # String | For filtering: Date when the order was created. (optional)
relatedParty.id = relatedParty.id_example # String | Identifier of the PartyRole (optional)
state = state_example # String | For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on. (optional)

try: 
    # List or find ProductOrder objects
    api_response = api_instance.list_product_order(baseSiteId=baseSiteId, fields=fields, limit=limit, offset=offset, orderDate=orderDate, relatedParty.id=relatedParty.id, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductOrderingApi->listProductOrder: %s\n" % e)

Parameters

Query parameters
Name Description
baseSiteId
String
Identifier of the BaseSite
fields
String
Comma-separated properties to be provided 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
orderDate
String
For filtering: Date when the order was created.
relatedParty.id
String
Identifier of the PartyRole
state
String
For filtering:Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.

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


patchProductOrder

Updates partially a ProductOrder

This operation updates partially a ProductOrder entity.


/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/v3/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

Create a product order

This operation creates a product order entity based on the given shoppingCart or on product order items.


/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/v3/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];

// Create a product order
[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
            {
                // Create a product order
                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: 
    # Create a product order
    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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable entity

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


retrieveProductOrder

Retrieves a ProductOrder by ID

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


/productOrder/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/b2ctelcotmfwebservices/v3/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 baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer
        try {
            ProductOrder result = apiInstance.retrieveProductOrder(id, baseSiteId, fields, relatedParty.id);
            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 baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
        String fields = fields_example; // String | Comma-separated properties to provide in response
        String relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer
        try {
            ProductOrder result = apiInstance.retrieveProductOrder(id, baseSiteId, fields, relatedParty.id);
            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 *baseSiteId = baseSiteId_example; // Identifier of the BaseSite (optional)
String *fields = fields_example; // Comma-separated properties to provide in response (optional)
String *relatedParty.id = relatedParty.id_example; // Identifier of the Customer (optional)

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

// Retrieves a ProductOrder by ID
[apiInstance retrieveProductOrderWith:id
    baseSiteId:baseSiteId
    fields:fields
    relatedParty.id:relatedParty.id
              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 opts = { 
  'baseSiteId': baseSiteId_example, // {{String}} Identifier of the BaseSite
  'fields': fields_example, // {{String}} Comma-separated properties to provide 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.retrieveProductOrder(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 baseSiteId = baseSiteId_example;  // String | Identifier of the BaseSite (optional) 
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Identifier of the Customer (optional) 

            try
            {
                // Retrieves a ProductOrder by ID
                ProductOrder result = apiInstance.retrieveProductOrder(id, baseSiteId, fields, relatedParty.id);
                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
$baseSiteId = baseSiteId_example; // String | Identifier of the BaseSite
$fields = fields_example; // String | Comma-separated properties to provide in response
$relatedParty.id = relatedParty.id_example; // String | Identifier of the Customer

try {
    $result = $api_instance->retrieveProductOrder($id, $baseSiteId, $fields, $relatedParty.id);
    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 $baseSiteId = baseSiteId_example; # String | Identifier of the BaseSite
my $fields = fields_example; # String | Comma-separated properties to provide in response
my $relatedParty.id = relatedParty.id_example; # String | Identifier of the Customer

eval { 
    my $result = $api_instance->retrieveProductOrder(id => $id, baseSiteId => $baseSiteId, fields => $fields, relatedParty.id => $relatedParty.id);
    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
baseSiteId = baseSiteId_example # String | Identifier of the BaseSite (optional)
fields = fields_example # String | Comma-separated properties to provide in response (optional)
relatedParty.id = relatedParty.id_example # String | Identifier of the Customer (optional)

try: 
    # Retrieves a ProductOrder by ID
    api_response = api_instance.retrieve_product_order(id, baseSiteId=baseSiteId, fields=fields, relatedParty.id=relatedParty.id)
    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

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