ProJect - Remove sign-off
API Url
Delete 1 or more signoffs. The API will verify if it's allowed to remove signoffs for other employees.
http://localhost:16010/ProMarkREST/rest/ProJect/sign-offs
Permissions: user
Query parameters
| Field | Type | Description |
|---|---|---|
activityIdoptional | String | Activity Id. |
empIdoptional | String | Id of the employee to remove signoff for. |
endoptional | Date | End date for sigoff period. |
pieceWorkIdoptional | String | Piece work Id. |
projectIdoptional | String | Project id. |
startoptional | Date | Start date for signoff period. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| singoffs | Object[] | Collection of signoffs intervals. |
| empId | String | The employee ID. |
| end | Date | End time of interval for signOff period default = Start. |
| start | Date | Start time of interval for signOff period. |
Request example for removing sign-off:
{"request": {"data": {"singoffs": [{"empId": "804","start": "2017-06-22","end": "2017-06-22"}]}}}
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| end | Date | End date of interval for signOff period. |
| start | Date | Start date of interval for signOff period. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | |
| errorCode | Number | Error Code (101(SYS): System/program error, 102(NOK): Assorted or low-level error, 103(OSO): Signoff must also be removed from a later date than requested, 104(MHR): Missing registration time (ProJect or part.absence), 105(MRE): Missing registration (ProJect or part.absence), 106(MSO): Missing signoff on an earlier date than requested, 107(OLA): Overlapping registrations (ProJect or part.absence)) |
| errorMessage | String | Error description. |
Error example:
HTTP/1.1 422 Error example{"response": {"errorCode": 103,"errorMessage": "Signoff must also be removed from a later date than requested"}}