API – Tenant Files

General

This article explains how to pull tenant file information via the API.

Getting Tenant Files

To get a list of tenant files, send a GET request to the following URL:

GET https://loanpro.simnang.com/api/public/api/1/files/Tenant

The response will contain an array of objects for each file.

Expand Full Response
Here's a sample of what that response might look like, with two files saved:
{
"d": {
"results": [
{
"id": "297",
"parentType": "Tenant",
"parentId": "5200243",
"fileName": "_1605026708_5faac39420880.",
"fileOriginalName": "test_heart",
"fileSize": "11191",
"fileMime": "image/jpeg",
"created": "2020-11-10 16:45:08",
"active": "1",
"url": "https://fandora-content.s3.amazonaws.com/tenants/5200243/fileAttachments/_1605026708_5faac39420880."
},
{
"id": "300",
"parentType": "Tenant",
"parentId": "5200243",
"fileName": "_1605027044_5faac4e40c6e5.",
"fileOriginalName": "test_heart3",
"fileSize": "11168",
"fileMime": "image/jpeg",
"created": "2020-11-10 16:50:44",
"active": "1",
"url": "https://fandora-content.s3.amazonaws.com/tenants/5200243/fileAttachments/_1605027044_5faac4e40c6e5."
}
]
}
}

Uploading

To add a tenant file, send a POST request to the following URL:

POST https://loanpro.simnang.com/api/public/api/1/files/Tenant/false

(replace “false” with “true” to make the file publicly available)

The body will then be formatted as follows:

—————————–1661761877511986552862541093

Content-Disposition: form-data; name=”upload”; filename=”(file name here)”

Content-Type: (file content type here)(file contents here)

—————————–1661761877511986552862541093–

Deleting

To delete tenant files, send a DELETE request to a URL formatted as follows:

https://loanpro.simnang.com/api/public/api/1/files/Tenant/<id>/false

  • “<id>” – The ID of the tenant file

Getting the Homepage Image

To get the URL for a homepage image, send a GET request to a URL formatted as follows:

https://loanpro.simnang.com/api/public/api/1/files/customer.website/homepage.image({id})

  • Replace {id} with the ID of the homepage image to get


How did we do?


Powered by HelpDocs (opens in a new tab)