Finds and returns a holiday identified by its holiday name.
get
/primeapi/restapi/v16.2/holiday/name/{name}
Request
Path Parameters
- name
-
Type:
stringRequired:trueName of the holiday to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Body
Root Schema : ApiEntityHoliday
Type:
object- dayOfMonth
-
Type:
integer(int32)Required:trueThe day of the month the holiday is on. - dayOfWeek
-
Type:
integer(int32)Required:trueThe day of the week the holiday is on. - holidayDate
-
Type:
string(date-time)Required:trueThe date of the holiday. - holidayGroupId
-
Type:
integer(int64)Required:trueThe unique identifier for the holiday list. - holidayId
-
Type:
integer(int64)Required:trueThe unique identifier for the holiday. - holidayName
-
Type:
stringRequired:trueThe name of the holiday. - month
-
Type:
integer(int32)Required:trueThe month the holiday is in. - week
-
Type:
integer(int32)Required:trueThe week of the month the holiday is in. - workTime
-
Type:
objectDayWorkTimeRequired:true
Nested Schema : DayWorkTime
Type:
object- firstNonWorkTime
-
Type:
integer(int32) - firstWorkTime
-
Type:
integer(int32) - granularity
-
Type:
integer(int32) - m_bits
-
Type:
string - workingMinutes
-
Type:
integer(int32) - workTimes
-
Type:
arrayworkTimes
Nested Schema : workTimes
Type:
array-
Type:
objectDayWorkRange
Nested Schema : DayWorkRange
Type:
object- duration
-
Type:
integer(int32) - minuteEnd
-
Type:
integer(int32) - minuteStart
-
Type:
integer(int32)
404 Response
The Holiday do not exist or you do not have access to it.