Reference

Bookingnote

The bookingnote object

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

Json Structure Example


{
  "Id": 1234567,
  "AddedBy": "AddedBy",
  "BookingId": 12345678,
  "Notes": "Notes",
  "UniqueId": "c75ad8dc-bb7f-4c7e-aca8-02acb46ef56c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a BookingNote

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

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

πŸ”’ Requires role "BookingNote-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 bookingnote records based on their different properties.
Id number
?Id=12345678
BookingNote_AddedBy string
?BookingNote_AddedBy=...
BookingNote_Booking Booking
?BookingNote_Booking=...
BookingNote_Notes string
?BookingNote_Notes=...

Range search querystring parameters
Lets you search bookingnote records based on a range of date or numeric values.
To_BookingNote_CreatedOn date
?To_BookingNote_CreatedOn=2010-01-01T20:32
From_BookingNote_CreatedOn date
?From_BookingNote_CreatedOn=2010-01-01T20:32
To_BookingNote_UpdatedOn date
?To_BookingNote_UpdatedOn=2010-01-01T20:32
From_BookingNote_UpdatedOn date
?From_BookingNote_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Booking": ,
        "AddedBy": "AddedBy",
        "Notes": "Notes",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "11f54a2b-9a6d-4c2c-8c42-6992f2e95e43",
        "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 BookingNotes by IDs

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

πŸ”’ Requires role "BookingNote-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Booking": ,
        "AddedBy": "AddedBy",
        "Notes": "Notes",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "5b5da6a8-2658-4237-abd3-2454a67caea8",
        "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 BookingNote by Id

Gets one bookingnote record by its Id.
GET https://spaces.nexudus.com/api/spaces/bookingnotes/:Id

πŸ”’ Requires role "BookingNote-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AddedBy": "AddedBy",
  "BookingId": 12345678,
  "Notes": "Notes",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "f0506c6f-cff8-4bc7-a269-5f5a4449ed0e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new BookingNote

Creates a new bookingnote.
POST https://spaces.nexudus.com/api/spaces/bookingnotes

πŸ”’ Requires role "BookingNote-Create"

Body parameters
BookingId: number required
AddedBy: string optional
Notes: string required

Example request

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

{
    "BookingId": 12345678,
    "AddedBy": "AddedBy",
    "Notes": "Notes",
}


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 BookingNote

Updates an existing bookingnote.
PUT https://spaces.nexudus.com/api/spaces/bookingnotes

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

πŸ”’ Requires role "BookingNote-Edit"

Body parameters
Id: number required
The unique Id of the bookingnote to update.
BookingId: number cleared if missing
AddedBy: string cleared if missing
Notes: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "BookingId": 12345678,
    "AddedBy": "AddedBy",
    "Notes": "Notes",
}


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 BookingNote

Deletes an existing bookingnote by its Id.
DELETE https://spaces.nexudus.com/api/spaces/bookingnotes/:Id

πŸ”’ Requires role "BookingNote-Delete"

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

Example request

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

Example request

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

Example request

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