Tariffextraservice

The tariffextraservice object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this tariffextraservice
ExtraServiceId: Id required
ServiceRenewalTime: Nexudus.Coworking.Core.Enums.eTimeSpanWeekMonth optional
TariffId: Id required
UsesIncluded: int required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this tariffextraservice
SystemId: string optional api-only
User defined data about this tariffextraservice. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ExtraServiceId": 12345678,
  "ServiceRenewalTime": 1,
  "TariffId": 12345678,
  "UsesIncluded": ,
  "UniqueId": "049a9894-4f04-426b-94b0-e25b1ba59901",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a TariffExtraService

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

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

πŸ”’ Requires role "TariffExtraService-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 tariffextraservice records based on their different properties.
Id number
?Id=12345678
TariffExtraService_ExtraService ExtraService
?TariffExtraService_ExtraService=...
TariffExtraService_ServiceRenewalTime Nexudus.Coworking.Core.Enums.eTimeSpanWeekMonth
?TariffExtraService_ServiceRenewalTime=...
TariffExtraService_Tariff Tariff
?TariffExtraService_Tariff=...
TariffExtraService_UsesIncluded int
?TariffExtraService_UsesIncluded=...
TariffExtraService_TariffName string
?TariffExtraService_TariffName=...
TariffExtraService_ExtraServiceName string
?TariffExtraService_ExtraServiceName=...
TariffExtraService_ExtraServiceChargePeriod string
?TariffExtraService_ExtraServiceChargePeriod=...
TariffExtraService_ExtraServiceIsBookingCredit string
?TariffExtraService_ExtraServiceIsBookingCredit=...
TariffExtraService_ExtraServiceIsPrintingCredit string
?TariffExtraService_ExtraServiceIsPrintingCredit=...

Range search querystring parameters
Lets you search tariffextraservice records based on a range of date or numeric values.
To_TariffExtraService_CreatedOn date
?To_TariffExtraService_CreatedOn=2010-01-01T20:32
From_TariffExtraService_CreatedOn date
?From_TariffExtraService_CreatedOn=2010-01-01T20:32
To_TariffExtraService_UpdatedOn date
?To_TariffExtraService_UpdatedOn=2010-01-01T20:32
From_TariffExtraService_UpdatedOn date
?From_TariffExtraService_UpdatedOn=2010-01-01T20:32
To_TariffExtraService_UsesIncluded number
?To_TariffExtraService_UsesIncluded=0
From_TariffExtraService_UsesIncluded number
?From_TariffExtraService_UsesIncluded=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "ExtraService": ,
        "UsesIncluded": ,
        "ServiceRenewalTime": 1,
        "TariffExtraServiceTariffName": "...",
        "TariffExtraServiceExtraServiceName": "...",
        "TariffExtraServiceExtraServiceChargePeriod": "...",
        "TariffExtraServiceExtraServiceIsBookingCredit": "...",
        "TariffExtraServiceExtraServiceIsPrintingCredit": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "01d8b922-5fcb-4de0-8eb4-98f56b06dea9",
        "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 TariffExtraServices by IDs

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

πŸ”’ Requires role "TariffExtraService-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "ExtraService": ,
        "UsesIncluded": ,
        "ServiceRenewalTime": 1,
        "TariffExtraServiceTariffName": "...",
        "TariffExtraServiceExtraServiceName": "...",
        "TariffExtraServiceExtraServiceChargePeriod": "...",
        "TariffExtraServiceExtraServiceIsBookingCredit": "...",
        "TariffExtraServiceExtraServiceIsPrintingCredit": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c1bcefd6-dee9-4a20-93c5-8d4e68b6d4ce",
        "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 TariffExtraService by Id

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

πŸ”’ Requires role "TariffExtraService-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ExtraServiceId": 12345678,
  "ServiceRenewalTime": 1,
  "TariffId": 12345678,
  "UsesIncluded": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "184bf73a-6b52-47dc-88d0-9b87a9003484",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new TariffExtraService

Creates a new tariffextraservice.
POST https://spaces.nexudus.com/api/billing/tariffextraservices

πŸ”’ Requires role "TariffExtraService-Create"

Body parameters
TariffId: number required
ExtraServiceId: number required
UsesIncluded: int required
ServiceRenewalTime: Nexudus.Coworking.Core.Enums.eTimeSpanWeekMonth optional

Example request

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

{
    "TariffId": 12345678,
    "ExtraServiceId": 12345678,
    "UsesIncluded": ,
    "ServiceRenewalTime": 1, //(check Enumerated values section below)
}


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 TariffExtraService

Updates an existing tariffextraservice.
PUT https://spaces.nexudus.com/api/billing/tariffextraservices

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

πŸ”’ Requires role "TariffExtraService-Edit"

Body parameters
Id: number required
The unique Id of the tariffextraservice to update.
TariffId: number cleared if missing
ExtraServiceId: number cleared if missing
UsesIncluded: int cleared if missing
ServiceRenewalTime: Nexudus.Coworking.Core.Enums.eTimeSpanWeekMonth cleared if missing

Example request

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

{
    "Id": 12345678,
    "TariffId": 12345678,
    "ExtraServiceId": 12345678,
    "UsesIncluded": ,
    "ServiceRenewalTime": 1, //(check Enumerated values section below)
}


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 TariffExtraService

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

πŸ”’ Requires role "TariffExtraService-Delete"

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

Example request

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

Example request

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

Example request

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

ServiceRenewalTime

GET /api/utils/enums?name=eTimeSpanWeekMonth

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.