Timepassprice

The timepassprice object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this timepassprice
Price: decimal required
TariffId: Id required
TimePassId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this timepassprice
SystemId: string optional api-only
User defined data about this timepassprice. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Price": 1.2,
  "TariffId": 12345678,
  "TimePassId": 12345678,
  "UniqueId": "fadeb440-aa55-40db-9553-5143684295ad",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a TimePassPrice

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

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

πŸ”’ Requires role "TimePassPrice-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 timepassprice records based on their different properties.
Id number
?Id=12345678
TimePassPrice_Price decimal
?TimePassPrice_Price=...
TimePassPrice_Tariff Tariff
?TimePassPrice_Tariff=...
TimePassPrice_TimePass TimePass
?TimePassPrice_TimePass=...
TimePassPrice_TimePassName string
?TimePassPrice_TimePassName=...
TimePassPrice_TariffName string
?TimePassPrice_TariffName=...

Range search querystring parameters
Lets you search timepassprice records based on a range of date or numeric values.
To_TimePassPrice_CreatedOn date
?To_TimePassPrice_CreatedOn=2010-01-01T20:32
From_TimePassPrice_CreatedOn date
?From_TimePassPrice_CreatedOn=2010-01-01T20:32
To_TimePassPrice_UpdatedOn date
?To_TimePassPrice_UpdatedOn=2010-01-01T20:32
From_TimePassPrice_UpdatedOn date
?From_TimePassPrice_UpdatedOn=2010-01-01T20:32
To_TimePassPrice_Price number
?To_TimePassPrice_Price=0
From_TimePassPrice_Price number
?From_TimePassPrice_Price=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "TimePass": ,
        "Tariff": ,
        "Price": 1.2,
        "TimePassPriceTimePassName": "...",
        "TimePassPriceTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7c5f2aec-c694-41b9-aba7-76d1feb1adf8",
        "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 TimePassPrices by IDs

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

πŸ”’ Requires role "TimePassPrice-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "TimePass": ,
        "Tariff": ,
        "Price": 1.2,
        "TimePassPriceTimePassName": "...",
        "TimePassPriceTariffName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "beea4638-31cd-4ccd-bb85-dbda7a8f11cf",
        "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 TimePassPrice by Id

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

πŸ”’ Requires role "TimePassPrice-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Price": 1.2,
  "TariffId": 12345678,
  "TimePassId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "9c53cdc6-2561-4029-be49-06987860b841",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new TimePassPrice

Creates a new timepassprice.
POST https://spaces.nexudus.com/api/billing/timepassprices

πŸ”’ Requires role "TimePassPrice-Create"

Body parameters
TimePassId: number required
TariffId: number required
Price: decimal required

Example request

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

{
    "TimePassId": 12345678,
    "TariffId": 12345678,
    "Price": 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 TimePassPrice

Updates an existing timepassprice.
PUT https://spaces.nexudus.com/api/billing/timepassprices

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

πŸ”’ Requires role "TimePassPrice-Edit"

Body parameters
Id: number required
The unique Id of the timepassprice to update.
TimePassId: number cleared if missing
TariffId: number cleared if missing
Price: decimal cleared if missing

Example request

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

{
    "Id": 12345678,
    "TimePassId": 12345678,
    "TariffId": 12345678,
    "Price": 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"
        },
    ]
}


Delete TimePassPrice

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

πŸ”’ Requires role "TimePassPrice-Delete"

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

Example request

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

Example request

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

Example request

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