Get a schedule

GET

/api/tenant/{tenantId}/Schedules/{id}

curl --request GET \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

tenantId

required

string format: uuid

Your tenant id.

Responses

200

OK

Media typeapplication/json

object

fields

object

key

additional properties

string

data

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

id

string format: uuid

relations

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

id

string format: uuid

name

string

nullable

entityId

required

string format: uuid

entityType

required

string

>= 1 characters

relationType

required

string

>= 1 characters

tenantId

string format: uuid

nullable

resourceGroupId

string format: uuid

nullable

creatorId

string format: uuid

nullable

createdDate

string format: date-time

nullable

version

integer format: int32

nullable

lastModified

string format: date-time

nullable

parentId

string format: uuid

nullable

siteId

string format: uuid

nullable

itemId

string format: uuid

nullable

userId

string format: uuid

nullable

productContainerId

string format: uuid

nullable

productId

string format: uuid

nullable

name

string

nullable

isActive

boolean

sessions

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

id

string format: uuid

name

string

nullable

description

string

nullable

isClosed

boolean

recurrence

string

nullable

daysOfWeek

Array<string>

nullable

Allowed values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday

isAllDay

boolean

starts

string format: date-time

nullable

ends

string format: date-time

nullable

periodEnds

string format: date-time

nullable

Example

{
  "data": {
    "sessions": [
      {
        "daysOfWeek": [
          "Sunday"
        ]
      }
    ]
  }
}

401

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}