The productextraservice object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this productextraservice |
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional |
ExpiresIn: int? optional |
ExtraServiceId: Id required |
ProductId: Id required |
UsesIncluded: int required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this productextraservice |
SystemId: string optional api-only
User defined data about this productextraservice. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"ExpirationType": 1,
"ExpiresIn": ,
"ExtraServiceId": 12345678,
"ProductId": 12345678,
"UsesIncluded": ,
"UniqueId": "3cd3483c-eef8-4392-9504-7cf893b04d5c",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a ProductExtraService
This endpoint allows you to GET a list of productextraservices based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/billing/productextraservices?...
π Requires role "ProductExtraService-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 productextraservice records based on their different properties. |
Id number
?Id=12345678 |
ProductExtraService_ExpirationType Nexudus.Coworking.Core.Enums.eRecurrentChargePattern?
?ProductExtraService_ExpirationType=... |
ProductExtraService_ExpiresIn int?
?ProductExtraService_ExpiresIn=... |
ProductExtraService_ExtraService ExtraService
?ProductExtraService_ExtraService=... |
ProductExtraService_Product Product
?ProductExtraService_Product=... |
ProductExtraService_UsesIncluded int
?ProductExtraService_UsesIncluded=... |
ProductExtraService_ProductName string
?ProductExtraService_ProductName=... |
ProductExtraService_ExtraServiceName string
?ProductExtraService_ExtraServiceName=... |
ProductExtraService_ExtraServiceChargePeriod string
?ProductExtraService_ExtraServiceChargePeriod=... |
ProductExtraService_ExtraServiceIsBookingCredit string
?ProductExtraService_ExtraServiceIsBookingCredit=... |
ProductExtraService_ExtraServiceIsPrintingCredit string
?ProductExtraService_ExtraServiceIsPrintingCredit=... |
Range search querystring parameters
Lets you search productextraservice records based on a range of date or numeric values. |
To_ProductExtraService_CreatedOn date
?To_ProductExtraService_CreatedOn=2010-01-01T20:32 |
From_ProductExtraService_CreatedOn date
?From_ProductExtraService_CreatedOn=2010-01-01T20:32 |
To_ProductExtraService_UpdatedOn date
?To_ProductExtraService_UpdatedOn=2010-01-01T20:32 |
From_ProductExtraService_UpdatedOn date
?From_ProductExtraService_UpdatedOn=2010-01-01T20:32 |
To_ProductExtraService_UsesIncluded number
?To_ProductExtraService_UsesIncluded=0 |
From_ProductExtraService_UsesIncluded number
?From_ProductExtraService_UsesIncluded=10 |
To_ProductExtraService_ExpiresIn number
?To_ProductExtraService_ExpiresIn=0 |
From_ProductExtraService_ExpiresIn number
?From_ProductExtraService_ExpiresIn=10 |
Example request
GET https://spaces.nexudus.com/api/billing/productextraservices?ProductExtraService_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Product": ,
"ExtraService": ,
"UsesIncluded": ,
"ExpirationType": 1,
"ExpiresIn": ,
"ProductExtraServiceProductName": "...",
"ProductExtraServiceExtraServiceName": "...",
"ProductExtraServiceExtraServiceChargePeriod": "...",
"ProductExtraServiceExtraServiceIsBookingCredit": "...",
"ProductExtraServiceExtraServiceIsPrintingCredit": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "6a0ca4f6-a6df-440e-ad3a-103644175bb6",
"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 ProductExtraServices by IDs
Gets one or more productextraservice records based on their Id.GET https://spaces.nexudus.com/api/billing/productextraservices?ProductExtraService_Id=[:id1,:id2,...]
π Requires role "ProductExtraService-List"
Querystring parameters |
ProductExtraService_Id: array requried
?ProductExtraService_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/billing/productextraservices?ProductExtraService_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Product": ,
"ExtraService": ,
"UsesIncluded": ,
"ExpirationType": 1,
"ExpiresIn": ,
"ProductExtraServiceProductName": "...",
"ProductExtraServiceExtraServiceName": "...",
"ProductExtraServiceExtraServiceChargePeriod": "...",
"ProductExtraServiceExtraServiceIsBookingCredit": "...",
"ProductExtraServiceExtraServiceIsPrintingCredit": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "8d48a16e-5819-4cb5-9963-0cf9554efb56",
"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 ProductExtraService by Id
Gets one productextraservice record by its Id.GET https://spaces.nexudus.com/api/billing/productextraservices/:Id
π Requires role "ProductExtraService-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/billing/productextraservices/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"ExpirationType": 1,
"ExpiresIn": ,
"ExtraServiceId": 12345678,
"ProductId": 12345678,
"UsesIncluded": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "f6179813-9983-467f-b6bd-9ce3d077ab49",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new ProductExtraService
Creates a new productextraservice.POST https://spaces.nexudus.com/api/billing/productextraservices
π Requires role "ProductExtraService-Create"
Body parameters |
ProductId: number required |
ExtraServiceId: number required |
UsesIncluded: int required |
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional |
ExpiresIn: int? optional |
Example request
POST https://spaces.nexudus.com/api/billing/productextraservices Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"ProductId": 12345678,
"ExtraServiceId": 12345678,
"UsesIncluded": ,
"ExpirationType": 1, //(check Enumerated values section below)
"ExpiresIn": ,
}
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 ProductExtraService
Updates an existing productextraservice.PUT https://spaces.nexudus.com/api/billing/productextraservices
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "ProductExtraService-Edit"
Body parameters |
Id: number required
The unique Id of the productextraservice to update. |
ProductId: number cleared if missing |
ExtraServiceId: number cleared if missing |
UsesIncluded: int cleared if missing |
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? cleared if missing |
ExpiresIn: int? cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/billing/productextraservices Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"ProductId": 12345678,
"ExtraServiceId": 12345678,
"UsesIncluded": ,
"ExpirationType": 1, //(check Enumerated values section below)
"ExpiresIn": ,
}
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 ProductExtraService
Deletes an existing productextraservice by its Id.DELETE https://spaces.nexudus.com/api/billing/productextraservices/:Id
π Requires role "ProductExtraService-Delete"
URL parameters |
Id: number required
The unique Id of the productextraservice to update. |
Example request
DELETE https://spaces.nexudus.com/api/billing/productextraservices/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 productextraservice 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 productextraservice records.GET https://spaces.nexudus.com/api/billing/productextraservices/commands
Example request
GET https://spaces.nexudus.com/api/billing/productextraservices/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 productextraservice record IDs.POST https://spaces.nexudus.com/api/billing/productextraservices/runacommandπ Requires role "ProductExtraService-Edit"
Example request
POST https://spaces.nexudus.com/api/billing/productextraservices/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
}
Enumerated values
ExpirationType
GET /api/utils/enums?name=eRecurrentChargePattern
Comments
Please sign in to leave a comment.