agreementtmfwebservices API

Agreements

createAgreement

Creates a Agreement

This operation creates a Agreement entity.


/agreement

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"https://<server-url>/agreementtmfwebservices/v3/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 an Agreement

This operation deletes an Agreement entity.


/agreement/{id}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"https://<server-url>/agreementtmfwebservices/v3/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 an 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 an 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 an 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/xml,application/json"\
"https://<server-url>/agreementtmfwebservices/v3/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 an Agreement

This operation updates partially an Agreement entity.


/agreement/{id}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json,pplication/xml"\
-H "Content-Type: application/json"\
"https://<server-url>/agreementtmfwebservices/v3/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 an 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 an 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 an 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/xml,application/json"\
"https://<server-url>/agreementtmfwebservices/v3/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