The coworkertimepass object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this coworkertimepass |
BusinessId: Id required |
CheckedIn: bool optional read-only |
CoworkerId: Id required |
CoworkerProductUniqueId: Guid? optional |
CreateMultiple: int required |
ExpireDate: DateTime? optional |
Free: bool optional |
Invoiced: bool optional read-only |
InvoiceDate: DateTime? optional read-only |
IsFromTariff: bool optional read-only |
Notes: string optional |
Price: decimal? optional |
RemainingUses: int? optional read-only |
TimePassId: Id required |
TotalUses: int? optional read-only |
Used: bool optional |
UsedDate: DateTime? optional read-only |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkertimepass |
SystemId: string optional api-only
User defined data about this coworkertimepass. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"CheckedIn": false,
"CoworkerId": 12345678,
"CoworkerProductUniqueId": ,
"CreateMultiple": ,
"ExpireDate": ,
"Free": false,
"Invoiced": false,
"InvoiceDate": ,
"IsFromTariff": false,
"Notes": "Notes",
"Price": ,
"RemainingUses": ,
"TimePassId": 12345678,
"TotalUses": ,
"Used": false,
"UsedDate": ,
"UniqueId": "db54a929-6dd1-4907-a9db-2538d7e522b0",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a CoworkerTimePass
This endpoint allows you to GET a list of coworkertimepasses based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/billing/coworkertimepasses?...
π Requires role "CoworkerTimePass-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 coworkertimepass records based on their different properties. |
Id number
?Id=12345678 |
CoworkerTimePass_Business Business
?CoworkerTimePass_Business=... |
CoworkerTimePass_CheckedIn bool
?CoworkerTimePass_CheckedIn=... |
CoworkerTimePass_Coworker Coworker
?CoworkerTimePass_Coworker=... |
CoworkerTimePass_CoworkerProductUniqueId Guid?
?CoworkerTimePass_CoworkerProductUniqueId=... |
CoworkerTimePass_CreateMultiple int
?CoworkerTimePass_CreateMultiple=... |
CoworkerTimePass_ExpireDate DateTime?
?CoworkerTimePass_ExpireDate=... |
CoworkerTimePass_Free bool
?CoworkerTimePass_Free=... |
CoworkerTimePass_Invoiced bool
?CoworkerTimePass_Invoiced=... |
CoworkerTimePass_InvoiceDate DateTime?
?CoworkerTimePass_InvoiceDate=... |
CoworkerTimePass_IsFromTariff bool
?CoworkerTimePass_IsFromTariff=... |
CoworkerTimePass_Notes string
?CoworkerTimePass_Notes=... |
CoworkerTimePass_Price decimal?
?CoworkerTimePass_Price=... |
CoworkerTimePass_RemainingUses int?
?CoworkerTimePass_RemainingUses=... |
CoworkerTimePass_TimePass TimePass
?CoworkerTimePass_TimePass=... |
CoworkerTimePass_TotalUses int?
?CoworkerTimePass_TotalUses=... |
CoworkerTimePass_Used bool
?CoworkerTimePass_Used=... |
CoworkerTimePass_UsedDate DateTime?
?CoworkerTimePass_UsedDate=... |
CoworkerTimePass_TimePassName string
?CoworkerTimePass_TimePassName=... |
CoworkerTimePass_TimePassCurrency_Code string
?CoworkerTimePass_TimePassCurrency_Code=... |
Range search querystring parameters
Lets you search coworkertimepass records based on a range of date or numeric values. |
To_CoworkerTimePass_CreatedOn date
?To_CoworkerTimePass_CreatedOn=2010-01-01T20:32 |
From_CoworkerTimePass_CreatedOn date
?From_CoworkerTimePass_CreatedOn=2010-01-01T20:32 |
To_CoworkerTimePass_UpdatedOn date
?To_CoworkerTimePass_UpdatedOn=2010-01-01T20:32 |
From_CoworkerTimePass_UpdatedOn date
?From_CoworkerTimePass_UpdatedOn=2010-01-01T20:32 |
To_CoworkerTimePass_UsedDate date
?To_CoworkerTimePass_UsedDate=2010-01-01T20:32 |
From_CoworkerTimePass_UsedDate date
?From_CoworkerTimePass_UsedDate=2010-01-01T20:32 |
To_CoworkerTimePass_RemainingUses number
?To_CoworkerTimePass_RemainingUses=0 |
From_CoworkerTimePass_RemainingUses number
?From_CoworkerTimePass_RemainingUses=10 |
To_CoworkerTimePass_TotalUses number
?To_CoworkerTimePass_TotalUses=0 |
From_CoworkerTimePass_TotalUses number
?From_CoworkerTimePass_TotalUses=10 |
To_CoworkerTimePass_Price number
?To_CoworkerTimePass_Price=0 |
From_CoworkerTimePass_Price number
?From_CoworkerTimePass_Price=10 |
To_CoworkerTimePass_CreateMultiple number
?To_CoworkerTimePass_CreateMultiple=0 |
From_CoworkerTimePass_CreateMultiple number
?From_CoworkerTimePass_CreateMultiple=10 |
To_CoworkerTimePass_ExpireDate date
?To_CoworkerTimePass_ExpireDate=2010-01-01T20:32 |
From_CoworkerTimePass_ExpireDate date
?From_CoworkerTimePass_ExpireDate=2010-01-01T20:32 |
To_CoworkerTimePass_InvoiceDate date
?To_CoworkerTimePass_InvoiceDate=2010-01-01T20:32 |
From_CoworkerTimePass_InvoiceDate date
?From_CoworkerTimePass_InvoiceDate=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/billing/coworkertimepasses?CoworkerTimePass_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"TimePass": ,
"Notes": "Notes",
"Used": false,
"CheckedIn": false,
"UsedDate": ,
"RemainingUses": ,
"TotalUses": ,
"Free": false,
"Price": ,
"CreateMultiple": ,
"ExpireDate": ,
"Invoiced": false,
"InvoiceDate": ,
"IsFromTariff": false,
"CoworkerProductUniqueId": ,
"CoworkerTimePassTimePassName": "...",
"CoworkerTimePassTimePassCurrency_Code": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "7bbde3fa-f765-4e1b-998a-7d740389842a",
"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 CoworkerTimePasses by IDs
Gets one or more coworkertimepass records based on their Id.GET https://spaces.nexudus.com/api/billing/coworkertimepasses?CoworkerTimePass_Id=[:id1,:id2,...]
π Requires role "CoworkerTimePass-List"
Querystring parameters |
CoworkerTimePass_Id: array requried
?CoworkerTimePass_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/billing/coworkertimepasses?CoworkerTimePass_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"TimePass": ,
"Notes": "Notes",
"Used": false,
"CheckedIn": false,
"UsedDate": ,
"RemainingUses": ,
"TotalUses": ,
"Free": false,
"Price": ,
"CreateMultiple": ,
"ExpireDate": ,
"Invoiced": false,
"InvoiceDate": ,
"IsFromTariff": false,
"CoworkerProductUniqueId": ,
"CoworkerTimePassTimePassName": "...",
"CoworkerTimePassTimePassCurrency_Code": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "60e6f91a-5322-41ee-9fa1-08fe93a5f3d3",
"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 CoworkerTimePass by Id
Gets one coworkertimepass record by its Id.GET https://spaces.nexudus.com/api/billing/coworkertimepasses/:Id
π Requires role "CoworkerTimePass-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/billing/coworkertimepasses/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"CheckedIn": false,
"CoworkerId": 12345678,
"CoworkerProductUniqueId": ,
"CreateMultiple": ,
"ExpireDate": ,
"Free": false,
"Invoiced": false,
"InvoiceDate": ,
"IsFromTariff": false,
"Notes": "Notes",
"Price": ,
"RemainingUses": ,
"TimePassId": 12345678,
"TotalUses": ,
"Used": false,
"UsedDate": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "4bf6f8b5-9763-4f32-8408-52872c134b11",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new CoworkerTimePass
Creates a new coworkertimepass.POST https://spaces.nexudus.com/api/billing/coworkertimepasses
π Requires role "CoworkerTimePass-Create"
Body parameters |
CoworkerId: number required |
BusinessId: number required |
TimePassId: number required |
Notes: string optional |
Free: bool optional |
Price: decimal? optional |
CreateMultiple: int required |
ExpireDate: DateTime? optional |
CoworkerProductUniqueId: Guid? optional |
Example request
POST https://spaces.nexudus.com/api/billing/coworkertimepasses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"CoworkerId": 12345678,
"BusinessId": 12345678,
"TimePassId": 12345678,
"Notes": "Notes",
"Free": false,
"Price": ,
"CreateMultiple": ,
"ExpireDate": ,
"CoworkerProductUniqueId": ,
}
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 CoworkerTimePass
Updates an existing coworkertimepass.PUT https://spaces.nexudus.com/api/billing/coworkertimepasses
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "CoworkerTimePass-Edit"
Body parameters |
Id: number required
The unique Id of the coworkertimepass to update. |
CoworkerId: number cleared if missing |
BusinessId: number cleared if missing |
TimePassId: number cleared if missing |
Notes: string cleared if missing |
Used: bool cleared if missing |
Free: bool cleared if missing |
Price: decimal? cleared if missing |
ExpireDate: DateTime? cleared if missing |
CoworkerProductUniqueId: Guid? cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/billing/coworkertimepasses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"CoworkerId": 12345678,
"BusinessId": 12345678,
"TimePassId": 12345678,
"Notes": "Notes",
"Free": false,
"Price": ,
"CreateMultiple": ,
"ExpireDate": ,
"CoworkerProductUniqueId": ,
}
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 CoworkerTimePass
Deletes an existing coworkertimepass by its Id.DELETE https://spaces.nexudus.com/api/billing/coworkertimepasses/:Id
π Requires role "CoworkerTimePass-Delete"
URL parameters |
Id: number required
The unique Id of the coworkertimepass to update. |
Example request
DELETE https://spaces.nexudus.com/api/billing/coworkertimepasses/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 coworkertimepass 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 coworkertimepass records.GET https://spaces.nexudus.com/api/billing/coworkertimepasses/commands
Example request
GET https://spaces.nexudus.com/api/billing/coworkertimepasses/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 coworkertimepass record IDs.POST https://spaces.nexudus.com/api/billing/coworkertimepasses/runacommandπ Requires role "CoworkerTimePass-Edit"
Example request
POST https://spaces.nexudus.com/api/billing/coworkertimepasses/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
}
Comments
Please sign in to leave a comment.