Follow

Uploading Documents

Document Headers List for a given Organisation

GET https://app.connectworks.com/restapi/v1/documents/organisation-{organisation_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/organisation-1056

Example Response:

[
{
"title": "doc1",
"minuteId": 7103,
"minuteStatus": "PUBLISHED",
"links": []
},
{
"title": "doc2",
"minuteId": 7102,
"minuteStatus": "PUBLISHED",
"links": []
}]

Document Headers List for a given Related Organisation and Organisation

GET https://app.connectworks.com/restapi/v1/documents/related-{related_organisation_id}/organisation-{organisation_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/related-1234/organisation-1056

Example Response:

[
{
"title": "doc1",
"minuteId": 7103,
"minuteStatus": "PUBLISHED",
"links": []
},
{
"title": "doc2",
"minuteId": 7102,
"minuteStatus": "PUBLISHED",
"links": []
}]

Single Document Header for a given Organisation

GET https://app.connectworks.com/restapi/v1/documents/organisation-{organisation_id}/documentheader-{document_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/organisation-1056/documentheader-7103

Example Response:

{
"title": "doc1",
"minuteId": 7103,
"minuteStatus": "PUBLISHED",
"links": []
}

Single Document Header for a given Related Organisation and Organisation

GET https://app.connectworks.com/restapi/v1/documents/related-{related_organisation_id}/organisation-{organisation_id}/documentheader-{document_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/related-1234/organisation-1056/documentheader-7103

Example Response:

{
"title": "doc1",
"minuteId": 7103,
"minuteStatus": "PUBLISHED",
"links": []
}

Single Document File for a given Organisation

GET https://app.connectworks.com/restapi/v1/documents/organisation-{organisation_id}/documentfile-{document_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/organisation-1056/documentfile-7103

Example Response:

A binary stream

Single Document File for a given Related Organisation and Organisation

GET https://app.connectworks.com/restapi/v1/documents/related-{related_organisation_id}/organisation-{organisation_id}/documentfile-{document_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/documents/related-1234/organisation-1056/documentfile-7103

Example Response:

A binary stream

Upload a Document

POST https://app.connectworks.com/restapi/v1/documents/

Parameters Required Comment
title Yes Title of the document.
organisation_id Yes Organisation ID.
related_organisation_id No Firm's ID (if not accessing the organisation directly)
file Yes Multipart File.
document_type No

See Document Types


Default: OTHER
signing_type No NONE, TRUSTEES.
Default: NONE
witness_required No TRUE, FALSE
Default: FALSE
signing_message No Signing message text.
signatories No See Relationships -> Signatories for an Organisation
post_date No Post date of the document (format "DDMMYYYY").
If omitted, the document will require signing.

 Example Request:

curl -v -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" -F "title=Document Title" -F "person_role_id=1234" -F "organisation_id=1056" -F "file=@/home/user/somefile.pdf" https://app.connectworks.com/restapi/v1/documents/

Example Response:

{
"canDelete": true,
"id": 7103,
"version": 2,
"trustId": 1056,
"postDate": 1426647726000,
"title": "Document Title",
"type": "DOCUMENT",
"lifecycleStatus": "CREATING",
"signingInProgress": false,
"historic": false,
"userAuthor": false,
"documentType": "OTHER",
"documentSize": 0,
"creationDate": 1426647726000,
"totalActivities": -1,
"activities": [],
"signatories": [],
"userPending": false,
"userRejected": false,
"userApproved": false,
"draft": false,
"witnessRequired": false,
"currentFileReference": "files/1520/7104/file.pdf",
"authorCsr": false,
"_type": "MinuteResult"
}

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk