Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns the external role account matching the ID specified.

HTTP method

URI scheme

GET

/server/external-role-account/{roleAccountId}

Parameters

Type

Name

Description

Qualification

Schema

Path

roleAccountId

The ID of the external role account.

Required

string

Responses

HTTP code

Common messages

Description

Schema

200

The external role account.

ExternalRoleAccount

400

The application with the specified key could not be found

String

The role account ID '

%1

<%1>' does not match the company ID '

%2

<%2>'.

%1

<%1> is the role account ID specified via the URL.

%2

<%2> is the company ID associated with the submitted application key.

String

Invalid role ID format

This error message is returned when the role account ID supplied is incomplete.

String

Role account not found!

String

Security

Type

Name

apiKey

Key