General - Get profile period

API Url

Get profile period for a date.

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{emp_id}/profile-period

Permissions: user

Path parameters

Field	Type	Description
emp_id	String	Employee ID

Query parameters

Field	Type	Description
date	Date	Date to be in period
periodProfileId	String	Profile Period ID
SplitByWeek	boolean	True if want to splited by week

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
endDate	Date	End date.
startDate	Date	Start date.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
       "data": {
           "startDate": "2017-10-23",
           "endDate" :"2017-10-29"
       },
       "errorCode": 0,
       "errorMessage": ""
    }
}

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.

Employee does not exist:

{
   "response": {
       "data": {},
       "errorCode": 75,
       "errorMessage": "Employee does not exist"
    }
}