API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Billing

Reference

Coworkerextraserviceusehistory

The coworkerextraserviceusehistory object

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

Json Structure Example 


{
  "Id": 1234567,
  "BookingId": 12345678,
  "CoworkerExtraServiceId": 12345678,
  "CreditUsed": ,
  "UniqueId": "a114d74e-c7f4-4163-97a4-d6276f2f29d2",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a CoworkerExtraServiceUseHistory

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

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

🔒 Requires role "CoworkerExtraServiceUseHistory-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 coworkerextraserviceusehistory records based on their different properties.
Id number
?Id=12345678
CoworkerExtraServiceUseHistory_Booking Booking
?CoworkerExtraServiceUseHistory_Booking=...
CoworkerExtraServiceUseHistory_CoworkerExtraService CoworkerExtraService
?CoworkerExtraServiceUseHistory_CoworkerExtraService=...
CoworkerExtraServiceUseHistory_CreditUsed int?
?CoworkerExtraServiceUseHistory_CreditUsed=...
CoworkerExtraServiceUseHistory_BookingFromTime string
?CoworkerExtraServiceUseHistory_BookingFromTime=...
CoworkerExtraServiceUseHistory_BookingToTime string
?CoworkerExtraServiceUseHistory_BookingToTime=...
CoworkerExtraServiceUseHistory_BookingResource_Name string
?CoworkerExtraServiceUseHistory_BookingResource_Name=...

Range search querystring parameters
Lets you search coworkerextraserviceusehistory records based on a range of date or numeric values.
To_CoworkerExtraServiceUseHistory_CreatedOn date
?To_CoworkerExtraServiceUseHistory_CreatedOn=2010-01-01T20:32
From_CoworkerExtraServiceUseHistory_CreatedOn date
?From_CoworkerExtraServiceUseHistory_CreatedOn=2010-01-01T20:32
To_CoworkerExtraServiceUseHistory_UpdatedOn date
?To_CoworkerExtraServiceUseHistory_UpdatedOn=2010-01-01T20:32
From_CoworkerExtraServiceUseHistory_UpdatedOn date
?From_CoworkerExtraServiceUseHistory_UpdatedOn=2010-01-01T20:32
To_CoworkerExtraServiceUseHistory_CreditUsed number
?To_CoworkerExtraServiceUseHistory_CreditUsed=0
From_CoworkerExtraServiceUseHistory_CreditUsed number
?From_CoworkerExtraServiceUseHistory_CreditUsed=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerExtraService": ,
        "Booking": ,
        "CreditUsed": ,
        "CoworkerExtraServiceUseHistoryBookingFromTime": "...",
        "CoworkerExtraServiceUseHistoryBookingToTime": "...",
        "CoworkerExtraServiceUseHistoryBookingResource_Name": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "075f075a-19e8-4cdb-8613-710a209d1782",
        "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 CoworkerExtraServiceUseHistories by IDs

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

🔒 Requires role "CoworkerExtraServiceUseHistory-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CoworkerExtraService": ,
        "Booking": ,
        "CreditUsed": ,
        "CoworkerExtraServiceUseHistoryBookingFromTime": "...",
        "CoworkerExtraServiceUseHistoryBookingToTime": "...",
        "CoworkerExtraServiceUseHistoryBookingResource_Name": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9fbdcbb4-21d7-472d-ae68-ed917edb0dfa",
        "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 CoworkerExtraServiceUseHistory by Id

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

🔒 Requires role "CoworkerExtraServiceUseHistory-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BookingId": 12345678,
  "CoworkerExtraServiceId": 12345678,
  "CreditUsed": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "f3e5be06-5d27-4391-916b-23e3e3342b86",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new CoworkerExtraServiceUseHistory

Creates a new coworkerextraserviceusehistory. 
POST https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories

🔒 Requires role "CoworkerExtraServiceUseHistory-Create"

Body parameters
CoworkerExtraServiceId: number required
BookingId: number optional

Example request

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


{
    "CoworkerExtraServiceId": 12345678,
    "BookingId": 12345678,
}

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 CoworkerExtraServiceUseHistory

Updates an existing coworkerextraserviceusehistory. 
PUT https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories

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

🔒 Requires role "CoworkerExtraServiceUseHistory-Edit"

Body parameters
Id: number required
The unique Id of the coworkerextraserviceusehistory to update.
CoworkerExtraServiceId: number cleared if missing
BookingId: number cleared if missing

Example request

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


{
    "Id": 12345678,
    "CoworkerExtraServiceId": 12345678,
    "BookingId": 12345678,
}

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 CoworkerExtraServiceUseHistory

Deletes an existing coworkerextraserviceusehistory by its Id. 
DELETE https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/:Id

🔒 Requires role "CoworkerExtraServiceUseHistory-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/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 coworkerextraserviceusehistory record IDs. 
POST https://spaces.nexudus.com/api/billing/coworkerextraserviceusehistories/runacommand
🔒 Requires role "CoworkerExtraServiceUseHistory-Edit"

Example request

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