Logo
Profit.co's Public API Documentation

Initiate Reviews

POST https://api.profit.co/app/dao/v6/reviews?a=initiateReviews&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=initiateReviews&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>?a=initiateReviews&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>' -F '{"name"=>"reviewData", "value"=>"{\"customAttributes\":[],\"rs\":\"ALL\",\"tmpName\":\"All\",\"ti\":200,\"tc\":\"STANDARD\",\"tn\":\"Standard\",\"tname\":\"Standard\",\"iaae\":\"N\",\"schedulerLevels\":[{\"code\":\"SELF_ASSESSMENT\",\"ne\":\"Self Assessment \",\"reviewAccessType\":\"Employee\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"15/09/2021\",\"formattedEd\":\"2021-09-15T04:10:01.000Z\"},{\"code\":\"MANAGER\",\"ne\":\"Manager Assessment\",\"reviewAccessType\":\"Manager\",\"ie\":\"Y\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"20/09/2021\",\"formattedEd\":\"2021-09-20T04:10:01.000Z\"},{\"code\":\"PEER_ASSESSMENT\",\"ne\":\"Peer Assessment\",\"reviewAccessType\":\"Custom List\",\"ie\":\"Y\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"25/09/2021\",\"formattedEd\":\"2021-09-25T04:10:01.000Z\"},{\"ne\":\"Secondary Reviewer Assessment\",\"pps\":[\"Manager's Manager\"],\"ie\":\"Y\",\"code\":\"SECONDARY_REVIEWER_ASSESSMENT\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"27/09/2021\",\"formattedEd\":\"2021-09-27T04:10:01.000Z\"},{\"ne\":\"Employee Sign-off\",\"pps\":[\"Employee\"],\"ie\":\"Y\",\"code\":\"EMPLOYEE_SIGN_OFF\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\"},{\"ne\":\"HR Sign-off\",\"pps\":[\"HR\"],\"ie\":\"Y\",\"code\":\"HR_SIGN_OFF\",\"nae\":\"N\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\"}],\"periodName\":[{\"periodId\":21,\"periodName\":\"Q3-2021\",\"periodCode\":\"OCT-2021\"}],\"name\":\"Employee Performance Review Q3 - 2021\",\"description\":\"<p id=\\\"tinyEle\\\" class=\\\"\\\" data-after-content=\\\"\\\">Test Description</p>\",\"jbObject\":\"2021-05-31T18:30:00.000Z\",\"jb\":\"01/06/2021\",\"rvsh\":\"Y\",\"dbed\":\"2\",\"extdys\":5,\"isAutoCloseEnabled\":true,\"autoClosedOnObject\":\"2021-09-30T04:10:01.000Z\",\"autoClosedOn\":\"30/09/2021\",\"tempAutoClosedOn\":\"30/09/2021\",\"formatedAutoClosedOn\":\"2021-09-30T04:10:01.000Z\",\"gracePeriod\":\"5\",\"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}],\"prp\":[{\"code\":\"SELF_ASSESSMENT\",\"ne\":\"Self Assessment \",\"reviewAccessType\":\"Employee\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"15/09/2021\",\"formattedEd\":\"2021-09-15T04:10:01.000Z\"},{\"code\":\"MANAGER\",\"ne\":\"Manager Assessment\",\"reviewAccessType\":\"Manager\",\"ie\":\"Y\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"20/09/2021\",\"formattedEd\":\"2021-09-20T04:10:01.000Z\"},{\"code\":\"PEER_ASSESSMENT\",\"ne\":\"Peer Assessment\",\"reviewAccessType\":\"Custom List\",\"ie\":\"Y\",\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"25/09/2021\",\"formattedEd\":\"2021-09-25T04:10:01.000Z\"},{\"ne\":\"Secondary Reviewer Assessment\",\"pps\":[\"Manager's Manager\"],\"ie\":\"Y\",\"code\":\"SECONDARY_REVIEWER_ASSESSMENT\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\",\"ed\":\"27/09/2021\",\"formattedEd\":\"2021-09-27T04:10:01.000Z\"},{\"ne\":\"Employee Sign-off\",\"pps\":[\"Employee\"],\"ie\":\"Y\",\"code\":\"EMPLOYEE_SIGN_OFF\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\"},{\"ne\":\"HR Sign-off\",\"pps\":[\"HR\"],\"ie\":\"Y\",\"code\":\"HR_SIGN_OFF\",\"nae\":\"N\",\"version\":0,\"minDate\":\"2021-09-07T18:30:00.000Z\"}]}", "datatype"=>"string"}='

ENDPOINTS