The extraservicetimeslot object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this extraservicetimeslot |
Available: bool? optional |
DayOfWeek: DayOfWeek optional |
ExtraServiceId: Id required |
FromTime: DateTime required |
ToTime: DateTime required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this extraservicetimeslot |
SystemId: string optional api-only
User defined data about this extraservicetimeslot. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"Available": ,
"DayOfWeek": 1,
"ExtraServiceId": 12345678,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"UniqueId": "cbe9fbb3-bccb-4fee-b8a2-b82ed53ab812",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a ExtraServiceTimeSlot
This endpoint allows you to GET a list of extraservicetimeslots based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/billing/extraservicetimeslots?...
π Requires role "ExtraServiceTimeSlot-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 extraservicetimeslot records based on their different properties. |
Id number
?Id=12345678 |
ExtraServiceTimeSlot_Available bool?
?ExtraServiceTimeSlot_Available=... |
ExtraServiceTimeSlot_DayOfWeek DayOfWeek
?ExtraServiceTimeSlot_DayOfWeek=... |
ExtraServiceTimeSlot_ExtraService ExtraService
?ExtraServiceTimeSlot_ExtraService=... |
ExtraServiceTimeSlot_FromTime DateTime
?ExtraServiceTimeSlot_FromTime=... |
ExtraServiceTimeSlot_ToTime DateTime
?ExtraServiceTimeSlot_ToTime=... |
Range search querystring parameters
Lets you search extraservicetimeslot records based on a range of date or numeric values. |
To_ExtraServiceTimeSlot_CreatedOn date
?To_ExtraServiceTimeSlot_CreatedOn=2010-01-01T20:32 |
From_ExtraServiceTimeSlot_CreatedOn date
?From_ExtraServiceTimeSlot_CreatedOn=2010-01-01T20:32 |
To_ExtraServiceTimeSlot_UpdatedOn date
?To_ExtraServiceTimeSlot_UpdatedOn=2010-01-01T20:32 |
From_ExtraServiceTimeSlot_UpdatedOn date
?From_ExtraServiceTimeSlot_UpdatedOn=2010-01-01T20:32 |
To_ExtraServiceTimeSlot_FromTime date
?To_ExtraServiceTimeSlot_FromTime=2010-01-01T20:32 |
From_ExtraServiceTimeSlot_FromTime date
?From_ExtraServiceTimeSlot_FromTime=2010-01-01T20:32 |
To_ExtraServiceTimeSlot_ToTime date
?To_ExtraServiceTimeSlot_ToTime=2010-01-01T20:32 |
From_ExtraServiceTimeSlot_ToTime date
?From_ExtraServiceTimeSlot_ToTime=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/billing/extraservicetimeslots?ExtraServiceTimeSlot_FromTime=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"ExtraService": ,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"DayOfWeek": 1,
"Available": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "17b1a766-d21e-4737-baa3-47c7d21062f4",
"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 ExtraServiceTimeSlots by IDs
Gets one or more extraservicetimeslot records based on their Id.GET https://spaces.nexudus.com/api/billing/extraservicetimeslots?ExtraServiceTimeSlot_Id=[:id1,:id2,...]
π Requires role "ExtraServiceTimeSlot-List"
Querystring parameters |
ExtraServiceTimeSlot_Id: array requried
?ExtraServiceTimeSlot_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/billing/extraservicetimeslots?ExtraServiceTimeSlot_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"ExtraService": ,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"DayOfWeek": 1,
"Available": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "61e5150f-b475-48b9-ab28-a92d412510fc",
"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 ExtraServiceTimeSlot by Id
Gets one extraservicetimeslot record by its Id.GET https://spaces.nexudus.com/api/billing/extraservicetimeslots/:Id
π Requires role "ExtraServiceTimeSlot-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/billing/extraservicetimeslots/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"Available": ,
"DayOfWeek": 1,
"ExtraServiceId": 12345678,
"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": "a3c6de9e-4a6d-41ab-a5a4-929355c65adb",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new ExtraServiceTimeSlot
Creates a new extraservicetimeslot.POST https://spaces.nexudus.com/api/billing/extraservicetimeslots
π Requires role "ExtraServiceTimeSlot-Create"
Body parameters |
ExtraServiceId: number required |
FromTime: DateTime required |
ToTime: DateTime required |
DayOfWeek: DayOfWeek optional |
Available: bool? optional |
Example request
POST https://spaces.nexudus.com/api/billing/extraservicetimeslots Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"ExtraServiceId": 12345678,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"DayOfWeek": 1, //(check Enumerated values section below)
"Available": ,
}
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 ExtraServiceTimeSlot
Updates an existing extraservicetimeslot.PUT https://spaces.nexudus.com/api/billing/extraservicetimeslots
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "ExtraServiceTimeSlot-Edit"
Body parameters |
Id: number required
The unique Id of the extraservicetimeslot to update. |
ExtraServiceId: number cleared if missing |
FromTime: DateTime cleared if missing |
ToTime: DateTime cleared if missing |
DayOfWeek: DayOfWeek cleared if missing |
Available: bool? cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/billing/extraservicetimeslots Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"ExtraServiceId": 12345678,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": 2020-01-01T21:03:54Z,
"DayOfWeek": 1, //(check Enumerated values section below)
"Available": ,
}
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 ExtraServiceTimeSlot
Deletes an existing extraservicetimeslot by its Id.DELETE https://spaces.nexudus.com/api/billing/extraservicetimeslots/:Id
π Requires role "ExtraServiceTimeSlot-Delete"
URL parameters |
Id: number required
The unique Id of the extraservicetimeslot to update. |
Example request
DELETE https://spaces.nexudus.com/api/billing/extraservicetimeslots/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 extraservicetimeslot 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 extraservicetimeslot records.GET https://spaces.nexudus.com/api/billing/extraservicetimeslots/commands
Example request
GET https://spaces.nexudus.com/api/billing/extraservicetimeslots/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 extraservicetimeslot record IDs.POST https://spaces.nexudus.com/api/billing/extraservicetimeslots/runacommandπ Requires role "ExtraServiceTimeSlot-Edit"
Example request
POST https://spaces.nexudus.com/api/billing/extraservicetimeslots/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.