TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: getDocumentFolders


getDocumentFolders

POST

/api/widget/getDocumentFolders

Able to request a list of document folders by record type.

Sample Request:

{
      "trackerrms": {
             "getDocumentFolders": {
                    "credentials": {
                          "username": "my.name@domain.com",
                          "password": "Welcome123",
                          "oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
                    },
                    "instructions": {
                          "recordtype": "O",
                          "recordid": 1234
                   }
             }
      }
}

Sample Response:

{
      "status": 0,
      "message": "success",
      "count": 2,
      "results": [
             {
             "id": 1,
             "name": "Contracts”
             },
             {
             "id": 2,
             "name": "Registration Documents”
             }
      ]
}

 

Record Types:

C

Clients

N

Contacts

L

Leads

O

Opportunities

P

Projects

T

Tickets

R

Resources

 

Response status codes:

0

success

1

user not found

2

user not active

99

Invalid request