Virima API Specification - Document Services

The requests documented in this section are directed to Document resources, which represent .

Contents

1 listAllDocs GET Interface
2 listAllDocsAssociatedWithRec GET Interface
3 associateDoc POST Interface
4 deassociateDoc POST Interface
5 deleteFile POST Interface
6 downloadDoc GET Interface

listAllDocs GET Interface

Method: GET

Relative URL: document/list-all-docs

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

listAllDocsAssociatedWithRec GET Interface

Method: GET

Relative URL: document/list-all-docs-associated-with-rec/id/recordtype

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

associateDoc POST Interface

Method: POST

Relative URL: document/associate-doc

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
associateDocParamter	RecordDocParameter

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ASSOCIATEDOC 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordid":"?",
   "documentid":"?",
   "recordtype":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deassociateDoc POST Interface

Method: POST

Relative URL: document/deassociate-doc

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deassociateDocParameter	RecordDocParameter

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DEASSOCIATEDOC 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordid":"?",
   "documentid":"?",
   "recordtype":"?"
}

Example Response:

{
   "id":666120500,
   "response":"?"
}

deleteFile POST Interface

Method: POST

Relative URL: document/delete-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
id	RecordID

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEFILE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

downloadDoc GET Interface

Method: GET

Relative URL: document/download-doc/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}