ProJect - Get pieceworks for project and activity

API Url

Used for loading pieceworks for a project and an activity.

GET
http://localhost:16010/ProMarkREST/rest/ProJect/projects/{projectId}/activities/{activityId}/pieceworks

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
activityIdString

Activity ID.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    pieceworksObject[]

Collection of pieceworks.

      actityIdString

Activity Id.

      pieceworkDescString

Piecework description.

      pieceworkIdString

Piecework ID.

      projectIdString

Project Id.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"pieceworks": [
{
"pieceworkId": "1",
"pieceworkDesc": "ProMark Piecework",
"projectId": "COLOR",
"activityId": "WLD"
},
{
"pieceworkId": "100",
"pieceworkDesc": "Secondary rates",
"projectId": "COLOR",
"activityId": "OPT"
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.