Versions Compared
| Version | Old Version 4 | New Version 5 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Note | ||
|---|---|---|
| ||
Please note: this wiki page is currently a work in progress. In the meantime, please consult the demo application for API usage details: https://bitbucket.org/eqeuscom/ricsamples/src/master/RICAPIClientVFP/ricdemo.PRG |
Web Services
| Service | Note | Parameters | VFP client method | Console client action | Server path |
|---|---|---|---|---|---|
| Upload report | XmlFileName RemotePath Order | RIC_ReportsAPIClient.Upload | UPLOADREPORT | POST api/files/<RemotePath> | |
| Upload exported report | XmlFileName Type RemotePath Order | RIC_ReportsAPIClient.UploadExportedFile | UPLOADEXPORTEDFILE | POST api/files/<RemotePath> | |
| Upload binary | Upload a binary file, such as a PDF or an image | FileName RemotePath Type Order | RIC_ReportsAPIClient.UploadBinary | UPLOADFILE | POST api/files/uploadfile?path=<RemotePath> |
| Image report | A report where individual pages are stored as images | ImageFileName RemotePath Order PageIndex Insert | N/A | UPLOADIMAGEREPORT | POST api/files/imagereport?page={0}&insert={1}&path={2} |
Organization
Data Structures
Organization
Field name | Type | Description |
|---|---|---|
| RIC_ID | string | |
| RIC_Name | string | |
| RIC_SubDomainName | string | |
| RIC_LoginMessage | string | |
| RIC_UserQuota | int | |
| RIC_AdminUserName | string | |
| RIC_AdminUserPassword | string | |
| RIC_BaseURL | string | |
| RIC_TotalUsers | int | |
| RIC_QuotaKB | int | |
| RIC_TotalSizeKB | int | |
| RIC_TotalReports | int | |
| RIC_DefaultLanguage | string | |
Methods
Create
Add
Get
Update
Open
Close
Users
Roles
Properties Dictionary
Folders
Reports
| Table of Contents | ||
|---|---|---|
|