Trade Compliance Management

AEB Trade Compliance API hub

Welcome to the AEB Trade Compliance API hub. You'll find comprehensive guides and documentation to help you start working with AEBs Trade Compliance Services as quickly as possible.
Trade Compliance Management offers comprehensive functionality for screening of addresses against restricted party lists, export control checks and license management.
Let's jump right in!

Suggest Edits

Compliance Screening

 
 
 
Suggest Edits

Address screening

Screens addresses against restricted party lists.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses

Body Params

addresses
array of objects

The addresses to be screened.

addressType
name
street
pc
city
district
countryISO
telNo
postbox
pcPostbox
cityPostbox
email
fax
name1
name2
name3
name4
title
surname
prenames
dateOfBirth
passportData
cityOfBirth
countryOfBirthISO
nationalityISO
position
niNumber
info
aliasGroupNo
free1
free2
free3
free4
free5
free6
free7
referenceId
referenceComment
condition 
screeningParameters
object

Parameters for the screening process.

 
screeningParameters.clientIdentCode
string
required

Ident code of the client to use for screening. The value must be a valid ident code of a client the authorized user has access to (usually the same client used for authentication).
(max. length: 10)

screeningParameters.profileIdentCode
string
required

Ident code of a Compliance profile. The value must be a valid ident code for the client specified by the clientIdentCode.
(max. length: 20)

screeningParameters.threshold
int32

Define the similarity threshold which should be used for address screening. Optionally overrides the value from the Compliance profile used.
Valid values are: 0% to 100%.
Length: 20.

screeningParameters.clientSystemId
string

The unique ID of the host system calling this API. Used when logging the address screening results.
(max. length: 20)

screeningParameters.suppressLogging
boolean

If 'true', the address screening operation will not be logged. If omitted or 'false' the address screening operation will be logged.

screeningParameters.considerGoodGuys
boolean

If 'false' Good Guys will be ignored. If omitted or 'true', Good Guys will be considered. Should only be used if Good Guys should be ignored specifically, i.e. to specifically check a Good Guy similar to the Good Guy screening batch.

screeningParameters.userIdentification
string

The users name to be used for logging. Purely informational.
(max. length: 100)

Hallo das ist ein Test

curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/screenAddresses"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Get aliases of an address

Returns all alias addresses of a restricted party list address.

 
gethttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses

Query Params

listGroupName
string
aliasGroupNo
string
internalAddressId
string
 
curl --request GET \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses
var request = require("request");

var options = { method: 'GET',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/aliasAddresses"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

A Good Guy

Create a Good Guy if it does not already exist. A Good Guy with exactly the same address fields will not be created twice.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy

Body Params

addressType
string

Either "company", "individual", "vessel", "bank" or 'null' for unknown.

name
string

Full name of the address, e.g. name of the company (address line 1 - 4) or prename and surname of an individual.
(max. length: 200)

street
string

Street of the address, including house number.
(max. length: 100)

pc
string

Postal code of the city.
(max. length: 40)

city
string

City of the address.
(max. length: 100)

district
string

District of the address, resp. line 2 of the city (in German: Ortsteil).
(max. length: 50)

countryISO
string

Two character ISO code of the country, e.g. "US" or "DE".
(max. length: 2)

telNo
string

Telephone number.
(max. length: 40)

postbox
string

The postbox of the address.
(max. length: 20)

pcPostbox
string

The postal code of the postbox, if the postal code of the postbox differs from the postal code of the street address.
(max. length: 40)

cityPostbox
string

The city of the postbox, if the city of the postbox differs from the city of the street address.
(max. length: 100)

email
string

Email address.
(max. length: 256)

fax
string

Fax number.
(max. length: 40)

name1
string

Additional information only for companies: The first line of the addresses name.
(max. length: 50)

name2
string

Additional information only for companies: The second line of the addresses name.
(max. length: 50)

name3
string

Additional information only for companies: The third line of the addresses name.
(max. length: 50)

name4
string

Additional information only for companies: The fourth line of the addresses name.
(max. length: 50)

title
string

Additional information only for individuals: The title of a person.
(max. length: 20)

surname
string

Additional information only for individuals: The surname of a person.
(max. length: 50)

prenames
string

Additional information only for individuals: The prenames of a person.
(max. length: 50)

dateOfBirth
string

The date of birth in textual representation, e.g. "1962-08-20" or just "1962" or other date formats. (Only human readable.)
(max. length: 20)

passportData
string

Additional information only for individuals: Textual information about the passport, e.g. passport no. and date of issue.
(max. length: 200)

cityOfBirth
string

Additional information only for individuals: City of birth
(max. length: 50)

countryOfBirthISO
string

Additional information only for individuals: Two letter ISO code for the country of birth.
(max. length: 2)

nationalityISO
string

Additional information only for individuals: Two letter ISO code for the nationality.
(max. length: 2)

position
string

Additional information only for individuals: Textual information about the position of the individual.
(max. length: 200)

niNumber
string

Additional identification tokens or numbers of individuals.
(max. length: 50)

info
string

Summary additional information, e.g. alias names or information composed of other field like position, passportData, dateOfBirth. It is supposed to display this field to the user instead of
(max. length: 1000)

aliasGroupNo
string

Number or name of the group under which all addresses are summarized describing the same person or organization.
(max. length: 20)

free1
string

Additional field for future use.
(max. length: 50)

free2
string

Additional field for future use.
(max. length: 50)

free3
string

Additional field for future use.
(max. length: 50)

free4
string

Additional field for future use.
(max. length: 50)

free5
string

Additional field for future use.
(max. length: 50)

free6
string

Additional field for future use.
(max. length: 50)

free7
string

Additional field for future use.
(max. length: 50)

clientIdentCode
string
required

Ident code of the client the Good Guy belongs to. The value must be a valid ident code of an existing client.
(max. length: 10)

profileIdentCode
string
required

Ident code of a Compliance profile. The value must be a valid ident code of a profile valid for the specified client.
(max. length: 1000)

clientSystemId
string

The unique ID of the host system calling this API. Used in log entries on any actions performed on the Good Guy.
(max. length: 20)

referenceId
string

Reference ID for logging.
(max. length: 255)

referenceComment
string

Reference comment for logging.
(max. length: 3000)

isActive
boolean

Defines whether the Good Guy is active or not. Inactive Good Guys are not considered during address screening. If omitted, the Good Guy is active by default. Only used when a new Good Guy is created.

userIdentification
string

The users name to be used for logging.
(max. length: 100)

condition
object

Optional condition for the Good Guy. If omitted, the Good Guy is unconditional. If given, the Good Guy is only used in address checks that meet the condition.

 
condition.value
string
required

The mandatory value of this condition.
(max. length: 1000)

condition.description
string

A short, human readable description of the condition.
(max. length: 255)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

A Compliance Profil

Get the Compliance profiles of a client.

 
gethttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles

Query Params

clientIdentCode
string
 
curl --request GET \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles
var request = require("request");

var options = { method: 'GET',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/profiles"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Create a log entry

Create a new log entry.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry

Body Params

level
string

The severity level of the event to log.

clientIdentCode
string
required

Ident code of the client to create the log entry for. Must be a valid ident code of an existing client.
(max. length: 10)

profileIdentCode
string

Ident code of the Compliance profile to create the log entry for. If given, must be a valid ident code of a profile valid for the given client. If omitted, the log entry is not linked to a profile.
(max. length: 20)

clientSystemId
string

The unique ID of the host system that creates the log entry. Used to filter log entries by the host system they originate from.
(max. length: 20)

referenceId
string

Reference ID for a host system object or transaction the log entry is linked to. Used to correlate log entries to their source.
(max. length: 1000)

referenceComment
string

User readable reference comment for a host system object or transaction the log entry is linked to. The user readable version of the reference ID.
(max. length: 3000)

info
string

A textual description of the event.
(max. length: 60000)

userIdentification
string

A description of the user who made the event. Purely informational and does not have to be an existing user in Trade Compliance.
(max. length: 100)

module
string
required

The module, the log entry should be created for.

happendAtDate
object

The date and time zone when the event happened. If omitted, the date and time at which the request was processed it used. If only the time zone is omitted, the default time zone of the server is used.

 
happendAtDate.dateInTimezone
string

String representation of the date/time stamp in the format yyyy-MM-dd HH:mm:ss

Length: 19

happendAtDate.timezone
string

Time zone of the time stamp.

Examples of valid time zones: 'GMT+01:00' or 'GMT-02:00'.

Maximum length: 50

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/logEntry"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Find matching addresses

Finds all restricted party addresses matching a given address. Can be used to get more details about matches found via 'screenAddresses'.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses

Body Params

address
object

The address to be screened.

 
address.addressType
string

Either "company", "individual", "vessel", "bank" or 'null' for unknown.

address.name
string

Full name of the address, e.g. name of the company (address line 1 - 4) or prename and surname of an individual.
(max. length: 200)

address.street
string

Street of the address, including house number.
(max. length: 100)

address.pc
string

Postal code of the city.
(max. length: 40)

address.city
string

City of the address.
(max. length: 100)

address.district
string

District of the address, resp. line 2 of the city (in German: Ortsteil).
(max. length: 50)

address.countryISO
string

Two character ISO code of the country, e.g. "US" or "DE".
(max. length: 2)

address.telNo
string

Telephone number.
(max. length: 40)

address.postbox
string

The postbox of the address.
(max. length: 20)

address.pcPostbox
string

The postal code of the postbox, if the postal code of the postbox differs from the postal code of the street address.
(max. length: 40)

address.cityPostbox
string

The city of the postbox, if the city of the postbox differs from the city of the street address.
(max. length: 100)

address.email
string

Email address.
(max. length: 256)

address.fax
string

Fax number.
(max. length: 40)

address.name1
string

Additional information only for companies: The first line of the addresses name.
(max. length: 50)

address.name2
string

Additional information only for companies: The second line of the addresses name.
(max. length: 50)

address.name3
string

Additional information only for companies: The third line of the addresses name.
(max. length: 50)

address.name4
string

Additional information only for companies: The fourth line of the addresses name.
(max. length: 50)

address.title
string

Additional information only for individuals: The title of a person.
(max. length: 20)

address.surname
string

Additional information only for individuals: The surname of a person.
(max. length: 50)

address.prenames
string

Additional information only for individuals: The prenames of a person.
(max. length: 50)

address.dateOfBirth
string

The date of birth in textual representation, e.g. "1962-08-20" or just "1962" or other date formats. (Only human readable.)
(max. length: 20)

address.passportData
string

Additional information only for individuals: Textual information about the passport, e.g. passport no. and date of issue.
(max. length: 200)

address.cityOfBirth
string

Additional information only for individuals: City of birth
(max. length: 50)

address.countryOfBirthISO
string

Additional information only for individuals: Two letter ISO code for the country of birth.
(max. length: 2)

address.nationalityISO
string

Additional information only for individuals: Two letter ISO code for the nationality.
(max. length: 2)

address.position
string

Additional information only for individuals: Textual information about the position of the individual.
(max. length: 200)

address.niNumber
string

Additional identification tokens or numbers of individuals.
(max. length: 50)

address.info
string

Summary additional information, e.g. alias names or information composed of other field like position, passportData, dateOfBirth. It is supposed to display this field to the user instead of
(max. length: 1000)

address.aliasGroupNo
string

Number or name of the group under which all addresses are summarized describing the same person or organization.
(max. length: 20)

address.free1
string

Additional field for future use.
(max. length: 50)

address.free2
string

Additional field for future use.
(max. length: 50)

address.free3
string

Additional field for future use.
(max. length: 50)

address.free4
string

Additional field for future use.
(max. length: 50)

address.free5
string

Additional field for future use.
(max. length: 50)

address.free6
string

Additional field for future use.
(max. length: 50)

address.free7
string

Additional field for future use.
(max. length: 50)

address.referenceId
string

Reference key for match results and logs, e.g. current user, client, pc, delivery note number or debitor number.
This field is for internal technical use to build references between the compliance logs and the client system.
(max. length: 255)

address.referenceComment
string

User readable reference comment for logs, e.g. current user, current pc, delivery note number or or debitor number.
(max. length: 3000)

address.condition
object

An optional condition used for screening of this address. If present, only Good Guys that either have no condition or that meet the condition given here are considered.

 
address.condition.value
string
required

The mandatory condition value. Only Good Guys with exactly the same condition are considered when doing address screening. The {@link #description} can be used as a human-readable description of the condition.
(max. length: 1000)

address.condition.description
string

A short, human readable description of the condition specified by the {@link value}.
(max. length: 255)

screeningParameters
object

Parameters for the screening process.

 
screeningParameters.clientIdentCode
string
required

Ident code of the client to use for screening. The value must be a valid ident code of a client the authorized user has access to (usually the same client used for authentication).
(max. length: 10)

screeningParameters.profileIdentCode
string
required

Ident code of a Compliance profile. The value must be a valid ident code for the client specified by the clientIdentCode.
(max. length: 20)

screeningParameters.threshold
int32

Define the similarity threshold which should be used for address screening. Optionally overrides the value from the Compliance profile used.
Valid values are: 0% to 100%.
Length: 20.

screeningParameters.clientSystemId
string

The unique ID of the host system calling this API. Used when logging the address screening results.
(max. length: 20)

screeningParameters.suppressLogging
boolean

If 'true', the address screening operation will not be logged. If omitted or 'false' the address screening operation will be logged.

screeningParameters.considerGoodGuys
boolean

If 'false' Good Guys will be ignored. If omitted or 'true', Good Guys will be considered. Should only be used if Good Guys should be ignored specifically, i.e. to specifically check a Good Guy similar to the Good Guy screening batch.

screeningParameters.userIdentification
string

The users name to be used for logging. Purely informational.
(max. length: 100)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/findMatchingAddresses"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Get last update date of a restricted party list

Get the date, a restricted party list has last been updated at.

 
gethttps://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate

Query Params

clientIdentCode
string
profileIdentCode
string
 
curl --request GET \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate
var request = require("request");

var options = { method: 'GET',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreening/lastRestrictedPartyListUpdate"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Compliance Screening Applications

 
 
 
Suggest Edits

Statistical data application

Returns an URL that allows you to embed statistical data into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.searchDateFromPattern
date-time

Lower limit for the search period, accurate to the day. Only statistical data recorded on or after this date is shown. Format: yyyy-MM-dd

specificParms.searchDateToPattern
date-time

Upper limit for the search period, accurate to the day. Only statistical data recorded at or before this date is shown. Format: yyyy-MM-dd

specificParms.clientIdentCodePattern
string

Ident code of the client to show statistics for. Must be a valid client ident code the client and user used for authentication has access to. If omitted, the client filter is set according to the authentication user's access rights.
(max. length: 10)

specificParms.profileIdentCodePattern
string

Filter for the Compliance profiles. Optional and only appropriate in combination with a clientIdentCodePattern. If given, must be the ident code of an existing Compliance profile valid for the client filtered for.
(max. length: 20)

specificParms.clientSystemIdPattern
string

Filter for the host system. Can be omitted. When given, statistics are limited to events originating from the given host system.
(max. length: 20)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalData"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Manual log entry editor

Returns an URL that allows you to embed an editor to enter a manual log entry into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.module
string

Default value for the log module, the entry should be created for. If omitted or set to "null", the user has to select the module manually.

specificParms.profileIdentCode
string

Ident code of a Compliance profile. If given, the value must be a valid ident code of a profile valid for the client specified by the clientIdentCode.
(max. length: 20)

specificParms.referenceId
string

Initial value for the reference ID for the note. If omitted, the user can specify the reference ID manually. The reference ID is used to link the log entry to an object or event in a host system.
(max. length: 255)

specificParms.info
string

Initial value for the description of the event, which can be altered by the user.
(max. length: 60000)

specificParms.clientSystemId
string

A unique ID of the host system calling this API.
(max. length: 20)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualLogEntry"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Screening logs overview

Returns an URL that allows you to embed the screening logs overview into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.title
string

The title to be displayed by the application to be opened.

specificParms.referenceIdPattern
string

Filter pattern for the referenceId.
(max. length: 255)

specificParms.clientSystemIdPattern
string

Filter pattern for the clientSystemId.
(max. length: 20)

specificParms.clientIdentCodePattern
string

Filter pattern for the client ident code.
(max. length: 10)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/screeningLogs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Statistical key figures application

Returns an URL that allows you to embed statistical key figures into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.searchDateFromPattern
date-time

Lower limit for the search period, accurate to the day. Only statistical data recorded on or after this date is shown. Format: yyyy-MM-dd

specificParms.searchDateToPattern
date-time

Upper limit for the search period, accurate to the day. Only statistical data recorded at or before this date is shown. Format: yyyy-MM-dd

specificParms.clientIdentCodePattern
string

Ident code of the client to show statistics for. Must be a valid client ident code the client and user used for authentication has access to. If omitted, the client filter is set according to the authentication user's access rights.
(max. length: 10)

specificParms.profileIdentCodePattern
string

Filter for the Compliance profiles. Optional and only appropriate in combination with a clientIdentCodePattern. If given, must be the ident code of an existing Compliance profile valid for the client filtered for.
(max. length: 20)

specificParms.clientSystemIdPattern
string

Filter for the host system. Can be omitted. When given, statistics are limited to events originating from the given host system.
(max. length: 20)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/statisticalKeyFigures"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Restricted party address file

Returns an URL that allows you to embed the restricted party address file into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.internalAddressId
string

The internalAddressId of the address to show. The internalAddressId can be taken from the results returned by 'findMatchingAddresses' or 'aliasAddresses'.
(max. length: 50)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyAddress"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Restricted party list file

Returns an URL that allows you to embed the restricted party list file into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.groupName
string

ID of the restricted party list to view.
(max. length: 10)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/restrictedPartyList"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Manual address screening UI

Returns an URL that allows you to embed manual address screening into another application.

 
posthttps://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening

Body Params

generalParms
object

General technical parameters for the application.

 
generalParms.client
string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

generalParms.user
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

generalParms.language
string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

generalParms.displayFullWorkplace
boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

generalParms.isACEmbedded
boolean

true to display header and statusbar, false if ac should be embedded in another

generalParms.displayStatusbar
boolean

true to display statusbar, false

generalParms.displayTitlebar
boolean

true to display header, false if ac should not show header

generalParms.stylevariant
string

customized styleVariant (one of {@link ProductStyleVariant} for application facade

generalParms.acceptTechnology
string

specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen

generalParms.productname
string

Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAINCASA* -

generalParms.productShortName
string

Optional field, which may be set if productShortName differs from standard product name

generalParms.preferredWidth
int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.preferredHeight
int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

generalParms.openToTray
boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

specificParms
object

Application specific parameters.

 
specificParms.profileIdentCode
string

The ident code of the Compliance profile used for screening. If given, must be a valid ident code of a profile valid for the client used in the general parameters. If omitted, the clients default profile is used.
(max. length: 20)

 
curl --request POST \
  --url https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening
var request = require("request");

var options = { method: 'POST',
  url:
   'https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening");

xhr.send(data);
import requests

url = "https://rz3.aeb.de/test4ce/rest/ComplianceScreeningApplications/manualAddressScreening"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results