Visma Broker Partner API

Contact

Add Consent


/api/v{apiVersion}/{installationId}/contacts/{contactId}/Consent

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"/partners/api/v{apiVersion}/{installationId}/contacts/{contactId}/Consent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

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

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        ContactApi apiInstance = new ContactApi();
        String installationId = installationId_example; // String | 
        UUID contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String apiVersion = apiVersion_example; // String | 
        array[PutConsentDto] body = ; // array[PutConsentDto] | 
        try {
            apiInstance.apiVapiVersionInstallationIdContactsContactIdConsentPut(installationId, contactId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#apiVapiVersionInstallationIdContactsContactIdConsentPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        String installationId = installationId_example; // String | 
        UUID contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String apiVersion = apiVersion_example; // String | 
        array[PutConsentDto] body = ; // array[PutConsentDto] | 
        try {
            apiInstance.apiVapiVersionInstallationIdContactsContactIdConsentPut(installationId, contactId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#apiVapiVersionInstallationIdContactsContactIdConsentPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *installationId = installationId_example; // 
UUID *contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *apiVersion = apiVersion_example; // 
array[PutConsentDto] *body = ; //  (optional)

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

[apiInstance apiVapiVersionInstallationIdContactsContactIdConsentPutWith:installationId
    contactId:contactId
    apiVersion:apiVersion
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VismaBrokerPartnerApi = require('visma_broker_partner_api');
var defaultClient = VismaBrokerPartnerApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new VismaBrokerPartnerApi.ContactApi()
var installationId = installationId_example; // {{String}} 
var contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var apiVersion = apiVersion_example; // {{String}} 
var opts = { 
  'body':  // {{array[PutConsentDto]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVapiVersionInstallationIdContactsContactIdConsentPut(installationIdcontactIdapiVersion, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiVapiVersionInstallationIdContactsContactIdConsentPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ContactApi();
            var installationId = installationId_example;  // String | 
            var contactId = new UUID(); // UUID | 
            var apiVersion = apiVersion_example;  // String | 
            var body = new array[PutConsentDto](); // array[PutConsentDto] |  (optional) 

            try
            {
                apiInstance.apiVapiVersionInstallationIdContactsContactIdConsentPut(installationId, contactId, apiVersion, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.apiVapiVersionInstallationIdContactsContactIdConsentPut: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiContactApi();
$installationId = installationId_example; // String | 
$contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$apiVersion = apiVersion_example; // String | 
$body = ; // array[PutConsentDto] | 

try {
    $api_instance->apiVapiVersionInstallationIdContactsContactIdConsentPut($installationId, $contactId, $apiVersion, $body);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->apiVapiVersionInstallationIdContactsContactIdConsentPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $installationId = installationId_example; # String | 
my $contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $apiVersion = apiVersion_example; # String | 
my $body = [WWW::SwaggerClient::Object::array[PutConsentDto]->new()]; # array[PutConsentDto] | 

eval { 
    $api_instance->apiVapiVersionInstallationIdContactsContactIdConsentPut(installationId => $installationId, contactId => $contactId, apiVersion => $apiVersion, body => $body);
};
if ($@) {
    warn "Exception when calling ContactApi->apiVapiVersionInstallationIdContactsContactIdConsentPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ContactApi()
installationId = installationId_example # String | 
contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
apiVersion = apiVersion_example # String | 
body =  # array[PutConsentDto] |  (optional)

try: 
    api_instance.api_vapi_version_installation_id_contacts_contact_id_consent_put(installationId, contactId, apiVersion, body=body)
except ApiException as e:
    print("Exception when calling ContactApi->apiVapiVersionInstallationIdContactsContactIdConsentPut: %s\n" % e)

Parameters

Path parameters
Name Description
installationId*
String
Required
contactId*
UUID (uuid)
Required
apiVersion*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Estate

Register Interest


/api/v{apiVersion}/{installationId}/estates/{estateId}/RegisterInterest

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"/partners/api/v{apiVersion}/{installationId}/estates/{estateId}/RegisterInterest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EstateApi;

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

public class EstateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        EstateApi apiInstance = new EstateApi();
        String installationId = installationId_example; // String | 
        String estateId = estateId_example; // String | 
        String apiVersion = apiVersion_example; // String | 
        InterestDto body = ; // InterestDto | 
        try {
            apiInstance.apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost(installationId, estateId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling EstateApi#apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EstateApi;

public class EstateApiExample {

    public static void main(String[] args) {
        EstateApi apiInstance = new EstateApi();
        String installationId = installationId_example; // String | 
        String estateId = estateId_example; // String | 
        String apiVersion = apiVersion_example; // String | 
        InterestDto body = ; // InterestDto | 
        try {
            apiInstance.apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost(installationId, estateId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling EstateApi#apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *installationId = installationId_example; // 
String *estateId = estateId_example; // 
String *apiVersion = apiVersion_example; // 
InterestDto *body = ; //  (optional)

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

[apiInstance apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPostWith:installationId
    estateId:estateId
    apiVersion:apiVersion
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VismaBrokerPartnerApi = require('visma_broker_partner_api');
var defaultClient = VismaBrokerPartnerApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new VismaBrokerPartnerApi.EstateApi()
var installationId = installationId_example; // {{String}} 
var estateId = estateId_example; // {{String}} 
var apiVersion = apiVersion_example; // {{String}} 
var opts = { 
  'body':  // {{InterestDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost(installationIdestateIdapiVersion, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new EstateApi();
            var installationId = installationId_example;  // String | 
            var estateId = estateId_example;  // String | 
            var apiVersion = apiVersion_example;  // String | 
            var body = new InterestDto(); // InterestDto |  (optional) 

            try
            {
                apiInstance.apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost(installationId, estateId, apiVersion, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EstateApi.apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiEstateApi();
$installationId = installationId_example; // String | 
$estateId = estateId_example; // String | 
$apiVersion = apiVersion_example; // String | 
$body = ; // InterestDto | 

try {
    $api_instance->apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost($installationId, $estateId, $apiVersion, $body);
} catch (Exception $e) {
    echo 'Exception when calling EstateApi->apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EstateApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::EstateApi->new();
my $installationId = installationId_example; # String | 
my $estateId = estateId_example; # String | 
my $apiVersion = apiVersion_example; # String | 
my $body = WWW::SwaggerClient::Object::InterestDto->new(); # InterestDto | 

eval { 
    $api_instance->apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost(installationId => $installationId, estateId => $estateId, apiVersion => $apiVersion, body => $body);
};
if ($@) {
    warn "Exception when calling EstateApi->apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EstateApi()
installationId = installationId_example # String | 
estateId = estateId_example # String | 
apiVersion = apiVersion_example # String | 
body =  # InterestDto |  (optional)

try: 
    api_instance.api_vapi_version_installation_id_estates_estate_id_register_interest_post(installationId, estateId, apiVersion, body=body)
except ApiException as e:
    print("Exception when calling EstateApi->apiVapiVersionInstallationIdEstatesEstateIdRegisterInterestPost: %s\n" % e)

Parameters

Path parameters
Name Description
installationId*
String
Required
estateId*
String
Required
apiVersion*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request

Tips

Post a tips


/api/v{apiVersion}/{installationId}/Tips

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"/partners/api/v{apiVersion}/{installationId}/Tips"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TipsApi;

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

public class TipsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        TipsApi apiInstance = new TipsApi();
        String installationId = installationId_example; // String | 
        String apiVersion = apiVersion_example; // String | 
        TipsDto body = ; // TipsDto | 
        try {
            apiInstance.apiVapiVersionInstallationIdTipsPost(installationId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TipsApi#apiVapiVersionInstallationIdTipsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TipsApi;

public class TipsApiExample {

    public static void main(String[] args) {
        TipsApi apiInstance = new TipsApi();
        String installationId = installationId_example; // String | 
        String apiVersion = apiVersion_example; // String | 
        TipsDto body = ; // TipsDto | 
        try {
            apiInstance.apiVapiVersionInstallationIdTipsPost(installationId, apiVersion, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TipsApi#apiVapiVersionInstallationIdTipsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *installationId = installationId_example; // 
String *apiVersion = apiVersion_example; // 
TipsDto *body = ; //  (optional)

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

[apiInstance apiVapiVersionInstallationIdTipsPostWith:installationId
    apiVersion:apiVersion
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VismaBrokerPartnerApi = require('visma_broker_partner_api');
var defaultClient = VismaBrokerPartnerApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new VismaBrokerPartnerApi.TipsApi()
var installationId = installationId_example; // {{String}} 
var apiVersion = apiVersion_example; // {{String}} 
var opts = { 
  'body':  // {{TipsDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVapiVersionInstallationIdTipsPost(installationIdapiVersion, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiVapiVersionInstallationIdTipsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new TipsApi();
            var installationId = installationId_example;  // String | 
            var apiVersion = apiVersion_example;  // String | 
            var body = new TipsDto(); // TipsDto |  (optional) 

            try
            {
                apiInstance.apiVapiVersionInstallationIdTipsPost(installationId, apiVersion, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TipsApi.apiVapiVersionInstallationIdTipsPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiTipsApi();
$installationId = installationId_example; // String | 
$apiVersion = apiVersion_example; // String | 
$body = ; // TipsDto | 

try {
    $api_instance->apiVapiVersionInstallationIdTipsPost($installationId, $apiVersion, $body);
} catch (Exception $e) {
    echo 'Exception when calling TipsApi->apiVapiVersionInstallationIdTipsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TipsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::TipsApi->new();
my $installationId = installationId_example; # String | 
my $apiVersion = apiVersion_example; # String | 
my $body = WWW::SwaggerClient::Object::TipsDto->new(); # TipsDto | 

eval { 
    $api_instance->apiVapiVersionInstallationIdTipsPost(installationId => $installationId, apiVersion => $apiVersion, body => $body);
};
if ($@) {
    warn "Exception when calling TipsApi->apiVapiVersionInstallationIdTipsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.TipsApi()
installationId = installationId_example # String | 
apiVersion = apiVersion_example # String | 
body =  # TipsDto |  (optional)

try: 
    api_instance.api_vapi_version_installation_id_tips_post(installationId, apiVersion, body=body)
except ApiException as e:
    print("Exception when calling TipsApi->apiVapiVersionInstallationIdTipsPost: %s\n" % e)

Parameters

Path parameters
Name Description
installationId*
String
Required
apiVersion*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - Success

Status: 400 - Bad Request