Reference

Passportcard

The passportcard object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this passportcard
Active: bool optional
Code: string required
Notes: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this passportcard
SystemId: string optional api-only
User defined data about this passportcard. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "Code": "00001",
  "Notes": "Notes",
  "UniqueId": "1c04be27-a3cc-4731-a95a-ba5c63c1e2ae",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a PassportCard

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

GET https://spaces.nexudus.com/api/sys/passportcards?...

πŸ”’ Requires role "PassportCard-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 passportcard records based on their different properties.
Id number
?Id=12345678
PassportCard_Active bool
?PassportCard_Active=...
PassportCard_Code string
?PassportCard_Code=...
PassportCard_Notes string
?PassportCard_Notes=...

Range search querystring parameters
Lets you search passportcard records based on a range of date or numeric values.
To_PassportCard_CreatedOn date
?To_PassportCard_CreatedOn=2010-01-01T20:32
From_PassportCard_CreatedOn date
?From_PassportCard_CreatedOn=2010-01-01T20:32
To_PassportCard_UpdatedOn date
?To_PassportCard_UpdatedOn=2010-01-01T20:32
From_PassportCard_UpdatedOn date
?From_PassportCard_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/passportcards?PassportCard_Code=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Code": "00001",
        "Active": false,
        "Notes": "Notes",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "064ec8ea-da9c-4f5b-996f-6c42c5eb8364",
        "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 PassportCards by IDs

Gets one or more passportcard records based on their Id.
GET https://spaces.nexudus.com/api/sys/passportcards?PassportCard_Id=[:id1,:id2,...]

πŸ”’ Requires role "PassportCard-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Code": "00001",
        "Active": false,
        "Notes": "Notes",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "2158a4d9-805e-4c67-a497-04da57430ba7",
        "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 PassportCard by Id

Gets one passportcard record by its Id.
GET https://spaces.nexudus.com/api/sys/passportcards/:Id

πŸ”’ Requires role "PassportCard-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Active": false,
  "Code": "00001",
  "Notes": "Notes",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "939c47d7-18da-4b9c-950e-4d813e068edd",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new PassportCard

Creates a new passportcard.
POST https://spaces.nexudus.com/api/sys/passportcards

πŸ”’ Requires role "PassportCard-Create"

Body parameters
Code: string required
Active: bool optional
Notes: string optional

Example request

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

{
    "Code": "00001",
    "Active": false,
    "Notes": "Notes",
}


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 PassportCard

Updates an existing passportcard.
PUT https://spaces.nexudus.com/api/sys/passportcards

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

πŸ”’ Requires role "PassportCard-Edit"

Body parameters
Id: number required
The unique Id of the passportcard to update.
Code: string cleared if missing
Active: bool cleared if missing
Notes: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "Code": "00001",
    "Active": false,
    "Notes": "Notes",
}


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 PassportCard

Deletes an existing passportcard by its Id.
DELETE https://spaces.nexudus.com/api/sys/passportcards/:Id

πŸ”’ Requires role "PassportCard-Delete"

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

Example request

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

Example request

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

Example request

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