Reference

Producttimepass

The producttimepass object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this producttimepass
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional
ExpiresIn: int? optional
PassesIncluded: int required
ProductId: Id required
TimePassId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this producttimepass
SystemId: string optional api-only
User defined data about this producttimepass. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ExpirationType": 1,
  "ExpiresIn": ,
  "PassesIncluded": ,
  "ProductId": 12345678,
  "TimePassId": 12345678,
  "UniqueId": "7cdbbcbc-3981-45e0-8240-55d8129a34f2",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ProductTimePass

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

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

πŸ”’ Requires role "ProductTimePass-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 producttimepass records based on their different properties.
Id number
?Id=12345678
ProductTimePass_ExpirationType Nexudus.Coworking.Core.Enums.eRecurrentChargePattern?
?ProductTimePass_ExpirationType=...
ProductTimePass_ExpiresIn int?
?ProductTimePass_ExpiresIn=...
ProductTimePass_PassesIncluded int
?ProductTimePass_PassesIncluded=...
ProductTimePass_Product Product
?ProductTimePass_Product=...
ProductTimePass_TimePass TimePass
?ProductTimePass_TimePass=...
ProductTimePass_ProductName string
?ProductTimePass_ProductName=...
ProductTimePass_TimePassName string
?ProductTimePass_TimePassName=...

Range search querystring parameters
Lets you search producttimepass records based on a range of date or numeric values.
To_ProductTimePass_CreatedOn date
?To_ProductTimePass_CreatedOn=2010-01-01T20:32
From_ProductTimePass_CreatedOn date
?From_ProductTimePass_CreatedOn=2010-01-01T20:32
To_ProductTimePass_UpdatedOn date
?To_ProductTimePass_UpdatedOn=2010-01-01T20:32
From_ProductTimePass_UpdatedOn date
?From_ProductTimePass_UpdatedOn=2010-01-01T20:32
To_ProductTimePass_PassesIncluded number
?To_ProductTimePass_PassesIncluded=0
From_ProductTimePass_PassesIncluded number
?From_ProductTimePass_PassesIncluded=10
To_ProductTimePass_ExpiresIn number
?To_ProductTimePass_ExpiresIn=0
From_ProductTimePass_ExpiresIn number
?From_ProductTimePass_ExpiresIn=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Product": ,
        "TimePass": ,
        "PassesIncluded": ,
        "ExpirationType": 1,
        "ExpiresIn": ,
        "ProductTimePassProductName": "...",
        "ProductTimePassTimePassName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "4083a4f6-1dfb-4782-b42e-887c22308c02",
        "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 ProductTimePasses by IDs

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

πŸ”’ Requires role "ProductTimePass-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Product": ,
        "TimePass": ,
        "PassesIncluded": ,
        "ExpirationType": 1,
        "ExpiresIn": ,
        "ProductTimePassProductName": "...",
        "ProductTimePassTimePassName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1fd35a29-40f8-4b74-89c0-23204e05f5f0",
        "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 ProductTimePass by Id

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

πŸ”’ Requires role "ProductTimePass-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ExpirationType": 1,
  "ExpiresIn": ,
  "PassesIncluded": ,
  "ProductId": 12345678,
  "TimePassId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "602341de-3300-434a-be38-ac0933a17633",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ProductTimePass

Creates a new producttimepass.
POST https://spaces.nexudus.com/api/billing/producttimepasses

πŸ”’ Requires role "ProductTimePass-Create"

Body parameters
ProductId: number required
TimePassId: number required
PassesIncluded: int required
ExpirationType: Nexudus.Coworking.Core.Enums.eRecurrentChargePattern? optional
ExpiresIn: int? optional

Example request

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

{
    "ProductId": 12345678,
    "TimePassId": 12345678,
    "PassesIncluded": ,
    "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 ProductTimePass

Updates an existing producttimepass.
PUT https://spaces.nexudus.com/api/billing/producttimepasses

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

πŸ”’ Requires role "ProductTimePass-Edit"

Body parameters
Id: number required
The unique Id of the producttimepass to update.
ProductId: number cleared if missing
TimePassId: number cleared if missing
PassesIncluded: 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/producttimepasses
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "ProductId": 12345678,
    "TimePassId": 12345678,
    "PassesIncluded": ,
    "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 ProductTimePass

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

πŸ”’ Requires role "ProductTimePass-Delete"

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

Example request

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

Example request

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

Example request

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

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.