API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Billing

Timepasstimeslot

The timepasstimeslot object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this timepasstimeslot
DayOfWeek: DayOfWeek optional
FromTime: DateTime required
TimePassId: Id required
ToTime: DateTime required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this timepasstimeslot
SystemId: string optional api-only
User defined data about this timepasstimeslot. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "DayOfWeek": 1,
  "FromTime": 2020-01-01T21:03:54Z,
  "TimePassId": 12345678,
  "ToTime": 2020-01-01T21:03:54Z,
  "UniqueId": "319186ee-d470-4359-8017-1a434baff221",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a TimePassTimeSlot

This endpoint allows you to GET a list of timepasstimeslots based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/billing/timepasstimeslots?...

🔒 Requires role "TimePassTimeSlot-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search timepasstimeslot records based on their different properties.
Id number
?Id=12345678
TimePassTimeSlot_DayOfWeek DayOfWeek
?TimePassTimeSlot_DayOfWeek=...
TimePassTimeSlot_FromTime DateTime
?TimePassTimeSlot_FromTime=...
TimePassTimeSlot_TimePass TimePass
?TimePassTimeSlot_TimePass=...
TimePassTimeSlot_ToTime DateTime
?TimePassTimeSlot_ToTime=...

Range search querystring parameters
Lets you search timepasstimeslot records based on a range of date or numeric values.
To_TimePassTimeSlot_CreatedOn date
?To_TimePassTimeSlot_CreatedOn=2010-01-01T20:32
From_TimePassTimeSlot_CreatedOn date
?From_TimePassTimeSlot_CreatedOn=2010-01-01T20:32
To_TimePassTimeSlot_UpdatedOn date
?To_TimePassTimeSlot_UpdatedOn=2010-01-01T20:32
From_TimePassTimeSlot_UpdatedOn date
?From_TimePassTimeSlot_UpdatedOn=2010-01-01T20:32
To_TimePassTimeSlot_FromTime date
?To_TimePassTimeSlot_FromTime=2010-01-01T20:32
From_TimePassTimeSlot_FromTime date
?From_TimePassTimeSlot_FromTime=2010-01-01T20:32
To_TimePassTimeSlot_ToTime date
?To_TimePassTimeSlot_ToTime=2010-01-01T20:32
From_TimePassTimeSlot_ToTime date
?From_TimePassTimeSlot_ToTime=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/billing/timepasstimeslots?TimePassTimeSlot_FromTime=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "TimePass": ,
        "FromTime": 2020-01-01T21:03:54Z,
        "ToTime": 2020-01-01T21:03:54Z,
        "DayOfWeek": 1,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "dc9385f8-dd25-4b56-9886-3b789dcf3a89",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}

Find TimePassTimeSlots by IDs

Gets one or more timepasstimeslot records based on their Id. 
GET https://spaces.nexudus.com/api/billing/timepasstimeslots?TimePassTimeSlot_Id=[:id1,:id2,...]

🔒 Requires role "TimePassTimeSlot-List"

Querystring parameters
TimePassTimeSlot_Id: array requried
?TimePassTimeSlot_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/billing/timepasstimeslots?TimePassTimeSlot_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "TimePass": ,
        "FromTime": 2020-01-01T21:03:54Z,
        "ToTime": 2020-01-01T21:03:54Z,
        "DayOfWeek": 1,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "36cfbcf6-c5b1-4e1b-9374-ce803be1d76f",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single TimePassTimeSlot by Id

Gets one timepasstimeslot record by its Id. 
GET https://spaces.nexudus.com/api/billing/timepasstimeslots/:Id

🔒 Requires role "TimePassTimeSlot-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/billing/timepasstimeslots/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "DayOfWeek": 1,
  "FromTime": 2020-01-01T21:03:54Z,
  "TimePassId": 12345678,
  "ToTime": 2020-01-01T21:03:54Z,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "7b1d07f1-0c97-4adc-b4cc-ae1d98ba8757",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new TimePassTimeSlot

Creates a new timepasstimeslot. 
POST https://spaces.nexudus.com/api/billing/timepasstimeslots

🔒 Requires role "TimePassTimeSlot-Create"

Body parameters
TimePassId: number required
FromTime: DateTime required
ToTime: DateTime required
DayOfWeek: DayOfWeek optional

Example request

POST https://spaces.nexudus.com/api/billing/timepasstimeslots
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "TimePassId": 12345678,
    "FromTime": 2020-01-01T21:03:54Z,
    "ToTime": 2020-01-01T21:03:54Z,
    "DayOfWeek": 1, //(check Enumerated values section below)
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Update TimePassTimeSlot

Updates an existing timepasstimeslot. 
PUT https://spaces.nexudus.com/api/billing/timepasstimeslots

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

🔒 Requires role "TimePassTimeSlot-Edit"

Body parameters
Id: number required
The unique Id of the timepasstimeslot to update.
TimePassId: number cleared if missing
FromTime: DateTime cleared if missing
ToTime: DateTime cleared if missing
DayOfWeek: DayOfWeek cleared if missing

Example request

PUT https://spaces.nexudus.com/api/billing/timepasstimeslots
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "Id": 12345678,
    "TimePassId": 12345678,
    "FromTime": 2020-01-01T21:03:54Z,
    "ToTime": 2020-01-01T21:03:54Z,
    "DayOfWeek": 1, //(check Enumerated values section below)
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Delete TimePassTimeSlot

Deletes an existing timepasstimeslot by its Id. 
DELETE https://spaces.nexudus.com/api/billing/timepasstimeslots/:Id

🔒 Requires role "TimePassTimeSlot-Delete"

URL parameters
Id: number required
The unique Id of the timepasstimeslot to update.

Example request

DELETE https://spaces.nexudus.com/api/billing/timepasstimeslots/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}

Commands

Commands allow to perform actions against one or more timepasstimeslot records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for timepasstimeslot records. 
GET https://spaces.nexudus.com/api/billing/timepasstimeslots/commands

Example request

GET https://spaces.nexudus.com/api/billing/timepasstimeslots/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]

Run Command

Runs a command based on its Key and one or more timepasstimeslot record IDs. 
POST https://spaces.nexudus.com/api/billing/timepasstimeslots/runacommand
🔒 Requires role "TimePassTimeSlot-Edit"

Example request

POST https://spaces.nexudus.com/api/billing/timepasstimeslots/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}

Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}

Enumerated values

DayOfWeek

GET /api/utils/enums?name=DayOfWeek

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.