API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Billing

Resourceproduct

The resourceproduct object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this resourceproduct
InvoiceInMinutes: bool optional
ProductId: Id required
RequestQuantity: bool optional
ResourceId: Id required
Visible: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this resourceproduct
SystemId: string optional api-only
User defined data about this resourceproduct. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "InvoiceInMinutes": false,
  "ProductId": 12345678,
  "RequestQuantity": false,
  "ResourceId": 12345678,
  "Visible": false,
  "UniqueId": "041da97a-623e-4613-890d-462afa2ae744",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a ResourceProduct

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

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

🔒 Requires role "ResourceProduct-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=ProductName
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 resourceproduct records based on their different properties.
Id number
?Id=12345678
ResourceProduct_InvoiceInMinutes bool
?ResourceProduct_InvoiceInMinutes=...
ResourceProduct_Product Product
?ResourceProduct_Product=...
ResourceProduct_RequestQuantity bool
?ResourceProduct_RequestQuantity=...
ResourceProduct_Resource Resource
?ResourceProduct_Resource=...
ResourceProduct_Visible bool
?ResourceProduct_Visible=...
ResourceProduct_ProductName string
?ResourceProduct_ProductName=...

Range search querystring parameters
Lets you search resourceproduct records based on a range of date or numeric values.
To_ResourceProduct_CreatedOn date
?To_ResourceProduct_CreatedOn=2010-01-01T20:32
From_ResourceProduct_CreatedOn date
?From_ResourceProduct_CreatedOn=2010-01-01T20:32
To_ResourceProduct_UpdatedOn date
?To_ResourceProduct_UpdatedOn=2010-01-01T20:32
From_ResourceProduct_UpdatedOn date
?From_ResourceProduct_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Resource": ,
        "Product": ,
        "InvoiceInMinutes": false,
        "RequestQuantity": false,
        "Visible": false,
        "ResourceProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b38dbd2e-830b-4bac-b95e-26ec62f42328",
        "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 ResourceProducts by IDs

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

🔒 Requires role "ResourceProduct-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Resource": ,
        "Product": ,
        "InvoiceInMinutes": false,
        "RequestQuantity": false,
        "Visible": false,
        "ResourceProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c9f03a4d-723c-408e-8659-bdb4b1834839",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "ProductName",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single ResourceProduct by Id

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

🔒 Requires role "ResourceProduct-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "InvoiceInMinutes": false,
  "ProductId": 12345678,
  "RequestQuantity": false,
  "ResourceId": 12345678,
  "Visible": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "a6fede2a-5623-4149-8c20-20f99dfffccb",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new ResourceProduct

Creates a new resourceproduct. 
POST https://spaces.nexudus.com/api/billing/resourceproducts

🔒 Requires role "ResourceProduct-Create"

Body parameters
ResourceId: number required
ProductId: number required
InvoiceInMinutes: bool optional
RequestQuantity: bool optional
Visible: bool optional

Example request

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


{
    "ResourceId": 12345678,
    "ProductId": 12345678,
    "InvoiceInMinutes": false,
    "RequestQuantity": false,
    "Visible": false,
}

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 ResourceProduct

Updates an existing resourceproduct. 
PUT https://spaces.nexudus.com/api/billing/resourceproducts

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

🔒 Requires role "ResourceProduct-Edit"

Body parameters
Id: number required
The unique Id of the resourceproduct to update.
ResourceId: number cleared if missing
ProductId: number cleared if missing
InvoiceInMinutes: bool cleared if missing
RequestQuantity: bool cleared if missing
Visible: bool cleared if missing

Example request

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


{
    "Id": 12345678,
    "ResourceId": 12345678,
    "ProductId": 12345678,
    "InvoiceInMinutes": false,
    "RequestQuantity": false,
    "Visible": false,
}

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 ResourceProduct

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

🔒 Requires role "ResourceProduct-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/billing/resourceproducts/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 resourceproduct record IDs. 
POST https://spaces.nexudus.com/api/billing/resourceproducts/runacommand
🔒 Requires role "ResourceProduct-Edit"

Example request

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