Reference

Coworkerbookingcreditusehistory

The coworkerbookingcreditusehistory object

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

Json Structure Example


{
  "Id": 1234567,
  "BookingId": 12345678,
  "CoworkerBookingCreditId": 12345678,
  "CreditUsed": 1.2,
  "Description": "Description",
  "EventAttendeeId": 12345678,
  "UniqueId": "0c0ded04-1756-40a9-ab99-499e69c05bf5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerBookingCreditUseHistory

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

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

๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-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 coworkerbookingcreditusehistory records based on their different properties.
Id number
?Id=12345678
CoworkerBookingCreditUseHistory_Booking Booking
?CoworkerBookingCreditUseHistory_Booking=...
CoworkerBookingCreditUseHistory_CoworkerBookingCredit CoworkerBookingCredit
?CoworkerBookingCreditUseHistory_CoworkerBookingCredit=...
CoworkerBookingCreditUseHistory_CreditUsed decimal
?CoworkerBookingCreditUseHistory_CreditUsed=...
CoworkerBookingCreditUseHistory_Description string
?CoworkerBookingCreditUseHistory_Description=...
CoworkerBookingCreditUseHistory_EventAttendee EventAttendee
?CoworkerBookingCreditUseHistory_EventAttendee=...
CoworkerBookingCreditUseHistory_BookingFromTime string
?CoworkerBookingCreditUseHistory_BookingFromTime=...
CoworkerBookingCreditUseHistory_BookingToTime string
?CoworkerBookingCreditUseHistory_BookingToTime=...
CoworkerBookingCreditUseHistory_BookingResource_Name string
?CoworkerBookingCreditUseHistory_BookingResource_Name=...
CoworkerBookingCreditUseHistory_EventAttendeeCalendarEvent_Name string
?CoworkerBookingCreditUseHistory_EventAttendeeCalendarEvent_Name=...
CoworkerBookingCreditUseHistory_EventAttendeeEventProduct_Name string
?CoworkerBookingCreditUseHistory_EventAttendeeEventProduct_Name=...
CoworkerBookingCreditUseHistory_EventAttendeeFullName string
?CoworkerBookingCreditUseHistory_EventAttendeeFullName=...
CoworkerBookingCreditUseHistory_EventAttendeeEmail string
?CoworkerBookingCreditUseHistory_EventAttendeeEmail=...

Range search querystring parameters
Lets you search coworkerbookingcreditusehistory records based on a range of date or numeric values.
To_CoworkerBookingCreditUseHistory_CreatedOn date
?To_CoworkerBookingCreditUseHistory_CreatedOn=2010-01-01T20:32
From_CoworkerBookingCreditUseHistory_CreatedOn date
?From_CoworkerBookingCreditUseHistory_CreatedOn=2010-01-01T20:32
To_CoworkerBookingCreditUseHistory_UpdatedOn date
?To_CoworkerBookingCreditUseHistory_UpdatedOn=2010-01-01T20:32
From_CoworkerBookingCreditUseHistory_UpdatedOn date
?From_CoworkerBookingCreditUseHistory_UpdatedOn=2010-01-01T20:32
To_CoworkerBookingCreditUseHistory_CreditUsed number
?To_CoworkerBookingCreditUseHistory_CreditUsed=0
From_CoworkerBookingCreditUseHistory_CreditUsed number
?From_CoworkerBookingCreditUseHistory_CreditUsed=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Description": "Description",
        "CoworkerBookingCredit": ,
        "Booking": ,
        "EventAttendee": ,
        "CreditUsed": 1.2,
        "CoworkerBookingCreditUseHistoryBookingFromTime": "...",
        "CoworkerBookingCreditUseHistoryBookingToTime": "...",
        "CoworkerBookingCreditUseHistoryBookingResource_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeCalendarEvent_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeEventProduct_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeFullName": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeEmail": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "65b525a4-fec4-4afe-b31d-e4334d02a5ba",
        "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 CoworkerBookingCreditUseHistories by IDs

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

๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Description": "Description",
        "CoworkerBookingCredit": ,
        "Booking": ,
        "EventAttendee": ,
        "CreditUsed": 1.2,
        "CoworkerBookingCreditUseHistoryBookingFromTime": "...",
        "CoworkerBookingCreditUseHistoryBookingToTime": "...",
        "CoworkerBookingCreditUseHistoryBookingResource_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeCalendarEvent_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeEventProduct_Name": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeFullName": "...",
        "CoworkerBookingCreditUseHistoryEventAttendeeEmail": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "2ccb4938-34db-4c10-a5e4-5818a3249c25",
        "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 CoworkerBookingCreditUseHistory by Id

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

๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BookingId": 12345678,
  "CoworkerBookingCreditId": 12345678,
  "CreditUsed": 1.2,
  "Description": "Description",
  "EventAttendeeId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "20a79041-51b4-4db0-aeb1-6f573e45bcd7",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerBookingCreditUseHistory

Creates a new coworkerbookingcreditusehistory.
POST https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories

๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-Create"

Body parameters
Description: string optional
CoworkerBookingCreditId: number required
BookingId: number optional
EventAttendeeId: number optional
CreditUsed: decimal required

Example request

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

{
    "Description": "Description",
    "CoworkerBookingCreditId": 12345678,
    "BookingId": 12345678,
    "EventAttendeeId": 12345678,
    "CreditUsed": 1.2,
}


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 CoworkerBookingCreditUseHistory

Updates an existing coworkerbookingcreditusehistory.
PUT https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories

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

๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-Edit"

Body parameters
Id: number required
The unique Id of the coworkerbookingcreditusehistory to update.
Description: string cleared if missing
CoworkerBookingCreditId: number cleared if missing
BookingId: number cleared if missing
EventAttendeeId: number cleared if missing

Example request

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

{
    "Id": 12345678,
    "Description": "Description",
    "CoworkerBookingCreditId": 12345678,
    "BookingId": 12345678,
    "EventAttendeeId": 12345678,
    "CreditUsed": 1.2,
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more coworkerbookingcreditusehistory 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 coworkerbookingcreditusehistory records.
GET https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/commands

Example request

GET https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/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 coworkerbookingcreditusehistory record IDs.
POST https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/runacommand
๐Ÿ”’ Requires role "CoworkerBookingCreditUseHistory-Edit"

Example request

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