Versions Compared

Version Old Version 30 New Version Current
Changes made by

Manus Muller

Manus Muller

Saved on

Key

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

...

Breaking changes are listed where relevant. Breaking changes are any changes in resource paths, changing of payload structures, or fixing HTTP verbs and response codes. This may require development.

Info
Note -

  • Events are sent sequentially and in

realtime

  • real-time but upon receiving an event, a sequential order cannot be guaranteed.

  • ALL API endpoints have a 10MB hard restriction on the payload

...

New fields added to Client Model

Status
colourYellow
titleUK SANDBOX

Three new fields have been exposed in the Client Model

This extensionData is only available under the ARKEN application value.

Code Block
"extensionData": {
  "preferred": "string",
  "referred": "string"
}

The preferred value switches to display the below methods of the preferred contact

The referred value stores how the client’s partner should be referred to.

Code Block
"preferredContactMethod": "string"

...

Delete All Documents per Client Endpoint - Hard Delete functionality

Status
colourYellow
titleUK SANDBOX
Status
colourGreen
titleUK PROD

A new endpoint is available to delete ALL the documents for a specific client:

Status
colourRed
titleDELETE
/documentdata/account/client

The AccountHashId and ClientHashId are mandatory fields. This endpoint will remove all the documents for the client but not the client itself.

Any

Status
colourRed
titleDELETE
function will now immediately delete the request object.

...

New Client and Document Delete Endpoints are available

Status
colourYellow
titleUK SANDBOX
Status
colourGreen
titleUK PROD

Two new endpoints are available:

Status
colourRed
titleDELETE
/client and
Status
colourRed
titleDELETE
/documentdata

Deleting a Client will not remove all the documents linked with the Client. This will be changed in a future update.

...

New Sandbox Environment available

Status
colourYellow
titleUK SAndbox

Info

Breaking changes

The previous

Status
colourYellow
titleUK preprod
environment has been removed and a new Sandbox environment has been created.

The only visible change is the API URL to https://api.sandbox.arken.legal, however, the existing

Status
colourYellow
titleUK PREPROD
environment is deprecated and the URL will be inaccessible.

Furthermore, the Arken Professional application was also moved to a new location.

All the data from the

Status
colourYellow
titleUK PREPROD
is still intact and relevant.

See UK Sandbox API Endpoints (api.sandbox.arken.legal) for further details.

...

New Client Search by Application Endpoint available

Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

A new endpoint is available: /client/search/account/application

The endpoint will return an array of clients filtered by application type and the search query.

For large result sets, the pageRowsCount parameter can be set to an integer which will return that amount of Clients. Omitting this parameter will return ALL clients however, this can add process time to the result. We recommend setting this to 10 or less.

...

Production Public API live

Status
colourGreen
titleUK PROD

The Public API is now live for Production. See the UK Prod API Endpoints (api.uk.pro.arken.legal) documentation on available endpoints.

...

Added application type to Client Model

Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

Info

Breaking changes

The application type is now mandatory to pass in when creating

Status
colourGreen
titlePOST
or updating
Status
colourYellow
titlePUT
a client. The application will be in the response body.

If the client is from a CRM system set the application to ‘CRM’

Code Block
"application" : "CRM",

By setting the application to CRM, additional information can now be saved in the extensionData field. See the CRM Integration functionality to Client changelog

To create or update a normal Arken client set the application to ‘ARKEN’ as part of the Client Model

Code Block
"application" : "ARKEN",

...

Added CRM Integration functionality to Client

Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

A client created in a CRM system should be created with the application set to ‘CRM’ as part of the Client Model

Code Block
"application" : "CRM",

This allows to pass in further CRM related fields:

  • The CRM Model. This is the name of the CRM Integration and is a constant value

  • The CRM Client ID can be used to save the client ID used in the CRM system

  • The CRM Matter ID is to add Matter references used when adding a document in Arken Professional

    Code Block
    "extensionData" : {
      	"CRMModel" : "string",
        "CRMClientId" : "string",
        "CRMMatterId" : ["string", "string"...]
}

All field names are case-sensitive. CRMMatterId is an array and requires the block brackets in the request body.

...

Removed Occupation from Client Model

Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

The occupation Client field is deprecated and removed from the Client Model. All Client API calls correctly reflect this Model change.

Code Block
...
"occupation": "string",

...

Updated DocumentData to correct content response

Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

All /documentdata calls now correctly return the content field value as an empty JSON object.

Code Block
"content": {},

...

Added Current Document Key to DocumentData

...

The purpose of this change was to stop the /file GET method from creating an event, which in turn stops any polling from constantly creating repeating events.

See Public API documentation for more details on calls and webhook events.

...