Profit.co's Public API Documentation
Submit Review
POST https://api.profit.co/app/dao/v6/reviews?a=update&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>
Body
PARAM
| Key | Datatype | Required | Description |
a
|
string | action type | |
apiKey
|
string | Required: API key of your Profit.co Account | |
accessKey
|
string | Required: Access key of your Profit.co Account |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status
Curl
curl -X POST 'https://api.profit.co/app/dao/v6/reviews?a=update&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>?a=update&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>' -F '{"name"=>"reviewData", "value"=>"{\"reviewId\":136044,\"objectId\":8,\"objectRefId\":2096509,\"name\":\"Employee Performance Review Q3 - 2021\",\"description\":\"<p id=\\\"tinyEle\\\" class=\\\"\\\" data-after-content=\\\"\\\">Test Description</p>\",\"statusId\":2,\"objectStatus\":\"0\",\"reviewers\":[{\"objectId\":8,\"objectRefId\":2100696,\"objectChecked\":false,\"isLandscape\":false,\"statusCode\":\"NOT_STARTED\",\"paby\":\"EMPLOYEE\",\"ed\":\"2021-09-25 23:59:59\"},{\"objectId\":8,\"objectRefId\":2100697,\"objectChecked\":false,\"isLandscape\":false,\"statusCode\":\"NOT_STARTED\",\"paby\":\"EMPLOYEE\",\"irep\":\"Y\",\"ed\":\"2021-09-25 23:59:59\"}],\"reviewType\":\"EMPLOYEE\",\"reviewPeriods\":[{\"calendarPeriodId\":21,\"calendarType\":\"Accounting\",\"periodName\":\"SEP-2021\",\"periodCode\":\"SEP-2021\",\"periodNumber\":9,\"fiscalYear\":\"FY 2021\",\"quarter\":\"Q3\",\"quarterStartDate\":\"2021-07-01 00:00:00\",\"quarterEndDate\":\"2021-09-30 00:00:00\",\"calendarId\":2014315,\"year\":2021,\"periodStatus\":\"Never Opened\",\"startDate\":\"2021-09-01 00:00:00\",\"endDate\":\"2021-09-30 00:00:00\",\"firmId\":254137,\"version\":0}],\"reviewStartDate\":\"2021-07-01 00:00:00\",\"reviewEndDate\":\"2021-09-30 00:00:00\",\"parentReviewId\":136043,\"reviewResponses\":[{\"reviewId\":136044,\"reviewedByObjId\":8,\"reviewedByObjRefId\":2096509,\"criteriaId\":10,\"reviewedForObjId\":8,\"reviewedForObjRefId\":2096509,\"ratingId\":3,\"ratingLevel\":\"INDIVIDUAL\",\"ratingScore\":3,\"cgid\":999999},{\"reviewId\":136044,\"reviewedByObjId\":8,\"reviewedByObjRefId\":2096509,\"criteriaId\":1,\"reviewedForObjId\":8,\"reviewedForObjRefId\":2096509,\"ratingId\":5,\"comments\":\"<p id=\\\"tinyEle\\\">Test Comment</p>\",\"ratingLevel\":\"INDIVIDUAL\",\"ratingScore\":5,\"cgid\":999999},{\"reviewId\":136044,\"reviewedByObjId\":8,\"reviewedForObjId\":8,\"reviewedByObjRefId\":2096509,\"reviewedForObjRefId\":2096509,\"ratingLevel\":\"REVIEW_CONVERSATION_FEEDBACK\",\"customAttributes\":[]}],\"masterReviewStatusCode\":\"INITIATED\",\"initiatedBy\":2096509,\"autoClosedOn\":\"2021-09-30 00:00:00\",\"gracePeriod\":2,\"ti\":200,\"tn\":\"Standard\",\"tc\":\"STANDARD\",\"reviewRatings\":[{\"ratingId\":1,\"name\":\"Unsatisfactory\",\"isEnabled\":\"Y\",\"ratingScore\":1,\"colorCode\":\"#fc8b65\",\"actualValue\":1},{\"ratingId\":2,\"name\":\"Need Improvements\",\"isEnabled\":\"Y\",\"ratingScore\":2,\"colorCode\":\"#febb50\",\"actualValue\":2},{\"ratingId\":3,\"name\":\"Satisfactory\",\"isEnabled\":\"Y\",\"ratingScore\":3,\"colorCode\":\"#ffeb3c\",\"actualValue\":3},{\"ratingId\":4,\"name\":\"Commendable\",\"isEnabled\":\"Y\",\"ratingScore\":4,\"colorCode\":\"#9ace69\",\"actualValue\":4},{\"ratingId\":5,\"name\":\"Outstanding\",\"isEnabled\":\"Y\",\"ratingScore\":5,\"colorCode\":\"#58bc8a\",\"actualValue\":5}],\"aqId\":\"kF3hw3sBWQ5Na8qaHYfR\",\"rk\":\"29Vl12765D10kc69685m1784G5S25w4q\",\"srae\":\"Y\",\"sae\":\"Y\",\"esoce\":\"Y\",\"hsoce\":\"Y\",\"prp\":[{\"ne\":\"Self Assessment \",\"code\":\"SELF_ASSESSMENT\",\"ed\":\"2021-09-15 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-14T18:30:00.000Z\"},{\"ne\":\"Manager Assessment\",\"ie\":\"Y\",\"code\":\"MANAGER\",\"ed\":\"2021-09-20 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-19T18:30:00.000Z\"},{\"ne\":\"Peer Assessment\",\"ie\":\"Y\",\"code\":\"PEER_ASSESSMENT\",\"ed\":\"2021-09-25 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-24T18:30:00.000Z\"},{\"ne\":\"Secondary Reviewer Assessment\",\"pps\":[\"Manager's Manager\"],\"ie\":\"Y\",\"code\":\"SECONDARY_REVIEWER_ASSESSMENT\",\"ed\":\"2021-09-27 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-26T18:30:00.000Z\"},{\"ne\":\"Employee Sign-off\",\"pps\":[\"Employee\"],\"ie\":\"Y\",\"code\":\"EMPLOYEE_SIGN_OFF\",\"version\":0},{\"ne\":\"HR Sign-off\",\"pps\":[\"HR\"],\"ie\":\"Y\",\"code\":\"HR_SIGN_OFF\",\"nae\":\"N\",\"version\":0}],\"rvsh\":\"Y\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"creationDate\":\"2021-09-08 10:58:34\",\"lastUpdateDate\":\"2021-09-08 11:09:15\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":3,\"employeeIdx\":{\"loginEnabled\":\"Y\",\"firstName\":\"Gcp\",\"lastName\":\"Test\",\"employeeNumber\":\"1\",\"fullName\":\"Gcp Test\",\"objectId\":8,\"objectRefId\":2096509,\"employeeId\":2096509,\"objectName\":\"Employee\",\"emailId\":\"Gcpmobile@berijam.com\",\"nameAsIcon\":\"GT\",\"uniqueColor\":\"#2d3436\",\"objectStatus\":\"0\",\"userId\":2084198,\"okrScoreId\":5,\"jobTitleName\":\"Assistant Vice President\",\"name\":\"Gcp Test\",\"subordinateEmpIds\":[],\"iwte\":\"Y\",\"profileImageUrl\":\"https://d3tftv5yijcm18.cloudfront.net/254137:2084198:10038?fileName=Thumbnail_Title (1).jpg\",\"profileBackground\":\"url(\\\"https://d3tftv5yijcm18.cloudfront.net/254137:2084198:10038?fileName=Thumbnail_Title (1).jpg\\\") center\",\"gradeName\":\"\",\"teamIds\":[2017500,2017482,2017463,2017464],\"objectRefName\":\"Gcp Test\",\"departmentIds\":[2254084,2254083,2254080,2254078,2254077,2254076,2254075,2254074,2252397,2252396,2252395,2252177,2244101,2244099],\"ownerTypeId\":8,\"ROLE\":\"EMPLOYEE\"},\"parentReview\":{\"reviewId\":136043,\"name\":\"Employee Performance Review Q3 - 2021\",\"description\":\"<p id=\\\"tinyEle\\\" class=\\\"\\\" data-after-content=\\\"\\\">Test Description</p>\",\"statusId\":1,\"statusName\":\"Self Assessment\",\"objectStatus\":\"0\",\"reviewType\":\"MASTEREMPLOYEE\",\"reviewPeriods\":[{\"calendarPeriodId\":21,\"calendarType\":\"Accounting\",\"periodName\":\"SEP-2021\",\"periodCode\":\"SEP-2021\",\"periodNumber\":9,\"fiscalYear\":\"FY 2021\",\"quarter\":\"Q3\",\"quarterStartDate\":\"2021-07-01 00:00:00\",\"quarterEndDate\":\"2021-09-30 00:00:00\",\"calendarId\":2014315,\"year\":2021,\"periodStatus\":\"Never Opened\",\"startDate\":\"2021-09-01 00:00:00\",\"endDate\":\"2021-09-30 00:00:00\",\"firmId\":254137,\"version\":0}],\"reviewStartDate\":\"2021-07-01 00:00:00\",\"reviewEndDate\":\"2021-09-30 00:00:00\",\"masterReviewStatusCode\":\"INITIATED\",\"initiatedBy\":2096509,\"autoClosedOn\":\"2021-09-30 00:00:00\",\"gracePeriod\":2,\"ti\":200,\"tn\":\"Standard\",\"tc\":\"STANDARD\",\"iaae\":\"N\",\"reviewRatings\":[{\"ratingId\":5,\"name\":\"Outstanding\",\"isEnabled\":\"Y\",\"ratingScore\":5,\"colorCode\":\"#58bc8a\"},{\"ratingId\":4,\"name\":\"Commendable\",\"isEnabled\":\"Y\",\"ratingScore\":4,\"colorCode\":\"#9ace69\"},{\"ratingId\":3,\"name\":\"Satisfactory\",\"isEnabled\":\"Y\",\"ratingScore\":3,\"colorCode\":\"#ffeb3c\"},{\"ratingId\":2,\"name\":\"Need Improvements\",\"isEnabled\":\"Y\",\"ratingScore\":2,\"colorCode\":\"#febb50\"},{\"ratingId\":1,\"name\":\"Unsatisfactory\",\"isEnabled\":\"Y\",\"ratingScore\":1,\"colorCode\":\"#fc8b65\"}],\"ato\":[],\"rs\":\"ALL\",\"jb\":\"2021-06-01 00:00:00\",\"tuc\":3,\"rk\":\"GwSk5J40l086F819a93lkS9wV38T58pm\",\"srae\":\"Y\",\"sae\":\"Y\",\"esoce\":\"Y\",\"hsoce\":\"Y\",\"prp\":[{\"ne\":\"Self Assessment \",\"code\":\"SELF_ASSESSMENT\",\"ed\":\"2021-09-15 23:59:59\",\"version\":0},{\"ne\":\"Manager Assessment\",\"ie\":\"Y\",\"code\":\"MANAGER\",\"ed\":\"2021-09-20 23:59:59\",\"version\":0},{\"ne\":\"Peer Assessment\",\"ie\":\"Y\",\"code\":\"PEER_ASSESSMENT\",\"ed\":\"2021-09-25 23:59:59\",\"version\":0},{\"ne\":\"Secondary Reviewer Assessment\",\"pps\":[\"Manager's Manager\"],\"ie\":\"Y\",\"code\":\"SECONDARY_REVIEWER_ASSESSMENT\",\"ed\":\"2021-09-27 23:59:59\",\"version\":0},{\"ne\":\"Employee Sign-off\",\"pps\":[\"Employee\"],\"ie\":\"Y\",\"code\":\"EMPLOYEE_SIGN_OFF\",\"version\":0},{\"ne\":\"HR Sign-off\",\"pps\":[\"HR\"],\"ie\":\"Y\",\"code\":\"HR_SIGN_OFF\",\"nae\":\"N\",\"version\":0}],\"gds\":[],\"dbed\":2,\"rvsh\":\"Y\",\"extdys\":5,\"firmId\":254137,\"customAttributes\":[],\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"creationDate\":\"2021-09-08 10:58:34\",\"lastUpdateDate\":\"2021-09-08 11:09:15\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":2},\"dueDate\":\"15/09/2021\",\"schedulerMap\":{\"SELF_ASSESSMENT\":{\"ne\":\"Self Assessment \",\"code\":\"SELF_ASSESSMENT\",\"ed\":\"2021-09-15 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-14T18:30:00.000Z\"},\"MANAGER\":{\"ne\":\"Manager Assessment\",\"ie\":\"Y\",\"code\":\"MANAGER\",\"ed\":\"2021-09-20 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-19T18:30:00.000Z\"},\"PEER_ASSESSMENT\":{\"ne\":\"Peer Assessment\",\"ie\":\"Y\",\"code\":\"PEER_ASSESSMENT\",\"ed\":\"2021-09-25 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-24T18:30:00.000Z\"},\"SECONDARY_REVIEWER_ASSESSMENT\":{\"ne\":\"Secondary Reviewer Assessment\",\"pps\":[\"Manager's Manager\"],\"ie\":\"Y\",\"code\":\"SECONDARY_REVIEWER_ASSESSMENT\",\"ed\":\"2021-09-27 23:59:59\",\"version\":0,\"endDateObject\":\"2021-09-26T18:30:00.000Z\"},\"EMPLOYEE_SIGN_OFF\":{\"ne\":\"Employee Sign-off\",\"pps\":[\"Employee\"],\"ie\":\"Y\",\"code\":\"EMPLOYEE_SIGN_OFF\",\"version\":0},\"HR_SIGN_OFF\":{\"ne\":\"HR Sign-off\",\"pps\":[\"HR\"],\"ie\":\"Y\",\"code\":\"HR_SIGN_OFF\",\"nae\":\"N\",\"version\":0}},\"activeEmployeeData\":{\"employeeId\":2096509,\"isReviewSubmitted\":false,\"assessmentId\":1},\"backupReviewers\":[],\"disabledObjectRefIds\":[],\"peerObjectRefIdsByStatusCode\":[]}", "datatype"=>"string"}='
ENDPOINTS