Reference

Accesstoken

The accesstoken object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this accesstoken
AccessCode: string required
BusinessId: Id required
Description: string optional
LastAccess: DateTime? optional read-only
MinutesIncluded: int required
MinutesLeft: int required read-only
UserLimit: int? optional
ValidFrom: DateTime? optional
ValidTo: DateTime? optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this accesstoken
SystemId: string optional api-only
User defined data about this accesstoken. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AccessCode": "00001",
  "BusinessId": 12345678,
  "Description": "Description",
  "LastAccess": ,
  "MinutesIncluded": ,
  "MinutesLeft": ,
  "UserLimit": ,
  "ValidFrom": ,
  "ValidTo": ,
  "UniqueId": "d0d0c98d-f01b-4869-9e48-1db584428e9b",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a AccessToken

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

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

πŸ”’ Requires role "AccessToken-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 accesstoken records based on their different properties.
Id number
?Id=12345678
AccessToken_AccessCode string
?AccessToken_AccessCode=...
AccessToken_Business Business
?AccessToken_Business=...
AccessToken_Description string
?AccessToken_Description=...
AccessToken_LastAccess DateTime?
?AccessToken_LastAccess=...
AccessToken_MinutesIncluded int
?AccessToken_MinutesIncluded=...
AccessToken_MinutesLeft int
?AccessToken_MinutesLeft=...
AccessToken_UserLimit int?
?AccessToken_UserLimit=...
AccessToken_ValidFrom DateTime?
?AccessToken_ValidFrom=...
AccessToken_ValidTo DateTime?
?AccessToken_ValidTo=...

Range search querystring parameters
Lets you search accesstoken records based on a range of date or numeric values.
To_AccessToken_CreatedOn date
?To_AccessToken_CreatedOn=2010-01-01T20:32
From_AccessToken_CreatedOn date
?From_AccessToken_CreatedOn=2010-01-01T20:32
To_AccessToken_UpdatedOn date
?To_AccessToken_UpdatedOn=2010-01-01T20:32
From_AccessToken_UpdatedOn date
?From_AccessToken_UpdatedOn=2010-01-01T20:32
To_AccessToken_MinutesIncluded number
?To_AccessToken_MinutesIncluded=0
From_AccessToken_MinutesIncluded number
?From_AccessToken_MinutesIncluded=10
To_AccessToken_ValidFrom date
?To_AccessToken_ValidFrom=2010-01-01T20:32
From_AccessToken_ValidFrom date
?From_AccessToken_ValidFrom=2010-01-01T20:32
To_AccessToken_ValidTo date
?To_AccessToken_ValidTo=2010-01-01T20:32
From_AccessToken_ValidTo date
?From_AccessToken_ValidTo=2010-01-01T20:32
To_AccessToken_UserLimit number
?To_AccessToken_UserLimit=0
From_AccessToken_UserLimit number
?From_AccessToken_UserLimit=10
To_AccessToken_MinutesLeft number
?To_AccessToken_MinutesLeft=0
From_AccessToken_MinutesLeft number
?From_AccessToken_MinutesLeft=10
To_AccessToken_LastAccess date
?To_AccessToken_LastAccess=2010-01-01T20:32
From_AccessToken_LastAccess date
?From_AccessToken_LastAccess=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "AccessCode": "00001",
        "Description": "Description",
        "MinutesIncluded": ,
        "ValidFrom": ,
        "ValidTo": ,
        "UserLimit": ,
        "MinutesLeft": ,
        "LastAccess": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b55c2296-eee2-4ed2-ba81-1872095ac341",
        "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 AccessTokens by IDs

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

πŸ”’ Requires role "AccessToken-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "AccessCode": "00001",
        "Description": "Description",
        "MinutesIncluded": ,
        "ValidFrom": ,
        "ValidTo": ,
        "UserLimit": ,
        "MinutesLeft": ,
        "LastAccess": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "4ba905ed-5f56-47ea-ae93-a7180127df26",
        "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 AccessToken by Id

Gets one accesstoken record by its Id.
GET https://spaces.nexudus.com/api/spaces/accesstokens/:Id

πŸ”’ Requires role "AccessToken-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AccessCode": "00001",
  "BusinessId": 12345678,
  "Description": "Description",
  "LastAccess": ,
  "MinutesIncluded": ,
  "MinutesLeft": ,
  "UserLimit": ,
  "ValidFrom": ,
  "ValidTo": ,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "23b380bb-5dcb-416c-b022-c7c082e9f95c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new AccessToken

Creates a new accesstoken.
POST https://spaces.nexudus.com/api/spaces/accesstokens

πŸ”’ Requires role "AccessToken-Create"

Body parameters
BusinessId: number required
AccessCode: string required
Description: string optional
MinutesIncluded: int required
ValidFrom: DateTime? optional
ValidTo: DateTime? optional
UserLimit: int? optional

Example request

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

{
    "BusinessId": 12345678,
    "AccessCode": "00001",
    "Description": "Description",
    "MinutesIncluded": ,
    "ValidFrom": ,
    "ValidTo": ,
    "UserLimit": ,
}


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 AccessToken

Updates an existing accesstoken.
PUT https://spaces.nexudus.com/api/spaces/accesstokens

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

πŸ”’ Requires role "AccessToken-Edit"

Body parameters
Id: number required
The unique Id of the accesstoken to update.
BusinessId: number cleared if missing
AccessCode: string cleared if missing
Description: string cleared if missing
MinutesIncluded: int cleared if missing
ValidFrom: DateTime? cleared if missing
ValidTo: DateTime? cleared if missing
UserLimit: int? cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "AccessCode": "00001",
    "Description": "Description",
    "MinutesIncluded": ,
    "ValidFrom": ,
    "ValidTo": ,
    "UserLimit": ,
}


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 AccessToken

Deletes an existing accesstoken by its Id.
DELETE https://spaces.nexudus.com/api/spaces/accesstokens/:Id

πŸ”’ Requires role "AccessToken-Delete"

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

Example request

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

Example request

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

Example request

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