The businesstimeslot object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this businesstimeslot |
BusinessId: Id required |
DayOfWeek: DayOfWeek optional |
FromTime: DateTime required |
ToTime: DateTime required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this businesstimeslot |
SystemId: string optional api-only
User defined data about this businesstimeslot. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"DayOfWeek": 1,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"UniqueId": "249eb685-f41d-4b92-867d-ed031703a1a2",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a BusinessTimeSlot
This endpoint allows you to GET a list of businesstimeslots based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/businesstimeslots?...
π Requires role "BusinessTimeSlot-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 businesstimeslot records based on their different properties. |
Id number
?Id=12345678 |
BusinessTimeSlot_Business Business
?BusinessTimeSlot_Business=... |
BusinessTimeSlot_DayOfWeek DayOfWeek
?BusinessTimeSlot_DayOfWeek=... |
BusinessTimeSlot_FromTime DateTime
?BusinessTimeSlot_FromTime=... |
BusinessTimeSlot_ToTime DateTime
?BusinessTimeSlot_ToTime=... |
Range search querystring parameters
Lets you search businesstimeslot records based on a range of date or numeric values. |
To_BusinessTimeSlot_CreatedOn date
?To_BusinessTimeSlot_CreatedOn=2010-01-01T20:32 |
From_BusinessTimeSlot_CreatedOn date
?From_BusinessTimeSlot_CreatedOn=2010-01-01T20:32 |
To_BusinessTimeSlot_UpdatedOn date
?To_BusinessTimeSlot_UpdatedOn=2010-01-01T20:32 |
From_BusinessTimeSlot_UpdatedOn date
?From_BusinessTimeSlot_UpdatedOn=2010-01-01T20:32 |
To_BusinessTimeSlot_FromTime date
?To_BusinessTimeSlot_FromTime=2010-01-01T20:32 |
From_BusinessTimeSlot_FromTime date
?From_BusinessTimeSlot_FromTime=2010-01-01T20:32 |
To_BusinessTimeSlot_ToTime date
?To_BusinessTimeSlot_ToTime=2010-01-01T20:32 |
From_BusinessTimeSlot_ToTime date
?From_BusinessTimeSlot_ToTime=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/sys/businesstimeslots?BusinessTimeSlot_FromTime=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"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": "6dbab8cc-a569-49ff-9705-00f7f0e77ab5",
"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 BusinessTimeSlots by IDs
Gets one or more businesstimeslot records based on their Id.GET https://spaces.nexudus.com/api/sys/businesstimeslots?BusinessTimeSlot_Id=[:id1,:id2,...]
π Requires role "BusinessTimeSlot-List"
Querystring parameters |
BusinessTimeSlot_Id: array requried
?BusinessTimeSlot_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/businesstimeslots?BusinessTimeSlot_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"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": "b0d3f74a-a9a0-4521-943a-17f6c113662f",
"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 BusinessTimeSlot by Id
Gets one businesstimeslot record by its Id.GET https://spaces.nexudus.com/api/sys/businesstimeslots/:Id
π Requires role "BusinessTimeSlot-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/businesstimeslots/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"DayOfWeek": 1,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "5ce37ec4-931e-4ced-be47-4ce28a845bae",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new BusinessTimeSlot
Creates a new businesstimeslot.POST https://spaces.nexudus.com/api/sys/businesstimeslots
π Requires role "BusinessTimeSlot-Create"
Body parameters |
BusinessId: number required |
FromTime: DateTime required |
ToTime: DateTime required |
DayOfWeek: DayOfWeek optional |
Example request
POST https://spaces.nexudus.com/api/sys/businesstimeslots Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 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 BusinessTimeSlot
Updates an existing businesstimeslot.PUT https://spaces.nexudus.com/api/sys/businesstimeslots
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "BusinessTimeSlot-Edit"
Body parameters |
Id: number required
The unique Id of the businesstimeslot to update. |
BusinessId: 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/sys/businesstimeslots Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 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 BusinessTimeSlot
Deletes an existing businesstimeslot by its Id.DELETE https://spaces.nexudus.com/api/sys/businesstimeslots/:Id
π Requires role "BusinessTimeSlot-Delete"
URL parameters |
Id: number required
The unique Id of the businesstimeslot to update. |
Example request
DELETE https://spaces.nexudus.com/api/sys/businesstimeslots/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 businesstimeslot 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 businesstimeslot records.GET https://spaces.nexudus.com/api/sys/businesstimeslots/commands
Example request
GET https://spaces.nexudus.com/api/sys/businesstimeslots/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 businesstimeslot record IDs.POST https://spaces.nexudus.com/api/sys/businesstimeslots/runacommandπ Requires role "BusinessTimeSlot-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/businesstimeslots/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
Comments
Please sign in to leave a comment.