Create TimePassTimeSlot

POST

api

billing

timepasstimeslots

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/timepasstimeslots \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TimePassId": 123,
  "FromTime": "<string>",
  "ToTime": "<string>",
  "DayOfWeek": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/timepasstimeslots"

payload = {
    "TimePassId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "DayOfWeek": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({TimePassId: 123, FromTime: '<string>', ToTime: '<string>', DayOfWeek: 123})
};

fetch('https://spaces.nexudus.com/api/billing/timepasstimeslots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A TimePassTimeSlot defines the days and times during which a time pass can be used. Each time slot specifies a day of the week and a from/to time window that restricts when the pass is valid. Time values are stored in UTC. The base date is 1976-01-01 but the actual stored date depends on the time zone offset (e.g., 1975-12-31 for time zones ahead of UTC). Always convert local times to UTC before creating time slots.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the TimePassTimeSlot-Create role.

Enums

DayOfWeek — DayOfWeek values

Value	Name
0	Sunday
1	Monday
2	Tuesday
3	Wednesday
4	Thursday
5	Friday
6	Saturday

Request Body

Required Fields

integer

required

ID of the time pass linked to this record.

string

required

Start time, stored in UTC. The base date is 1976-01-01 but the actual date depends on the time zone offset..

string

required

End time, stored in UTC. The base date is 1976-01-01 but the actual date depends on the time zone offset..

integer

required

The day of week value for this time pass time slot.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/timepasstimeslots" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "TimePassId": 0,
    "FromTime": "2025-01-15T10:30:00Z",
    "ToTime": "2025-01-15T10:30:00Z",
    "DayOfWeek": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/timepasstimeslots',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      TimePassId: 0,
      FromTime: '2025-01-15T10:30:00Z',
      ToTime: '2025-01-15T10:30:00Z',
      DayOfWeek: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/timepasstimeslots',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'TimePassId': 0,
        'FromTime': '2025-01-15T10:30:00Z',
        'ToTime': '2025-01-15T10:30:00Z',
        'DayOfWeek': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the timepasstimeslot was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "TimePassTimeSlot was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "FromTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FromTime"
    }
  ],
  "WasSuccessful": false
}

Create TimePassTimeSlot

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/timepasstimeslots \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TimePassId": 123,
  "FromTime": "<string>",
  "ToTime": "<string>",
  "DayOfWeek": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/timepasstimeslots"

payload = {
    "TimePassId": 123,
    "FromTime": "<string>",
    "ToTime": "<string>",
    "DayOfWeek": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({TimePassId: 123, FromTime: '<string>', ToTime: '<string>', DayOfWeek: 123})
};

fetch('https://spaces.nexudus.com/api/billing/timepasstimeslots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400