agreementtmfwebservices API

AgreementSpecifications

createAgreementSpecification

Creates a AgreementSpecification

This operation creates a AgreementSpecification entity.


/agreementSpecification

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/agreementtmfwebservices/v2/agreementSpecification"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementSpecificationsApi;

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

public class AgreementSpecificationsApiExample {

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

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

public class AgreementSpecificationsApiExample {

    public static void main(String[] args) {
        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        AgreementSpecification body = ; // AgreementSpecification | 
        try {
            AgreementSpecification result = apiInstance.createAgreementSpecification(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#createAgreementSpecification");
            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"];
AgreementSpecification *body = ; // 

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

// Creates a AgreementSpecification
[apiInstance createAgreementSpecificationWith:body
              completionHandler: ^(AgreementSpecification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementSpecificationsApi()
var body = ; // {{AgreementSpecification}} 

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

namespace Example
{
    public class createAgreementSpecificationExample
    {
        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 AgreementSpecificationsApi();
            var body = new AgreementSpecification(); // AgreementSpecification | 

            try
            {
                // Creates a AgreementSpecification
                AgreementSpecification result = apiInstance.createAgreementSpecification(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementSpecificationsApi.createAgreementSpecification: " + 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\ApiAgreementSpecificationsApi();
$body = ; // AgreementSpecification | 

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

# 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::AgreementSpecificationsApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecification->new(); # AgreementSpecification | 

eval { 
    my $result = $api_instance->createAgreementSpecification(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementSpecificationsApi->createAgreementSpecification: $@\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.AgreementSpecificationsApi()
body =  # AgreementSpecification | 

try: 
    # Creates a AgreementSpecification
    api_response = api_instance.create_agreement_specification(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementSpecificationsApi->createAgreementSpecification: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


deleteAgreementSpecification

Deletes a AgreementSpecification

This operation deletes a AgreementSpecification entity.


/agreementSpecification/{id}

Usage and SDK Samples

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

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

public class AgreementSpecificationsApiExample {

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

        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        String id = id_example; // String | Identifier of the AgreementSpecification
        try {
            apiInstance.deleteAgreementSpecification(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#deleteAgreementSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementSpecificationsApi;

public class AgreementSpecificationsApiExample {

    public static void main(String[] args) {
        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        String id = id_example; // String | Identifier of the AgreementSpecification
        try {
            apiInstance.deleteAgreementSpecification(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#deleteAgreementSpecification");
            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 AgreementSpecification

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

// Deletes a AgreementSpecification
[apiInstance deleteAgreementSpecificationWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementSpecificationsApi()
var id = id_example; // {{String}} Identifier of the AgreementSpecification

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

namespace Example
{
    public class deleteAgreementSpecificationExample
    {
        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 AgreementSpecificationsApi();
            var id = id_example;  // String | Identifier of the AgreementSpecification

            try
            {
                // Deletes a AgreementSpecification
                apiInstance.deleteAgreementSpecification(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementSpecificationsApi.deleteAgreementSpecification: " + 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\ApiAgreementSpecificationsApi();
$id = id_example; // String | Identifier of the AgreementSpecification

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

# 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::AgreementSpecificationsApi->new();
my $id = id_example; # String | Identifier of the AgreementSpecification

eval { 
    $api_instance->deleteAgreementSpecification(id => $id);
};
if ($@) {
    warn "Exception when calling AgreementSpecificationsApi->deleteAgreementSpecification: $@\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.AgreementSpecificationsApi()
id = id_example # String | Identifier of the AgreementSpecification

try: 
    # Deletes a AgreementSpecification
    api_instance.delete_agreement_specification(id)
except ApiException as e:
    print("Exception when calling AgreementSpecificationsApi->deleteAgreementSpecification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the AgreementSpecification
Required

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


listAgreementSpecification

List or find AgreementSpecification objects

This operation list or find AgreementSpecification entities


/agreementSpecification

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/agreementtmfwebservices/v2/agreementSpecification?fields=&lifecycleStatus=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementSpecificationsApi;

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

public class AgreementSpecificationsApiExample {

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

        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        String lifecycleStatus = lifecycleStatus_example; // String | Lifecycle status value
        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
        try {
            array[AgreementSpecification] result = apiInstance.listAgreementSpecification(fields, lifecycleStatus, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#listAgreementSpecification");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementSpecificationsApi;

public class AgreementSpecificationsApiExample {

    public static void main(String[] args) {
        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        String lifecycleStatus = lifecycleStatus_example; // String | Lifecycle status value
        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
        try {
            array[AgreementSpecification] result = apiInstance.listAgreementSpecification(fields, lifecycleStatus, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#listAgreementSpecification");
            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)
String *lifecycleStatus = lifecycleStatus_example; // Lifecycle status value (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)

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

// List or find AgreementSpecification objects
[apiInstance listAgreementSpecificationWith:fields
    lifecycleStatus:lifecycleStatus
    limit:limit
    offset:offset
              completionHandler: ^(array[AgreementSpecification] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementSpecificationsApi()
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to be provided in response
  'lifecycleStatus': lifecycleStatus_example, // {{String}} Lifecycle status value
  '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
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAgreementSpecification(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAgreementSpecificationExample
    {
        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 AgreementSpecificationsApi();
            var fields = fields_example;  // String | Comma-separated properties to be provided in response (optional) 
            var lifecycleStatus = lifecycleStatus_example;  // String | Lifecycle status value (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) 

            try
            {
                // List or find AgreementSpecification objects
                array[AgreementSpecification] result = apiInstance.listAgreementSpecification(fields, lifecycleStatus, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementSpecificationsApi.listAgreementSpecification: " + 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\ApiAgreementSpecificationsApi();
$fields = fields_example; // String | Comma-separated properties to be provided in response
$lifecycleStatus = lifecycleStatus_example; // String | Lifecycle status value
$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

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

# 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::AgreementSpecificationsApi->new();
my $fields = fields_example; # String | Comma-separated properties to be provided in response
my $lifecycleStatus = lifecycleStatus_example; # String | Lifecycle status value
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

eval { 
    my $result = $api_instance->listAgreementSpecification(fields => $fields, lifecycleStatus => $lifecycleStatus, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementSpecificationsApi->listAgreementSpecification: $@\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.AgreementSpecificationsApi()
fields = fields_example # String | Comma-separated properties to be provided in response (optional)
lifecycleStatus = lifecycleStatus_example # String | Lifecycle status value (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)

try: 
    # List or find AgreementSpecification objects
    api_response = api_instance.list_agreement_specification(fields=fields, lifecycleStatus=lifecycleStatus, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementSpecificationsApi->listAgreementSpecification: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Comma-separated properties to be provided in response
lifecycleStatus
String
Lifecycle status value
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

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


patchAgreementSpecification

Updates partially a AgreementSpecification

This operation updates partially a AgreementSpecification entity.


/agreementSpecification/{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/agreementtmfwebservices/v2/agreementSpecification/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementSpecificationsApi;

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

public class AgreementSpecificationsApiExample {

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

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

public class AgreementSpecificationsApiExample {

    public static void main(String[] args) {
        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        AgreementSpecification body = ; // AgreementSpecification | 
        String id = id_example; // String | Identifier of the AgreementSpecification
        try {
            AgreementSpecification result = apiInstance.patchAgreementSpecification(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#patchAgreementSpecification");
            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"];
AgreementSpecification *body = ; // 
String *id = id_example; // Identifier of the AgreementSpecification

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

// Updates partially a AgreementSpecification
[apiInstance patchAgreementSpecificationWith:body
    id:id
              completionHandler: ^(AgreementSpecification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementSpecificationsApi()
var body = ; // {{AgreementSpecification}} 
var id = id_example; // {{String}} Identifier of the AgreementSpecification

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

namespace Example
{
    public class patchAgreementSpecificationExample
    {
        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 AgreementSpecificationsApi();
            var body = new AgreementSpecification(); // AgreementSpecification | 
            var id = id_example;  // String | Identifier of the AgreementSpecification

            try
            {
                // Updates partially a AgreementSpecification
                AgreementSpecification result = apiInstance.patchAgreementSpecification(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementSpecificationsApi.patchAgreementSpecification: " + 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\ApiAgreementSpecificationsApi();
$body = ; // AgreementSpecification | 
$id = id_example; // String | Identifier of the AgreementSpecification

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

# 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::AgreementSpecificationsApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecification->new(); # AgreementSpecification | 
my $id = id_example; # String | Identifier of the AgreementSpecification

eval { 
    my $result = $api_instance->patchAgreementSpecification(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementSpecificationsApi->patchAgreementSpecification: $@\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.AgreementSpecificationsApi()
body =  # AgreementSpecification | 
id = id_example # String | Identifier of the AgreementSpecification

try: 
    # Updates partially a AgreementSpecification
    api_response = api_instance.patch_agreement_specification(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementSpecificationsApi->patchAgreementSpecification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the AgreementSpecification
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


retrieveAgreementSpecification

Retrieves a AgreementSpecification by ID

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


/agreementSpecification/{id}

Usage and SDK Samples

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

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

public class AgreementSpecificationsApiExample {

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

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

public class AgreementSpecificationsApiExample {

    public static void main(String[] args) {
        AgreementSpecificationsApi apiInstance = new AgreementSpecificationsApi();
        String id = id_example; // String | Identifier of the AgreementSpecification
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            AgreementSpecification result = apiInstance.retrieveAgreementSpecification(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementSpecificationsApi#retrieveAgreementSpecification");
            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 AgreementSpecification
String *fields = fields_example; // Comma-separated properties to provide in response (optional)

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

// Retrieves a AgreementSpecification by ID
[apiInstance retrieveAgreementSpecificationWith:id
    fields:fields
              completionHandler: ^(AgreementSpecification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementSpecificationsApi()
var id = id_example; // {{String}} Identifier of the AgreementSpecification
var opts = { 
  '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.retrieveAgreementSpecification(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveAgreementSpecificationExample
    {
        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 AgreementSpecificationsApi();
            var id = id_example;  // String | Identifier of the AgreementSpecification
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

            try
            {
                // Retrieves a AgreementSpecification by ID
                AgreementSpecification result = apiInstance.retrieveAgreementSpecification(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementSpecificationsApi.retrieveAgreementSpecification: " + 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\ApiAgreementSpecificationsApi();
$id = id_example; // String | Identifier of the AgreementSpecification
$fields = fields_example; // String | Comma-separated properties to provide in response

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

# 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::AgreementSpecificationsApi->new();
my $id = id_example; # String | Identifier of the AgreementSpecification
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveAgreementSpecification(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementSpecificationsApi->retrieveAgreementSpecification: $@\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.AgreementSpecificationsApi()
id = id_example # String | Identifier of the AgreementSpecification
fields = fields_example # String | Comma-separated properties to provide in response (optional)

try: 
    # Retrieves a AgreementSpecification by ID
    api_response = api_instance.retrieve_agreement_specification(id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementSpecificationsApi->retrieveAgreementSpecification: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the AgreementSpecification
Required
Query parameters
Name Description
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


Agreements

createAgreement

Creates a Agreement

This operation creates a Agreement entity.


/agreement

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/agreementtmfwebservices/v2/agreement"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsApi;

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

public class AgreementsApiExample {

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

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

public class AgreementsApiExample {

    public static void main(String[] args) {
        AgreementsApi apiInstance = new AgreementsApi();
        Agreement body = ; // Agreement | 
        try {
            Agreement result = apiInstance.createAgreement(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#createAgreement");
            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"];
Agreement *body = ; // 

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

// Creates a Agreement
[apiInstance createAgreementWith:body
              completionHandler: ^(Agreement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsApi()
var body = ; // {{Agreement}} 

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

namespace Example
{
    public class createAgreementExample
    {
        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 AgreementsApi();
            var body = new Agreement(); // Agreement | 

            try
            {
                // Creates a Agreement
                Agreement result = apiInstance.createAgreement(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.createAgreement: " + 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\ApiAgreementsApi();
$body = ; // Agreement | 

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

# 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::AgreementsApi->new();
my $body = WWW::SwaggerClient::Object::Agreement->new(); # Agreement | 

eval { 
    my $result = $api_instance->createAgreement(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementsApi->createAgreement: $@\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.AgreementsApi()
body =  # Agreement | 

try: 
    # Creates a Agreement
    api_response = api_instance.create_agreement(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementsApi->createAgreement: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


deleteAgreement

Deletes a Agreement

This operation deletes a Agreement entity.


/agreement/{id}

Usage and SDK Samples

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

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

public class AgreementsApiExample {

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

        AgreementsApi apiInstance = new AgreementsApi();
        String id = id_example; // String | Identifier of the Agreement
        try {
            apiInstance.deleteAgreement(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#deleteAgreement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsApi;

public class AgreementsApiExample {

    public static void main(String[] args) {
        AgreementsApi apiInstance = new AgreementsApi();
        String id = id_example; // String | Identifier of the Agreement
        try {
            apiInstance.deleteAgreement(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#deleteAgreement");
            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 Agreement

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

// Deletes a Agreement
[apiInstance deleteAgreementWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsApi()
var id = id_example; // {{String}} Identifier of the Agreement

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

namespace Example
{
    public class deleteAgreementExample
    {
        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 AgreementsApi();
            var id = id_example;  // String | Identifier of the Agreement

            try
            {
                // Deletes a Agreement
                apiInstance.deleteAgreement(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.deleteAgreement: " + 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\ApiAgreementsApi();
$id = id_example; // String | Identifier of the Agreement

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

# 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::AgreementsApi->new();
my $id = id_example; # String | Identifier of the Agreement

eval { 
    $api_instance->deleteAgreement(id => $id);
};
if ($@) {
    warn "Exception when calling AgreementsApi->deleteAgreement: $@\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.AgreementsApi()
id = id_example # String | Identifier of the Agreement

try: 
    # Deletes a Agreement
    api_instance.delete_agreement(id)
except ApiException as e:
    print("Exception when calling AgreementsApi->deleteAgreement: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Agreement
Required

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


listAgreement

List or find Agreement objects

This operation list or find Agreement entities


/agreement

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8,application/json;charset=utf-8"\
"http://localhost:9001/agreementtmfwebservices/v2/agreement?fields=&limit=&offset=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsApi;

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

public class AgreementsApiExample {

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

        AgreementsApi apiInstance = new AgreementsApi();
        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 status = status_example; // String | Status value
        try {
            array[Agreement] result = apiInstance.listAgreement(fields, limit, offset, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#listAgreement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsApi;

public class AgreementsApiExample {

    public static void main(String[] args) {
        AgreementsApi apiInstance = new AgreementsApi();
        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 status = status_example; // String | Status value
        try {
            array[Agreement] result = apiInstance.listAgreement(fields, limit, offset, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#listAgreement");
            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 *status = status_example; // Status value (optional)

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

// List or find Agreement objects
[apiInstance listAgreementWith:fields
    limit:limit
    offset:offset
    status:status
              completionHandler: ^(array[Agreement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsApi()
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
  'status': status_example // {{String}} Status value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAgreement(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAgreementExample
    {
        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 AgreementsApi();
            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 status = status_example;  // String | Status value (optional) 

            try
            {
                // List or find Agreement objects
                array[Agreement] result = apiInstance.listAgreement(fields, limit, offset, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.listAgreement: " + 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\ApiAgreementsApi();
$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
$status = status_example; // String | Status value

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

# 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::AgreementsApi->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 $status = status_example; # String | Status value

eval { 
    my $result = $api_instance->listAgreement(fields => $fields, limit => $limit, offset => $offset, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementsApi->listAgreement: $@\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.AgreementsApi()
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)
status = status_example # String | Status value (optional)

try: 
    # List or find Agreement objects
    api_response = api_instance.list_agreement(fields=fields, limit=limit, offset=offset, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementsApi->listAgreement: %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
status
String
Status value

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


patchAgreement

Updates partially a Agreement

This operation updates partially a Agreement entity.


/agreement/{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/agreementtmfwebservices/v2/agreement/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsApi;

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

public class AgreementsApiExample {

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

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

public class AgreementsApiExample {

    public static void main(String[] args) {
        AgreementsApi apiInstance = new AgreementsApi();
        Agreement body = ; // Agreement | 
        String id = id_example; // String | Identifier of the Agreement
        try {
            Agreement result = apiInstance.patchAgreement(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#patchAgreement");
            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"];
Agreement *body = ; // 
String *id = id_example; // Identifier of the Agreement

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

// Updates partially a Agreement
[apiInstance patchAgreementWith:body
    id:id
              completionHandler: ^(Agreement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsApi()
var body = ; // {{Agreement}} 
var id = id_example; // {{String}} Identifier of the Agreement

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

namespace Example
{
    public class patchAgreementExample
    {
        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 AgreementsApi();
            var body = new Agreement(); // Agreement | 
            var id = id_example;  // String | Identifier of the Agreement

            try
            {
                // Updates partially a Agreement
                Agreement result = apiInstance.patchAgreement(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.patchAgreement: " + 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\ApiAgreementsApi();
$body = ; // Agreement | 
$id = id_example; // String | Identifier of the Agreement

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

# 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::AgreementsApi->new();
my $body = WWW::SwaggerClient::Object::Agreement->new(); # Agreement | 
my $id = id_example; # String | Identifier of the Agreement

eval { 
    my $result = $api_instance->patchAgreement(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementsApi->patchAgreement: $@\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.AgreementsApi()
body =  # Agreement | 
id = id_example # String | Identifier of the Agreement

try: 
    # Updates partially a Agreement
    api_response = api_instance.patch_agreement(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementsApi->patchAgreement: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Agreement
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error


retrieveAgreement

Retrieves a Agreement by ID

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


/agreement/{id}

Usage and SDK Samples

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

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

public class AgreementsApiExample {

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

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

public class AgreementsApiExample {

    public static void main(String[] args) {
        AgreementsApi apiInstance = new AgreementsApi();
        String id = id_example; // String | Identifier of the Agreement
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            Agreement result = apiInstance.retrieveAgreement(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsApi#retrieveAgreement");
            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 Agreement
String *fields = fields_example; // Comma-separated properties to provide in response (optional)

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

// Retrieves a Agreement by ID
[apiInstance retrieveAgreementWith:id
    fields:fields
              completionHandler: ^(Agreement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsApi()
var id = id_example; // {{String}} Identifier of the Agreement
var opts = { 
  '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.retrieveAgreement(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveAgreementExample
    {
        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 AgreementsApi();
            var id = id_example;  // String | Identifier of the Agreement
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

            try
            {
                // Retrieves a Agreement by ID
                Agreement result = apiInstance.retrieveAgreement(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsApi.retrieveAgreement: " + 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\ApiAgreementsApi();
$id = id_example; // String | Identifier of the Agreement
$fields = fields_example; // String | Comma-separated properties to provide in response

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

# 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::AgreementsApi->new();
my $id = id_example; # String | Identifier of the Agreement
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveAgreement(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgreementsApi->retrieveAgreement: $@\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.AgreementsApi()
id = id_example # String | Identifier of the Agreement
fields = fields_example # String | Comma-separated properties to provide in response (optional)

try: 
    # Retrieves a Agreement by ID
    api_response = api_instance.retrieve_agreement(id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgreementsApi->retrieveAgreement: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the Agreement
Required
Query parameters
Name Description
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


AgreementsNotificationListeners

listenToAgreementAttributeValueChangeEvent

Client listener for entity AgreementAttributeValueChangeEvent

Example of a client listener for receiving the notification AgreementAttributeValueChangeEvent


/listener/agreementAttributeValueChangeEvent

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/agreementtmfwebservices/v2/listener/agreementAttributeValueChangeEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementAttributeValueChangeEvent body = ; // AgreementAttributeValueChangeEvent | 
        try {
            apiInstance.listenToAgreementAttributeValueChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementAttributeValueChangeEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementAttributeValueChangeEvent body = ; // AgreementAttributeValueChangeEvent | 
        try {
            apiInstance.listenToAgreementAttributeValueChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementAttributeValueChangeEvent");
            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"];
AgreementAttributeValueChangeEvent *body = ; // 

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

// Client listener for entity AgreementAttributeValueChangeEvent
[apiInstance listenToAgreementAttributeValueChangeEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementAttributeValueChangeEvent}} 

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

namespace Example
{
    public class listenToAgreementAttributeValueChangeEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementAttributeValueChangeEvent(); // AgreementAttributeValueChangeEvent | 

            try
            {
                // Client listener for entity AgreementAttributeValueChangeEvent
                apiInstance.listenToAgreementAttributeValueChangeEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementAttributeValueChangeEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementAttributeValueChangeEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementAttributeValueChangeEvent->new(); # AgreementAttributeValueChangeEvent | 

eval { 
    $api_instance->listenToAgreementAttributeValueChangeEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementAttributeValueChangeEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementAttributeValueChangeEvent | 

try: 
    # Client listener for entity AgreementAttributeValueChangeEvent
    api_instance.listen_to_agreement_attribute_value_change_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementAttributeValueChangeEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Notified

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


listenToAgreementCreateEvent

Client listener for entity AgreementCreateEvent

Example of a client listener for receiving the notification AgreementCreateEvent


/listener/agreementCreateEvent

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/agreementtmfwebservices/v2/listener/agreementCreateEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementCreateEvent body = ; // AgreementCreateEvent | 
        try {
            apiInstance.listenToAgreementCreateEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementCreateEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementCreateEvent body = ; // AgreementCreateEvent | 
        try {
            apiInstance.listenToAgreementCreateEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementCreateEvent");
            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"];
AgreementCreateEvent *body = ; // 

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

// Client listener for entity AgreementCreateEvent
[apiInstance listenToAgreementCreateEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementCreateEvent}} 

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

namespace Example
{
    public class listenToAgreementCreateEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementCreateEvent(); // AgreementCreateEvent | 

            try
            {
                // Client listener for entity AgreementCreateEvent
                apiInstance.listenToAgreementCreateEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementCreateEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementCreateEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementCreateEvent->new(); # AgreementCreateEvent | 

eval { 
    $api_instance->listenToAgreementCreateEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementCreateEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementCreateEvent | 

try: 
    # Client listener for entity AgreementCreateEvent
    api_instance.listen_to_agreement_create_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementCreateEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Notified

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


listenToAgreementDeleteEvent

Client listener for entity AgreementDeleteEvent

Example of a client listener for receiving the notification AgreementDeleteEvent


/listener/agreementDeleteEvent

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/agreementtmfwebservices/v2/listener/agreementDeleteEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementDeleteEvent body = ; // AgreementDeleteEvent | 
        try {
            apiInstance.listenToAgreementDeleteEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementDeleteEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementDeleteEvent body = ; // AgreementDeleteEvent | 
        try {
            apiInstance.listenToAgreementDeleteEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementDeleteEvent");
            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"];
AgreementDeleteEvent *body = ; // 

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

// Client listener for entity AgreementDeleteEvent
[apiInstance listenToAgreementDeleteEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementDeleteEvent}} 

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

namespace Example
{
    public class listenToAgreementDeleteEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementDeleteEvent(); // AgreementDeleteEvent | 

            try
            {
                // Client listener for entity AgreementDeleteEvent
                apiInstance.listenToAgreementDeleteEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementDeleteEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementDeleteEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementDeleteEvent->new(); # AgreementDeleteEvent | 

eval { 
    $api_instance->listenToAgreementDeleteEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementDeleteEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementDeleteEvent | 

try: 
    # Client listener for entity AgreementDeleteEvent
    api_instance.listen_to_agreement_delete_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementDeleteEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 204 - Notified

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


listenToAgreementSpecificationAttributeValueChangeEvent

Client listener for entity AgreementSpecificationAttributeValueChangeEvent

Example of a client listener for receiving the notification AgreementSpecificationAttributeValueChangeEvent


/listener/agreementSpecificationAttributeValueChangeEvent

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/agreementtmfwebservices/v2/listener/agreementSpecificationAttributeValueChangeEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationAttributeValueChangeEvent body = ; // AgreementSpecificationAttributeValueChangeEvent | 
        try {
            apiInstance.listenToAgreementSpecificationAttributeValueChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationAttributeValueChangeEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationAttributeValueChangeEvent body = ; // AgreementSpecificationAttributeValueChangeEvent | 
        try {
            apiInstance.listenToAgreementSpecificationAttributeValueChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationAttributeValueChangeEvent");
            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"];
AgreementSpecificationAttributeValueChangeEvent *body = ; // 

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

// Client listener for entity AgreementSpecificationAttributeValueChangeEvent
[apiInstance listenToAgreementSpecificationAttributeValueChangeEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementSpecificationAttributeValueChangeEvent}} 

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

namespace Example
{
    public class listenToAgreementSpecificationAttributeValueChangeEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementSpecificationAttributeValueChangeEvent(); // AgreementSpecificationAttributeValueChangeEvent | 

            try
            {
                // Client listener for entity AgreementSpecificationAttributeValueChangeEvent
                apiInstance.listenToAgreementSpecificationAttributeValueChangeEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementSpecificationAttributeValueChangeEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementSpecificationAttributeValueChangeEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecificationAttributeValueChangeEvent->new(); # AgreementSpecificationAttributeValueChangeEvent | 

eval { 
    $api_instance->listenToAgreementSpecificationAttributeValueChangeEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationAttributeValueChangeEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementSpecificationAttributeValueChangeEvent | 

try: 
    # Client listener for entity AgreementSpecificationAttributeValueChangeEvent
    api_instance.listen_to_agreement_specification_attribute_value_change_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationAttributeValueChangeEvent: %s\n" % e)

Parameters

Body parameters
Name Description
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


listenToAgreementSpecificationCreateEvent

Client listener for entity AgreementSpecificationCreateEvent

Example of a client listener for receiving the notification AgreementSpecificationCreateEvent


/listener/agreementSpecificationCreateEvent

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/agreementtmfwebservices/v2/listener/agreementSpecificationCreateEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationCreateEvent body = ; // AgreementSpecificationCreateEvent | 
        try {
            apiInstance.listenToAgreementSpecificationCreateEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationCreateEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationCreateEvent body = ; // AgreementSpecificationCreateEvent | 
        try {
            apiInstance.listenToAgreementSpecificationCreateEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationCreateEvent");
            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"];
AgreementSpecificationCreateEvent *body = ; // 

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

// Client listener for entity AgreementSpecificationCreateEvent
[apiInstance listenToAgreementSpecificationCreateEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementSpecificationCreateEvent}} 

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

namespace Example
{
    public class listenToAgreementSpecificationCreateEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementSpecificationCreateEvent(); // AgreementSpecificationCreateEvent | 

            try
            {
                // Client listener for entity AgreementSpecificationCreateEvent
                apiInstance.listenToAgreementSpecificationCreateEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementSpecificationCreateEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementSpecificationCreateEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecificationCreateEvent->new(); # AgreementSpecificationCreateEvent | 

eval { 
    $api_instance->listenToAgreementSpecificationCreateEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationCreateEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementSpecificationCreateEvent | 

try: 
    # Client listener for entity AgreementSpecificationCreateEvent
    api_instance.listen_to_agreement_specification_create_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationCreateEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Notified

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


listenToAgreementSpecificationDeleteEvent

Client listener for entity AgreementSpecificationDeleteEvent

Example of a client listener for receiving the notification AgreementSpecificationDeleteEvent


/listener/agreementSpecificationDeleteEvent

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/agreementtmfwebservices/v2/listener/agreementSpecificationDeleteEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationDeleteEvent body = ; // AgreementSpecificationDeleteEvent | 
        try {
            apiInstance.listenToAgreementSpecificationDeleteEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationDeleteEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationDeleteEvent body = ; // AgreementSpecificationDeleteEvent | 
        try {
            apiInstance.listenToAgreementSpecificationDeleteEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationDeleteEvent");
            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"];
AgreementSpecificationDeleteEvent *body = ; // 

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

// Client listener for entity AgreementSpecificationDeleteEvent
[apiInstance listenToAgreementSpecificationDeleteEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementSpecificationDeleteEvent}} 

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

namespace Example
{
    public class listenToAgreementSpecificationDeleteEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementSpecificationDeleteEvent(); // AgreementSpecificationDeleteEvent | 

            try
            {
                // Client listener for entity AgreementSpecificationDeleteEvent
                apiInstance.listenToAgreementSpecificationDeleteEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementSpecificationDeleteEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementSpecificationDeleteEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecificationDeleteEvent->new(); # AgreementSpecificationDeleteEvent | 

eval { 
    $api_instance->listenToAgreementSpecificationDeleteEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationDeleteEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementSpecificationDeleteEvent | 

try: 
    # Client listener for entity AgreementSpecificationDeleteEvent
    api_instance.listen_to_agreement_specification_delete_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationDeleteEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

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


listenToAgreementSpecificationStateChangeEvent

Client listener for entity AgreementSpecificationStateChangeEvent

Example of a client listener for receiving the notification AgreementSpecificationStateChangeEvent


/listener/agreementSpecificationStateChangeEvent

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/agreementtmfwebservices/v2/listener/agreementSpecificationStateChangeEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationStateChangeEvent body = ; // AgreementSpecificationStateChangeEvent | 
        try {
            apiInstance.listenToAgreementSpecificationStateChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationStateChangeEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementSpecificationStateChangeEvent body = ; // AgreementSpecificationStateChangeEvent | 
        try {
            apiInstance.listenToAgreementSpecificationStateChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementSpecificationStateChangeEvent");
            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"];
AgreementSpecificationStateChangeEvent *body = ; // 

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

// Client listener for entity AgreementSpecificationStateChangeEvent
[apiInstance listenToAgreementSpecificationStateChangeEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementSpecificationStateChangeEvent}} 

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

namespace Example
{
    public class listenToAgreementSpecificationStateChangeEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementSpecificationStateChangeEvent(); // AgreementSpecificationStateChangeEvent | 

            try
            {
                // Client listener for entity AgreementSpecificationStateChangeEvent
                apiInstance.listenToAgreementSpecificationStateChangeEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementSpecificationStateChangeEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementSpecificationStateChangeEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementSpecificationStateChangeEvent->new(); # AgreementSpecificationStateChangeEvent | 

eval { 
    $api_instance->listenToAgreementSpecificationStateChangeEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationStateChangeEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementSpecificationStateChangeEvent | 

try: 
    # Client listener for entity AgreementSpecificationStateChangeEvent
    api_instance.listen_to_agreement_specification_state_change_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementSpecificationStateChangeEvent: %s\n" % e)

Parameters

Body parameters
Name Description
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


listenToAgreementStateChangeEvent

Client listener for entity AgreementStateChangeEvent

Example of a client listener for receiving the notification AgreementStateChangeEvent


/listener/agreementStateChangeEvent

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/agreementtmfwebservices/v2/listener/agreementStateChangeEvent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgreementsNotificationListenersApi;

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

public class AgreementsNotificationListenersApiExample {

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

        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementStateChangeEvent body = ; // AgreementStateChangeEvent | 
        try {
            apiInstance.listenToAgreementStateChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementStateChangeEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgreementsNotificationListenersApi;

public class AgreementsNotificationListenersApiExample {

    public static void main(String[] args) {
        AgreementsNotificationListenersApi apiInstance = new AgreementsNotificationListenersApi();
        AgreementStateChangeEvent body = ; // AgreementStateChangeEvent | 
        try {
            apiInstance.listenToAgreementStateChangeEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgreementsNotificationListenersApi#listenToAgreementStateChangeEvent");
            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"];
AgreementStateChangeEvent *body = ; // 

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

// Client listener for entity AgreementStateChangeEvent
[apiInstance listenToAgreementStateChangeEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AgreementtmfwebservicesApi = require('agreementtmfwebservices_api');
var defaultClient = AgreementtmfwebservicesApi.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 AgreementtmfwebservicesApi.AgreementsNotificationListenersApi()
var body = ; // {{AgreementStateChangeEvent}} 

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

namespace Example
{
    public class listenToAgreementStateChangeEventExample
    {
        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 AgreementsNotificationListenersApi();
            var body = new AgreementStateChangeEvent(); // AgreementStateChangeEvent | 

            try
            {
                // Client listener for entity AgreementStateChangeEvent
                apiInstance.listenToAgreementStateChangeEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgreementsNotificationListenersApi.listenToAgreementStateChangeEvent: " + 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\ApiAgreementsNotificationListenersApi();
$body = ; // AgreementStateChangeEvent | 

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

# 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::AgreementsNotificationListenersApi->new();
my $body = WWW::SwaggerClient::Object::AgreementStateChangeEvent->new(); # AgreementStateChangeEvent | 

eval { 
    $api_instance->listenToAgreementStateChangeEvent(body => $body);
};
if ($@) {
    warn "Exception when calling AgreementsNotificationListenersApi->listenToAgreementStateChangeEvent: $@\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.AgreementsNotificationListenersApi()
body =  # AgreementStateChangeEvent | 

try: 
    # Client listener for entity AgreementStateChangeEvent
    api_instance.listen_to_agreement_state_change_event(body)
except ApiException as e:
    print("Exception when calling AgreementsNotificationListenersApi->listenToAgreementStateChangeEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Notified

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