Get
/api/v{version}/scheduledperiods
Security
OAuth
Authorization using OAuth2 with Client Credentials
FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
Min length0
Max length128
x-onBehalfOf
string
Min length0
Max length24
api-version
string
Path parameters
version
stringRequired
Query parameters
searchText
string
Min length0
Max length512
skip
integer (int32)
take
integer (int32)
Responses
200
OK
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
totalCount
integer (int32)
scheduledPeriods
Array of object (Contracts.Connect.Results.Facts.SelectScheduledPeriodJson) | null
object
id
string | null
name
string | null
periodsForClient
Array of object (Contracts.Connect.Results.Facts.SelectScheduledPeriodClientJson) | null
object
startDateTime
string (date-time) | null
endDateTime
string (date-time) | null
dayOfWeeks
string
Valid values[
"None",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"NotWeekends",
"Saturday",
"Sunday",
"Weekends",
"All"
]
weekdayStartTime
string (date-span) | null
weekdayEndTime
string (date-span) | null
isScheduled
boolean
locationsWithCustomPeriods
Array of object (Contracts.Connect.Results.Facts.SelectScheduledPeriodLocationJson) | null
object
code
string | null
id
string | null
periods
Array of object (Contracts.Connect.Results.Facts.SelectScheduledPeriodPeriodJson) | null
object
startDateTime
string (date-time) | null
endDateTime
string (date-time) | null
dayOfWeeks
string
Valid values[
"None",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"NotWeekends",
"Saturday",
"Sunday",
"Weekends",
"All"
]
weekdayStartTime
string (date-span) | null
weekdayEndTime
string (date-span) | null
isScheduled
boolean
disabledLocations
Array of object (Contracts.Connect.Results.Facts.SelectScheduledPeriodDisabledLocationJson) | null
object
code
string | null
id
string | null
400
Bad Request
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401
Unauthorized
403
Forbidden
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500
Internal Server Error