Reference

Bookingproduct

The bookingproduct object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this bookingproduct
BookingId: Id required
InvoiceInMinutes: bool optional
ProductId: Id required
Quantity: int required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this bookingproduct
SystemId: string optional api-only
User defined data about this bookingproduct. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BookingId": 12345678,
  "InvoiceInMinutes": false,
  "ProductId": 12345678,
  "Quantity": ,
  "UniqueId": "47b34c0a-01fa-4b42-8705-fcaaed04d52a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a BookingProduct

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

GET https://spaces.nexudus.com/api/spaces/bookingproducts?...

πŸ”’ Requires role "BookingProduct-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 bookingproduct records based on their different properties.
Id number
?Id=12345678
BookingProduct_Booking Booking
?BookingProduct_Booking=...
BookingProduct_InvoiceInMinutes bool
?BookingProduct_InvoiceInMinutes=...
BookingProduct_Product Product
?BookingProduct_Product=...
BookingProduct_Quantity int
?BookingProduct_Quantity=...
BookingProduct_ProductName string
?BookingProduct_ProductName=...

Range search querystring parameters
Lets you search bookingproduct records based on a range of date or numeric values.
To_BookingProduct_CreatedOn date
?To_BookingProduct_CreatedOn=2010-01-01T20:32
From_BookingProduct_CreatedOn date
?From_BookingProduct_CreatedOn=2010-01-01T20:32
To_BookingProduct_UpdatedOn date
?To_BookingProduct_UpdatedOn=2010-01-01T20:32
From_BookingProduct_UpdatedOn date
?From_BookingProduct_UpdatedOn=2010-01-01T20:32
To_BookingProduct_Quantity number
?To_BookingProduct_Quantity=0
From_BookingProduct_Quantity number
?From_BookingProduct_Quantity=10

Example request

GET https://spaces.nexudus.com/api/spaces/bookingproducts?BookingProduct_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Booking": ,
        "Product": ,
        "InvoiceInMinutes": false,
        "Quantity": ,
        "BookingProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1534af3e-584e-4b80-a3c2-5fac45bb8223",
        "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 BookingProducts by IDs

Gets one or more bookingproduct records based on their Id.
GET https://spaces.nexudus.com/api/spaces/bookingproducts?BookingProduct_Id=[:id1,:id2,...]

πŸ”’ Requires role "BookingProduct-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Booking": ,
        "Product": ,
        "InvoiceInMinutes": false,
        "Quantity": ,
        "BookingProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "777d4341-6e56-4bee-bce3-1ded3e632ac2",
        "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 BookingProduct by Id

Gets one bookingproduct record by its Id.
GET https://spaces.nexudus.com/api/spaces/bookingproducts/:Id

πŸ”’ Requires role "BookingProduct-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BookingId": 12345678,
  "InvoiceInMinutes": false,
  "ProductId": 12345678,
  "Quantity": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "2816d7c9-9b4d-41f7-bd41-900d904c5512",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new BookingProduct

Creates a new bookingproduct.
POST https://spaces.nexudus.com/api/spaces/bookingproducts

πŸ”’ Requires role "BookingProduct-Create"

Body parameters
BookingId: number required
ProductId: number required
InvoiceInMinutes: bool optional
Quantity: int required

Example request

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

{
    "BookingId": 12345678,
    "ProductId": 12345678,
    "InvoiceInMinutes": false,
    "Quantity": ,
}


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 BookingProduct

Updates an existing bookingproduct.
PUT https://spaces.nexudus.com/api/spaces/bookingproducts

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

πŸ”’ Requires role "BookingProduct-Edit"

Body parameters
Id: number required
The unique Id of the bookingproduct to update.
BookingId: number cleared if missing
ProductId: number cleared if missing
InvoiceInMinutes: bool cleared if missing
Quantity: int cleared if missing

Example request

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

{
    "Id": 12345678,
    "BookingId": 12345678,
    "ProductId": 12345678,
    "InvoiceInMinutes": false,
    "Quantity": ,
}


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 BookingProduct

Deletes an existing bookingproduct by its Id.
DELETE https://spaces.nexudus.com/api/spaces/bookingproducts/:Id

πŸ”’ Requires role "BookingProduct-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/spaces/bookingproducts/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 bookingproduct 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 bookingproduct records.
GET https://spaces.nexudus.com/api/spaces/bookingproducts/commands

Example request

GET https://spaces.nexudus.com/api/spaces/bookingproducts/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 bookingproduct record IDs.
POST https://spaces.nexudus.com/api/spaces/bookingproducts/runacommand
πŸ”’ Requires role "BookingProduct-Edit"

Example request

POST https://spaces.nexudus.com/api/spaces/bookingproducts/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
}


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.