Loading

DFS Client Services API (latest)

Download OpenAPI specification:Download

Contains functionality for managing client data.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

ContactActivation

Activate a contact directly

Activates a contact directly. An activated contact can log in to a client facing app.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact to activate

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/{contactId}/activate
https://example-host/v1.0/contacts/{contactId}/activate

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Activate contact using an activation key

Activates a contact using an activation key. If DFS is the identity provider, response will be populated with information relevant for the next steps following activation.

Authorizations:
path Parameters
activationKey
required
string

The activationKey of the contact to activate

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/activate/{activationKey}
https://example-host/v1.0/contacts/activate/{activationKey}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "contactId": 20,
  • "username": "jim.jones@additiv.ch",
  • "isPasswordSet": true
}

Deactivate a contact directly

Deactivates a contact directly. A deactivated contact cannot log in to a client facing app.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact to deactivate

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/{contactId}/deactivate
https://example-host/v1.0/contacts/{contactId}/deactivate

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Send an activation email to a contact Deprecated

Sends an activation email to a contact. The email contains a generated key with an expiration time that will help the contact activate themselves. An activated contact can log in to a client facing app. If an activationUrl is not specified, the default one will be used.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact to send the activation email to

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

activationUrl
string Nullable

Optional base URL that is used to compose the actual activation link sent in the email. If not specified then the DB dbo.GlobalSettings value 'FrontOfficeActivationContactUrl' in group 'Urls' will be used.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts/{contactId}/activationkey/send
https://example-host/v1.0/contacts/{contactId}/activationkey/send

Request samples

Content type
Copy
Expand all Collapse all
{
  • "activationUrl": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Send an activation email to a contact

Sends an activation email to a contact. The email contains a generated key with an expiration time that will help the contact activate themselves. An activated contact can log in to a client facing app. If an activationUrl is not specified, the default one will be used.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact to send the activation email to

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

activationUrl
string Nullable

Optional base URL that is used to compose the actual activation link sent in the email. If not specified then the DB dbo.GlobalSettings value 'FrontOfficeActivationContactUrl' in group 'Urls' will be used.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/contacts/{contactId}/activationkey/send
https://example-host/v1.1/contacts/{contactId}/activationkey/send

Request samples

Content type
Copy
Expand all Collapse all
{
  • "activationUrl": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

ContactDetails

Retrieve change-request

Retrieves change-request for details of the contact.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact Id

changeRequestId
required
integer <int32>

Change request id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/change-requests/{changeRequestId}
https://example-host/v1.0/contacts/{contactId}/change-requests/{changeRequestId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "uId": "string",
  • "status":
    {
    },
  • "createDate": "2022-03-15T09:48:25Z",
  • "initiatorMember":
    {
    },
  • "initiatorDescription": "string",
  • "reviewDate": "2022-03-15T09:48:25Z",
  • "reviewMember":
    {
    },
  • "reviewDescription": "string",
  • "details":
    [
    ]
}

Enumerate change request statuses

Enumerates change request statuses.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/change-requests/statuses
https://example-host/v1.0/change-requests/statuses

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "changeRequestStatuses":
    [
    ]
}

Search change-requests

Searches change-requests given criteria. A member can only see change requests for contacts which they have access to (with or without hierarchy).

Authorizations:
path Parameters
memberId
required
integer <int32>

Member Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

page
integer <int32>
pageSize
integer <int32>
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
sortBy
string Nullable

Sorting is available for Id, StatusId, CreateDate, InitiatorMemberId, ContactId, ReviewDate, ReviewMemberId. By default, the latest results would be returned first.

includeHierarchy
boolean

Search for change request of directly accessible contacts or include hierarchy accessible contacts as well

statusId
integer <int32> Nullable
createDateFrom
string <date-time> Nullable
createDateTo
string <date-time> Nullable
initiatorMemberIds
Array of integers <int32> Nullable
contactIds
Array of integers <int32> Nullable
reviewDateFrom
string <date-time> Nullable
reviewDateTo
string <date-time> Nullable
reviewMemberIds
Array of integers <int32> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/members/{memberId}/contacts/change-requests/search
https://example-host/v1.0/members/{memberId}/contacts/change-requests/search

Request samples

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortOrder": "Ascending",
  • "sortBy": "string",
  • "includeHierarchy": true,
  • "statusId": 0,
  • "createDateFrom": "2022-03-15T09:48:25Z",
  • "createDateTo": "2022-03-15T09:48:25Z",
  • "initiatorMemberIds":
    [
    ],
  • "contactIds":
    [
    ],
  • "reviewDateFrom": "2022-03-15T09:48:25Z",
  • "reviewDateTo": "2022-03-15T09:48:25Z",
  • "reviewMemberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Cancel a change-request

Cancels a change-request. Cancelling is only possible from “pending” status, and can be done only by the member which initiated the change-request.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact Id

changeRequestId
required
integer <int32>

Change request id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/{contactId}/change-requests/{changeRequestId}/cancel
https://example-host/v1.0/contacts/{contactId}/change-requests/{changeRequestId}/cancel

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

ContactManagement

Retrieve contact details

Retrieves all details saved on a contact.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/details
https://example-host/v1.0/contacts/{contactId}/details

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "hasPendingChangeRequest": true,
  • "details": { }
}

Partially update contact details

Partially updates any of the specified contact’s details. The following limitations apply:

  • All mandatory details defined in the contacts schema should be present following the data update.
  • Additional details outside of the contacts schema are not allowed to be passed.
  • If DFS is configured to derive the username from the contact’s email, and email is passed in context of the call, the endpoint would require a valid and unique email from the user.
  • Arrays must be passed in full.
Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

details
object

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/contacts/{contactId}/details
https://example-host/v1.0/contacts/{contactId}/details

Request samples

Content type
Copy
Expand all Collapse all
{
  • "details": { }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update contact details

Updates contact details in full. All mandatory details defined in the contacts schema should be inputted. Additional details outside of the contacts schema are not allowed. If DFS is configured to derive the username from the contact’s email, the endpoint would require a valid and unique email from the user.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

details
object

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.0/contacts/{contactId}/details
https://example-host/v1.0/contacts/{contactId}/details

Request samples

Content type
Copy
Expand all Collapse all
{
  • "details": { }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve contact external connections Deprecated

This API is deprecated. Use GET /v1.0/contacts/{contactId}/external-connections instead
Retrieves contact external connections (e.g. the CBS or SSO external Id). The Id used for the import service is depicted with system “Default”.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/externalConnections
https://example-host/v1.0/contacts/{contactId}/externalConnections

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "hasPendingChangeRequest": true,
  • "details": { }
}

Add contact external connection Deprecated

This API is deprecated. Use POST /v1.0/contacts/{contactId}/external-connections instead
Adds a contact external connections (e.g. the CBS or SSO external Id). To register an external Id for the import service, input it with system “Default”.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

External connection

externalId
string Nullable
system
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts/{contactId}/externalConnections
https://example-host/v1.0/contacts/{contactId}/externalConnections

Request samples

Content type
Copy
Expand all Collapse all
{
  • "externalId": "string",
  • "system": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve contact external connections

Retrieves contact external connections (e.g. the CBS or SSO external Id). The Id used for the import service is depicted with system “Default”.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/external-connections
https://example-host/v1.0/contacts/{contactId}/external-connections

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "hasPendingChangeRequest": true,
  • "details": { }
}

Add contact external connection

Adds a contact external connections (e.g. the CBS or SSO external Id). To register an external Id for the import service, input it with system “Default”.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

External connection

externalId
string Nullable
system
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts/{contactId}/external-connections
https://example-host/v1.0/contacts/{contactId}/external-connections

Request samples

Content type
Copy
Expand all Collapse all
{
  • "externalId": "string",
  • "system": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Return the profiles of the contact's advisors Deprecated

This API is deprecated. Use GET /v1.0/contacts/{contactId}/member-profiles instead
The endpoint returns the profile(s) of the advisor(s) of the contact.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/memberprofiles
https://example-host/v1.0/contacts/{contactId}/memberprofiles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "advisors":
    [
    ]
}

Return the profiles of the contact's advisors

The endpoint returns the profile(s) of the advisor(s) of the contact.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/member-profiles
https://example-host/v1.0/contacts/{contactId}/member-profiles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "advisors":
    [
    ]
}

Partially update contact details

Partially updates the specified contact’s details which are allowed to be updated by the contact. The allowed fields are configured as part of the contact details schema configuration. The following limitations apply:

  • All mandatory details defined in the contacts schema should be present following the data update.
  • Additional details outside of the contacts schema are not allowed to be passed.
  • If DFS is configured to derive the username from the contact’s email, and email is passed in context of the call, the endpoint would require a valid and unique email from the user.
  • Arrays must be passed in full.
Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

details
object

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/contacts/{contactId}/contact-updatable-details
https://example-host/v1.0/contacts/{contactId}/contact-updatable-details

Request samples

Content type
Copy
Expand all Collapse all
{
  • "details": { }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update the username of a contact

Updates the username of a contact. Endpoint should only be used if DFS is the identity provider and email is not coupled with username. Inputted username must be unique across all contacts.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

External connection

username
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/contacts/{contactId}/username
https://example-host/v1.0/contacts/{contactId}/username

Request samples

Content type
Copy
Expand all Collapse all
{
  • "username": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create a new contact

Creates a new contact. the following applies:

  • If no members were assigned to the contact, the default member is assigned.
  • All mandatory details defined in the contacts schema should be inputted.Additional details outside of the contacts' data schema are not allowed.
  • If DFS is the identity provider, “username” field in the request will be used and is required to be unique across all contacts.If DFS is configured to derive the username from the contact’s email, the “username” field in the request is required to match the contact’s email inputted in the “details” field.
Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

contactTypeId
integer <int32>
memberIds
Array of integers <int32> Nullable
username
string Nullable
details
object

Responses

201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts
https://example-host/v1.0/contacts

Request samples

Content type
Copy
Expand all Collapse all
{
  • "contactTypeId": 0,
  • "memberIds":
    [
    ],
  • "username": "string",
  • "details": { }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "details": null
}

Assign a member to a contact

Assigns a member to a contact. The assigned member and all members with hierarchy access to that member would have access to all contact information.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

memberIds
Array of integers <int32> Nullable

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts/{contactId}/members
https://example-host/v1.0/contacts/{contactId}/members

Request samples

Content type
Copy
Expand all Collapse all
{
  • "memberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Manage member assignment to a contact

Manages member assignment to a contact. The assigned members and all members with hierarchy access to them would have access to all contact information.

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

memberIds
Array of integers <int32> Nullable

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.0/contacts/{contactId}/members
https://example-host/v1.0/contacts/{contactId}/members

Request samples

Content type
Copy
Expand all Collapse all
{
  • "memberIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

ImportManagement

Import contact data files

Imports contact JSON data files to dedicated storage.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/import/import-file
https://example-host/v1.0/contacts/import/import-file

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "files":
    [
    ]
}

Sync contact data

Syncs contact data files from dedicated storage to DFS System Tables. Each contact entry specified in the files would either create a new contact in DFS or update an existing one depending on prior existence of a contact with the specified externalId. See import documentation for more information on data structure required to execute the endpoint successfully.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/contacts/import/sync-data
https://example-host/v1.0/contacts/import/sync-data

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "failedExternalIds":
    [
    ]
}

LegalEntity

Get details of legal entity

Gets details of a legal entity

Authorizations:
path Parameters
legalEntityId
required
integer <int32>

Legal entity id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/legalentities/{legalEntityId}/details
https://example-host/v1.0/legalentities/{legalEntityId}/details

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "contactGroupId": 0,
  • "details": null
}

Update legal entity's details

Updates a legal entity's details

Authorizations:
path Parameters
legalEntityId
required
integer <int32>

Legal entity id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

details
any

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/legalentities/{legalEntityId}/details
https://example-host/v1.0/legalentities/{legalEntityId}/details

Request samples

Content type
Copy
Expand all Collapse all
{
  • "details": null
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get details of legal entity by a contact or a member in the scope of a contact

Gets details of a legal entity by a contact or a member in the scope of a contact

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

legalEntityId
required
integer <int32>

Legal entity id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contacts/{contactId}/legalentities/{legalEntityId}/details
https://example-host/v1.0/contacts/{contactId}/legalentities/{legalEntityId}/details

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "contactGroupId": 0,
  • "details": null
}

Create legal entity

Creates a legal entity

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

contacts
Array of objects (LegalEntityContactAccessPolicyRequest) Nullable
details
any

Responses

201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/legalentities
https://example-host/v1.0/legalentities

Request samples

Content type
Copy
Expand all Collapse all
{
  • "contacts":
    [
    ],
  • "details": null
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "details": null
}

SchemaManagement

Retrieve schema information

Retrieves schema information. This includes the schema components, JSON schema and fields metadata.

Authorizations:
path Parameters
key
required
string

Schema key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/{key}
https://example-host/v1.0/schemas/{key}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "key": "string",
  • "schema": "string",
  • "jsonSchema": "string",
  • "concurrencyToken": 0
}

Update schema definition

Updates schema definition. Updating the schema will automatically update the JSON schema and fields metadata. Should not be used outside of the schema editor.

Authorizations:
path Parameters
key
required
string

The parameter key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

schema
string Nullable
jsonSchema
string Nullable
concurrencyToken
integer <int64>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.0/schemas/{key}
https://example-host/v1.0/schemas/{key}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "schema": "string",
  • "jsonSchema": "string",
  • "concurrencyToken": 0
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "concurrencyToken": 0
}

Retrieve JSON schema Deprecated

This API is deprecated. Use GET /v1.0/schemas/{key}/json-schema instead
Retrieves JSON schema for the specified schema. Use for external validation of dynamic data.

Authorizations:
path Parameters
key
required
string

Schema key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/{key}/jsonSchema
https://example-host/v1.0/schemas/{key}/jsonSchema

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "jsonSchema": "string"
}

Retrieve JSON schema

Retrieves JSON schema for the specified schema. Use for external validation of dynamic data.

Authorizations:
path Parameters
key
required
string

Schema key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/{key}/json-schema
https://example-host/v1.0/schemas/{key}/json-schema

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "jsonSchema": "string"
}

Retrieve all lists items

Retrieves all lists items used in Client Services.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/schemas/lists/items
https://example-host/v1.0/schemas/lists/items

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Retrieve list items of a specific list

Retrieve list items of a specific list used in Client Services.

Authorizations:
path Parameters
listKey
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/lists/{listKey}/items
https://example-host/v1.0/schemas/lists/{listKey}/items

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ]
}

Retrieve fields metadata Deprecated

This API is deprecated. Use GET /v1.0/schema/{key}/fields-metadata instead
Retrieves attributes of fields in the schema and on special properties of them in order to render contact lists.

Authorizations:
path Parameters
key
required
string

Schema key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/{key}/fields
https://example-host/v1.0/schemas/{key}/fields

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fields":
    [
    ]
}

Retrieve fields metadata

Retrieves attributes of fields in the schema and on special properties of them in order to render contact lists.

Authorizations:
path Parameters
key
required
string

Schema key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/schemas/{key}/fields-metadata
https://example-host/v1.0/schemas/{key}/fields-metadata

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fields":
    [
    ]
}