Reference

Coworkerdiscountcode

The coworkerdiscountcode object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerdiscountcode
BusinessId: Id required
CoworkerId: Id required
DiscountCodeId: Id required
ExpiresOn: DateTime? optional
Notes: string optional
TimesUsed: int required read-only
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerdiscountcode
SystemId: string optional api-only
User defined data about this coworkerdiscountcode. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CoworkerId": 12345678,
  "DiscountCodeId": 12345678,
  "ExpiresOn": ,
  "Notes": "Notes",
  "TimesUsed": ,
  "UniqueId": "1b111175-a839-4170-b894-0f3066ab5d0b",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerDiscountCode

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

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

πŸ”’ Requires role "CoworkerDiscountCode-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 coworkerdiscountcode records based on their different properties.
Id number
?Id=12345678
CoworkerDiscountCode_Business Business
?CoworkerDiscountCode_Business=...
CoworkerDiscountCode_Coworker Coworker
?CoworkerDiscountCode_Coworker=...
CoworkerDiscountCode_DiscountCode DiscountCode
?CoworkerDiscountCode_DiscountCode=...
CoworkerDiscountCode_ExpiresOn DateTime?
?CoworkerDiscountCode_ExpiresOn=...
CoworkerDiscountCode_Notes string
?CoworkerDiscountCode_Notes=...
CoworkerDiscountCode_TimesUsed int
?CoworkerDiscountCode_TimesUsed=...
CoworkerDiscountCode_CoworkerFullName string
?CoworkerDiscountCode_CoworkerFullName=...
CoworkerDiscountCode_BusinessName string
?CoworkerDiscountCode_BusinessName=...
CoworkerDiscountCode_DiscountCodeCode string
?CoworkerDiscountCode_DiscountCodeCode=...

Range search querystring parameters
Lets you search coworkerdiscountcode records based on a range of date or numeric values.
To_CoworkerDiscountCode_CreatedOn date
?To_CoworkerDiscountCode_CreatedOn=2010-01-01T20:32
From_CoworkerDiscountCode_CreatedOn date
?From_CoworkerDiscountCode_CreatedOn=2010-01-01T20:32
To_CoworkerDiscountCode_UpdatedOn date
?To_CoworkerDiscountCode_UpdatedOn=2010-01-01T20:32
From_CoworkerDiscountCode_UpdatedOn date
?From_CoworkerDiscountCode_UpdatedOn=2010-01-01T20:32
To_CoworkerDiscountCode_TimesUsed number
?To_CoworkerDiscountCode_TimesUsed=0
From_CoworkerDiscountCode_TimesUsed number
?From_CoworkerDiscountCode_TimesUsed=10
To_CoworkerDiscountCode_ExpiresOn date
?To_CoworkerDiscountCode_ExpiresOn=2010-01-01T20:32
From_CoworkerDiscountCode_ExpiresOn date
?From_CoworkerDiscountCode_ExpiresOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "DiscountCode": ,
        "Notes": "Notes",
        "TimesUsed": ,
        "ExpiresOn": ,
        "CoworkerDiscountCodeCoworkerFullName": "...",
        "CoworkerDiscountCodeBusinessName": "...",
        "CoworkerDiscountCodeDiscountCodeCode": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "9cbfe19b-da8d-4505-818e-9a5d7280f4ad",
        "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 CoworkerDiscountCodes by IDs

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

πŸ”’ Requires role "CoworkerDiscountCode-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "DiscountCode": ,
        "Notes": "Notes",
        "TimesUsed": ,
        "ExpiresOn": ,
        "CoworkerDiscountCodeCoworkerFullName": "...",
        "CoworkerDiscountCodeBusinessName": "...",
        "CoworkerDiscountCodeDiscountCodeCode": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "77ff96dd-32a0-46f8-95e7-e2e637f0fabe",
        "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 CoworkerDiscountCode by Id

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

πŸ”’ Requires role "CoworkerDiscountCode-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CoworkerId": 12345678,
  "DiscountCodeId": 12345678,
  "ExpiresOn": ,
  "Notes": "Notes",
  "TimesUsed": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "719998c8-4c5e-440d-b4e7-b09bd6ac46cb",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerDiscountCode

Creates a new coworkerdiscountcode.
POST https://spaces.nexudus.com/api/billing/coworkerdiscountcodes

πŸ”’ Requires role "CoworkerDiscountCode-Create"

Body parameters
CoworkerId: number required
BusinessId: number required
DiscountCodeId: number required
Notes: string optional
ExpiresOn: DateTime? optional

Example request

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

{
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "DiscountCodeId": 12345678,
    "Notes": "Notes",
    "ExpiresOn": ,
}


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 CoworkerDiscountCode

Updates an existing coworkerdiscountcode.
PUT https://spaces.nexudus.com/api/billing/coworkerdiscountcodes

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

πŸ”’ Requires role "CoworkerDiscountCode-Edit"

Body parameters
Id: number required
The unique Id of the coworkerdiscountcode to update.
CoworkerId: number cleared if missing
BusinessId: number cleared if missing
DiscountCodeId: number cleared if missing
Notes: string cleared if missing
ExpiresOn: DateTime? cleared if missing

Example request

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

{
    "Id": 12345678,
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "DiscountCodeId": 12345678,
    "Notes": "Notes",
    "ExpiresOn": ,
}


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 CoworkerDiscountCode

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

πŸ”’ Requires role "CoworkerDiscountCode-Delete"

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

Example request

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

Example request

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

Example request

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