General - Get temporary registrations

API Url

Use it to get temporary registrations

GET

http://localhost:16010/ProMarkREST/web/General/employees/{empId}/temporary-registrations?date=2021-08-01&type=CB

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
empId	String	Employee id.

Query parameters

Field	Type	Description
date`optional`	Date	Selected day for the temporary registrations
type`optional`	String	Registrations types to be returned

Success 200

Field	Type	Description
data	Object
cancelBreak	Object	Employees cancel break
breakProfId	String	Break profile id
breaks	Object[]	Collection of break intervals
end	Number	Break interval end
isCanceled	Number	True -> temporary cancel break exists for this break False -> temporary cancel break does not exist for this break
start	Number	Break interval start

Success example:

{
    "response": {
        "data": {
           "temporaryRegistrations":
           [
           {
             "type":"CB",
             "empId" :"400",
              "cancelBreak": 
                  {
                     "breakProfId":"vpeid",
                     "isCanceled": yes,
                     break:{
                      "start": 14400,
                      "end": 16200
                      }
                  }   
           },
           {}
           ]
          }
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.