getIndividualRecord
|
POST |
/api/widget/getIndividualRecord |
Able to request a single record from the api. Results will return extended information about a single record.
Must provide both "recordtype" and "recordid" in the instructions.
Sample Request:
{
"trackerrms": {
"getIndividualRecord": {
"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": 1,
"results": [
{
"id": 3111,
"name": "Private Secretary",
"clientid": 34676,
"clientname": "LEGAL AND GENERAL",
"contactid": 336,
"contactname": "Heather Smith",
"status": "Active",
"type": null,
"values": null,
"shortlisted": null,
"description": "Private Secretary",
"executivesummary": [
{
"recordName": "Status",
"recordValue": "Active"
},
{
"recordName": "Type",
"recordValue": "Contract"
},
{
"recordName": "Value",
"recordValue": "$0.00"
},
{
"recordName": "Shortlisted",
"recordValue": "2"
}
],
"nameinitials": "J",
"subject": "JOB-3111 Private Secretary",
"lastupdated": null,
"Owners": [],
"salarypayrate": 10.0,
"feebillrate": 20.0,
"location": null,
"city": null,
"state": null,
"awarddate": null,
"startdate": null,
"enddate": null,
"invoicestartdate": null,
"Placements": [
{
"PlacementId": 3000,
"CandidateId": 188,
"CandidateName": "Tasmin Brown"
}
]
}
]
}
Supported record types:
|
L |
Leads |
|
O |
Opportunities |
|
P |
Projects |
|
T |
Tickets |
|
A |
Activities |
Response status codes:
|
0 |
success |
|
1 |
user not found |
|
2 |
user not active |
|
99 |
Invalid request |