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.

DELETE
http://localhost:16010/ProMarkREST/rest/ProJect/sign-offs

Permissions: user

Query parameters

FieldTypeDescription
activityIdoptionalString

Activity Id.

empIdoptionalString

Id of the employee to remove signoff for.

endoptionalDate

End date for sigoff period.

pieceWorkIdoptionalString

Piece work Id.

projectIdoptionalString

Project id.

startoptionalDate

Start date for signoff period.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    singoffsObject[]

Collection of signoffs intervals.

      empIdString

The employee ID.

      endDate

End time of interval for signOff period default = Start.

      startDate

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

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    endDate

End date of interval for signOff period.

    startDate

Start date of interval for signOff period.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject
  errorCodeNumber

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))

  errorMessageString

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"
}
}