Reference

Coworkerpriceplanhistory

The coworkerpriceplanhistory object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerpriceplanhistory
CoworkerId: Id required
IsUpgrade: bool optional
NewQuantity: int? optional
NewTariffName: string optional
NewValue: decimal? optional
Notes: string optional
OldQuantity: int? optional
OldTariffName: string optional
OldValue: decimal? optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerpriceplanhistory
SystemId: string optional api-only
User defined data about this coworkerpriceplanhistory. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "CoworkerId": 12345678,
  "IsUpgrade": false,
  "NewQuantity": ,
  "NewTariffName": "New Price Plan",
  "NewValue": ,
  "Notes": "Notes",
  "OldQuantity": ,
  "OldTariffName": "Old Price Plan",
  "OldValue": ,
  "UniqueId": "04da0aef-404b-486c-9171-4984cf171af8",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerPricePlanHistory

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

GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories?...

๐Ÿ”’ Requires role "CoworkerPricePlanHistory-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 coworkerpriceplanhistory records based on their different properties.
Id number
?Id=12345678
CoworkerPricePlanHistory_Coworker Coworker
?CoworkerPricePlanHistory_Coworker=...
CoworkerPricePlanHistory_IsUpgrade bool
?CoworkerPricePlanHistory_IsUpgrade=...
CoworkerPricePlanHistory_NewQuantity int?
?CoworkerPricePlanHistory_NewQuantity=...
CoworkerPricePlanHistory_NewTariffName string
?CoworkerPricePlanHistory_NewTariffName=...
CoworkerPricePlanHistory_NewValue decimal?
?CoworkerPricePlanHistory_NewValue=...
CoworkerPricePlanHistory_Notes string
?CoworkerPricePlanHistory_Notes=...
CoworkerPricePlanHistory_OldQuantity int?
?CoworkerPricePlanHistory_OldQuantity=...
CoworkerPricePlanHistory_OldTariffName string
?CoworkerPricePlanHistory_OldTariffName=...
CoworkerPricePlanHistory_OldValue decimal?
?CoworkerPricePlanHistory_OldValue=...

Range search querystring parameters
Lets you search coworkerpriceplanhistory records based on a range of date or numeric values.
To_CoworkerPricePlanHistory_CreatedOn date
?To_CoworkerPricePlanHistory_CreatedOn=2010-01-01T20:32
From_CoworkerPricePlanHistory_CreatedOn date
?From_CoworkerPricePlanHistory_CreatedOn=2010-01-01T20:32
To_CoworkerPricePlanHistory_UpdatedOn date
?To_CoworkerPricePlanHistory_UpdatedOn=2010-01-01T20:32
From_CoworkerPricePlanHistory_UpdatedOn date
?From_CoworkerPricePlanHistory_UpdatedOn=2010-01-01T20:32
To_CoworkerPricePlanHistory_OldValue number
?To_CoworkerPricePlanHistory_OldValue=0
From_CoworkerPricePlanHistory_OldValue number
?From_CoworkerPricePlanHistory_OldValue=10
To_CoworkerPricePlanHistory_NewValue number
?To_CoworkerPricePlanHistory_NewValue=0
From_CoworkerPricePlanHistory_NewValue number
?From_CoworkerPricePlanHistory_NewValue=10
To_CoworkerPricePlanHistory_OldQuantity number
?To_CoworkerPricePlanHistory_OldQuantity=0
From_CoworkerPricePlanHistory_OldQuantity number
?From_CoworkerPricePlanHistory_OldQuantity=10
To_CoworkerPricePlanHistory_NewQuantity number
?To_CoworkerPricePlanHistory_NewQuantity=0
From_CoworkerPricePlanHistory_NewQuantity number
?From_CoworkerPricePlanHistory_NewQuantity=10

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories?CoworkerPricePlanHistory_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "OldTariffName": "Old Price Plan",
        "NewTariffName": "New Price Plan",
        "IsUpgrade": false,
        "Notes": "Notes",
        "OldValue": ,
        "NewValue": ,
        "OldQuantity": ,
        "NewQuantity": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b4fa63d5-8a4f-437c-8422-9148a45a0b96",
        "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 CoworkerPricePlanHistories by IDs

Gets one or more coworkerpriceplanhistory records based on their Id.
GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories?CoworkerPricePlanHistory_Id=[:id1,:id2,...]

๐Ÿ”’ Requires role "CoworkerPricePlanHistory-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "OldTariffName": "Old Price Plan",
        "NewTariffName": "New Price Plan",
        "IsUpgrade": false,
        "Notes": "Notes",
        "OldValue": ,
        "NewValue": ,
        "OldQuantity": ,
        "NewQuantity": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "76e9c3aa-0d31-476b-9f31-c9982737ad38",
        "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 CoworkerPricePlanHistory by Id

Gets one coworkerpriceplanhistory record by its Id.
GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories/:Id

๐Ÿ”’ Requires role "CoworkerPricePlanHistory-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CoworkerId": 12345678,
  "IsUpgrade": false,
  "NewQuantity": ,
  "NewTariffName": "New Price Plan",
  "NewValue": ,
  "Notes": "Notes",
  "OldQuantity": ,
  "OldTariffName": "Old Price Plan",
  "OldValue": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "6a9760b8-303e-43ea-9aca-7532a341eaec",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerPricePlanHistory

Creates a new coworkerpriceplanhistory.
POST https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories

๐Ÿ”’ Requires role "CoworkerPricePlanHistory-Create"

Body parameters
CoworkerId: number required
OldTariffName: string optional
NewTariffName: string optional
IsUpgrade: bool optional
Notes: string optional
OldValue: decimal? optional
NewValue: decimal? optional
OldQuantity: int? optional
NewQuantity: int? optional

Example request

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

{
    "CoworkerId": 12345678,
    "OldTariffName": "Old Price Plan",
    "NewTariffName": "New Price Plan",
    "IsUpgrade": false,
    "Notes": "Notes",
    "OldValue": ,
    "NewValue": ,
    "OldQuantity": ,
    "NewQuantity": ,
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more coworkerpriceplanhistory 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 coworkerpriceplanhistory records.
GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories/commands

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories/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 coworkerpriceplanhistory record IDs.
POST https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories/runacommand
๐Ÿ”’ Requires role "CoworkerPricePlanHistory-Edit"

Example request

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