Tariffsignupproduct

The tariffsignupproduct object

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

Json Structure Example


{
  "Id": 1234567,
  "Price": ,
  "ProductId": 12345678,
  "Refundable": false,
  "TariffId": 12345678,
  "UniqueId": "2beda280-eaf0-4b4d-899b-601a119f4806",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a TariffSignupProduct

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

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

πŸ”’ Requires role "TariffSignupProduct-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 tariffsignupproduct records based on their different properties.
Id number
?Id=12345678
TariffSignupProduct_Price decimal?
?TariffSignupProduct_Price=...
TariffSignupProduct_Product Product
?TariffSignupProduct_Product=...
TariffSignupProduct_Refundable bool
?TariffSignupProduct_Refundable=...
TariffSignupProduct_Tariff Tariff
?TariffSignupProduct_Tariff=...
TariffSignupProduct_TariffName string
?TariffSignupProduct_TariffName=...
TariffSignupProduct_ProductName string
?TariffSignupProduct_ProductName=...

Range search querystring parameters
Lets you search tariffsignupproduct records based on a range of date or numeric values.
To_TariffSignupProduct_CreatedOn date
?To_TariffSignupProduct_CreatedOn=2010-01-01T20:32
From_TariffSignupProduct_CreatedOn date
?From_TariffSignupProduct_CreatedOn=2010-01-01T20:32
To_TariffSignupProduct_UpdatedOn date
?To_TariffSignupProduct_UpdatedOn=2010-01-01T20:32
From_TariffSignupProduct_UpdatedOn date
?From_TariffSignupProduct_UpdatedOn=2010-01-01T20:32
To_TariffSignupProduct_Price number
?To_TariffSignupProduct_Price=0
From_TariffSignupProduct_Price number
?From_TariffSignupProduct_Price=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "Product": ,
        "Price": ,
        "Refundable": false,
        "TariffSignupProductTariffName": "...",
        "TariffSignupProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e875d33d-04fc-415c-81ff-fb369d173215",
        "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 TariffSignupProducts by IDs

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

πŸ”’ Requires role "TariffSignupProduct-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Tariff": ,
        "Product": ,
        "Price": ,
        "Refundable": false,
        "TariffSignupProductTariffName": "...",
        "TariffSignupProductProductName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c6f2e932-b3b1-47da-86c9-b8b8e37147ee",
        "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 TariffSignupProduct by Id

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

πŸ”’ Requires role "TariffSignupProduct-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Price": ,
  "ProductId": 12345678,
  "Refundable": false,
  "TariffId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "600deacc-56e2-4317-a37e-51d15efcb381",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new TariffSignupProduct

Creates a new tariffsignupproduct.
POST https://spaces.nexudus.com/api/billing/tariffsignupproducts

πŸ”’ Requires role "TariffSignupProduct-Create"

Body parameters
TariffId: number required
ProductId: number required
Price: decimal? optional
Refundable: bool optional

Example request

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

{
    "TariffId": 12345678,
    "ProductId": 12345678,
    "Price": ,
    "Refundable": 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 TariffSignupProduct

Updates an existing tariffsignupproduct.
PUT https://spaces.nexudus.com/api/billing/tariffsignupproducts

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

πŸ”’ Requires role "TariffSignupProduct-Edit"

Body parameters
Id: number required
The unique Id of the tariffsignupproduct to update.
TariffId: number cleared if missing
ProductId: number cleared if missing
Price: decimal? cleared if missing
Refundable: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "TariffId": 12345678,
    "ProductId": 12345678,
    "Price": ,
    "Refundable": 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 TariffSignupProduct

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

πŸ”’ Requires role "TariffSignupProduct-Delete"

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

Example request

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

Example request

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

Example request

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