TrackerRMS Help

Your one-stop shop for help on TrackerRMS

Back to Topics

Help Topic: attachDocument


attachDocument

POST

/api/widget/attachDocument

Example of payload of data to the api in order to attach a new document to a record in Tracker.

Sample Request:

{
    "trackerrms": {
        "attachDocument": {
            "credentials": {
                "username": "",
                "password": "",
                "oauthtoken": "",
                "apikey": ""
            },
            "file": {
                "filename": "SampleResume.docx",
                "recordType": "R",
                "recordId": 188077,
                "documentType": "resume",
                "primary": "n",
                "data": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAA..."
            }
        }
    }
}

Sample Response:

{
   "status": 0,
   "message": "success",
   "count": 0
}

Response status codes:

0

success (message will be “created” or “updated”)

1

user not found

2

user not active

3

record found and cannot be overwritten

99

Invalid request

 

File Information

"data" is a Base64 encoded binary (the file type will be determined by the "filename" provided).

 

recordType:

C

Clients

N

Contacts

L

Leads

O

Opportunities

P

Projects

T

Tickets

R

Resources

The recordId must be the Tracker ID for the record to attach the Activity to.

 

documentType:

general

Miscellaneous documents

resume

CV/Resume

photo

Contact or Candidate Photo

specification

Job Description/Specification

logo

Conmpany Logo

agencyresume

Formatted CV/Resume