Purpose: This article will walk through the process of loading and deleting documents created outside of the Orion into individual Households. These documents will then be available to the clients within the Orion Client Portal.
Simple Use Case: You have a document that was not created with Orion and would like it loaded to the Orion Client Portal.
Scope and Outputs: This solution will be to add and delete client specific documents. It is not intended for mass delivery of generic documents.
Process Overview: Process will show how to view, load, and delete the documents for viewing in the Orion Client Portal. All steps can be done independently from one another.
Process Steps:
1. View or Download documents
To view documents GET:
/Portfolio/Clients/Verbose/{clientID}?expand=documents
To download documents GET: /Portfolio/Clients/{clientID}/Documents/{documentID}/Download? Authorization={Token}
2. Upload New Documents
POST:/Portfolio/Clients/{key}/Documents/
{
"file": {
"fileName": "string",
"mediaType": "string",
"data": {}
},
"openWith": "string",
"blobDesc": "string",
"category": "string",
"blobType": "RPT_1099"
}
3. Delete Documents
GET: /Portfolio/Clients/Verbose/{clientId}?expand=documents
Remove the desired document(s) from the return payload
4. POST: the updated data back to the above endpoint. This best practice allows you to delete multiple files at the same time.
Process Tips or Controls:
1. To Get Category types.
GET /Portfolio/CRMDocuments/Categories
2. POST request as “multipart/form-data”, with the binary data passed in a form field called “file”, and these other form fields also get passed:
