partyroletmfwebservices API

PartyRole

createPartyRole

Creates a PartyRole

This operation creates a PartyRole entity.


/partyRole

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/partyroletmfwebservices/v1/partyRole"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyRoleApi;

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

public class PartyRoleApiExample {

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

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

public class PartyRoleApiExample {

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

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

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

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

namespace Example
{
    public class createPartyRoleExample
    {
        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 PartyRoleApi();
            var body = new PartyRole(); // PartyRole | 

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

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

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

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

try: 
    # Creates a PartyRole
    api_response = api_instance.create_party_role(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyRoleApi->createPartyRole: %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


deletePartyRole

Deletes a PartyRole

This operation deletes a PartyRole entity.


/partyRole/{id}

Usage and SDK Samples

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

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

public class PartyRoleApiExample {

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

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

public class PartyRoleApiExample {

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

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

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

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

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

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

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

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

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

try: 
    # Deletes a PartyRole
    api_instance.delete_party_role(id)
except ApiException as e:
    print("Exception when calling PartyRoleApi->deletePartyRole: %s\n" % e)

Parameters

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


listPartyRole

List or find PartyRole objects

This operation list or find PartyRole entities


/partyRole

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/partyroletmfwebservices/v1/partyRole?fields=&limit=&name=&offset=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyRoleApi;

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

public class PartyRoleApiExample {

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

        PartyRoleApi apiInstance = new PartyRoleApi();
        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
        String name = name_example; // String | For filtering: The name of PartyRole
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String status = status_example; // String | For filtering: The status of PartyRole
        try {
            array[PartyRole] result = apiInstance.listPartyRole(fields, limit, name, offset, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyRoleApi#listPartyRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PartyRoleApi;

public class PartyRoleApiExample {

    public static void main(String[] args) {
        PartyRoleApi apiInstance = new PartyRoleApi();
        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
        String name = name_example; // String | For filtering: The name of PartyRole
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String status = status_example; // String | For filtering: The status of PartyRole
        try {
            array[PartyRole] result = apiInstance.listPartyRole(fields, limit, name, offset, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartyRoleApi#listPartyRole");
            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)
String *name = name_example; // For filtering: The name of PartyRole (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *status = status_example; // For filtering: The status of PartyRole (optional)

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

// List or find PartyRole objects
[apiInstance listPartyRoleWith:fields
    limit:limit
    name:name
    offset:offset
    status:status
              completionHandler: ^(array[PartyRole] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PartyroletmfwebservicesApi = require('partyroletmfwebservices_api');
var defaultClient = PartyroletmfwebservicesApi.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 PartyroletmfwebservicesApi.PartyRoleApi()
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
  'name': name_example, // {{String}} For filtering: The name of PartyRole
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'status': status_example // {{String}} For filtering: The status of PartyRole
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPartyRole(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listPartyRoleExample
    {
        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 PartyRoleApi();
            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 name = name_example;  // String | For filtering: The name of PartyRole (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var status = status_example;  // String | For filtering: The status of PartyRole (optional) 

            try
            {
                // List or find PartyRole objects
                array[PartyRole] result = apiInstance.listPartyRole(fields, limit, name, offset, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartyRoleApi.listPartyRole: " + 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\ApiPartyRoleApi();
$fields = fields_example; // String | Comma-separated properties to be provided in response
$limit = 56; // Integer | Requested number of resources to be provided in response
$name = name_example; // String | For filtering: The name of PartyRole
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$status = status_example; // String | For filtering: The status of PartyRole

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

# 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::PartyRoleApi->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 $name = name_example; # String | For filtering: The name of PartyRole
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $status = status_example; # String | For filtering: The status of PartyRole

eval { 
    my $result = $api_instance->listPartyRole(fields => $fields, limit => $limit, name => $name, offset => $offset, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartyRoleApi->listPartyRole: $@\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.PartyRoleApi()
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)
name = name_example # String | For filtering: The name of PartyRole (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
status = status_example # String | For filtering: The status of PartyRole (optional)

try: 
    # List or find PartyRole objects
    api_response = api_instance.list_party_role(fields=fields, limit=limit, name=name, offset=offset, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyRoleApi->listPartyRole: %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
name
String
For filtering: The name of PartyRole
offset
Integer (int32)
Requested index for start of resources to be provided in response
status
String
For filtering: The status of PartyRole

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


patchPartyRole

Updates partially a PartyRole

This operation updates partially a PartyRole entity.


/partyRole/{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/partyroletmfwebservices/v1/partyRole/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartyRoleApi;

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

public class PartyRoleApiExample {

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

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

public class PartyRoleApiExample {

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

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

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

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

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

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

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

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

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

try: 
    # Updates partially a PartyRole
    api_response = api_instance.patch_party_role(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartyRoleApi->patchPartyRole: %s\n" % e)

Parameters

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


retrievePartyRole

Retrieves a PartyRole by ID

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


/partyRole/{id}

Usage and SDK Samples

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

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

public class PartyRoleApiExample {

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

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

public class PartyRoleApiExample {

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

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

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

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

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

            var apiInstance = new PartyRoleApi();
            var id = id_example;  // String | Identifier of the PartyRole
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

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

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

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

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

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

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

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

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

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

Parameters

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