Versions Compared

Version Old Version 2 New Version Current
Changes made by

Martin Haluza

Martin Haluza

Saved on

Key

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


Note
titleIn development

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

ServiceNoteParametersVFP client methodConsole client actionServer path
Upload report

XmlFileName

RemotePath

Order

RIC_ReportsAPIClient.Upload

UPLOADREPORT

POST api/files/<RemotePath>

Note: The order parameter controls the reports ordering in the web application

Upload exported report

XmlFileName

Type

RemotePath

Order

RIC_ReportsAPIClient.UploadExportedFileUPLOADEXPORTEDFILEPOST api/files/<RemotePath>
Upload binary

FileName

RemotePath

Type

Order

RIC_ReportsAPIClient.UploadBinaryUPLOADFILEPOST api/files/uploadfile?path=<RemotePath>

Notes:

  • Upload a binary file, such as a PDF or an image
  • PDFs and Images are automatically preview, the rest of binary files can be downloaded
  • Use the file extension as the Type parameter (PDF, ZIP, DOCX, etc.), it is also used as an extension of the downloaded file.
Image reportA 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

TypeDescription
RIC_IDstring
RIC_Namestring
RIC_SubDomainNamestring
RIC_LoginMessagestring
RIC_UserQuotaint
RIC_AdminUserNamestring
RIC_AdminUserPasswordstring
RIC_BaseURLstring
RIC_TotalUsersint
RIC_QuotaKBint
RIC_TotalSizeKBint
RIC_TotalReportsint
RIC_DefaultLanguagestring




Methods

Create

Add

Organization

Get

Update

Open

Close

Users

Roles

Properties Dictionary

Folders

Reports

Table of Contents
outlinetrue