Reference

Failedcheckin

The failedcheckin object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this failedcheckin
BusinessId: Id required
CheckinAttemptTime: DateTime required
CoworkerId: Id optional
Description: string optional
MacAddresses: string optional
Source: Nexudus.Coworking.Core.Enums.eCheckinSource optional read-only
TariffAtTheTimeOfCheckin: string optional
TeamsAtTheTimeOfCheckin: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this failedcheckin
SystemId: string optional api-only
User defined data about this failedcheckin. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CheckinAttemptTime": 2020-01-01T21:03:54Z,
  "CoworkerId": 12345678,
  "Description": "false",
  "MacAddresses": "null",
  "Source": 1,
  "TariffAtTheTimeOfCheckin": "false",
  "TeamsAtTheTimeOfCheckin": "false",
  "UniqueId": "521e136e-837c-41b8-9b67-4ce88ea72d8d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a FailedCheckin

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

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

πŸ”’ Requires role "FailedCheckin-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=CreatedOn
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Descending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search failedcheckin records based on their different properties.
Id number
?Id=12345678
FailedCheckin_Business Business
?FailedCheckin_Business=...
FailedCheckin_CheckinAttemptTime DateTime
?FailedCheckin_CheckinAttemptTime=...
FailedCheckin_Coworker Coworker
?FailedCheckin_Coworker=...
FailedCheckin_Description string
?FailedCheckin_Description=...
FailedCheckin_MacAddresses string
?FailedCheckin_MacAddresses=...
FailedCheckin_Source Nexudus.Coworking.Core.Enums.eCheckinSource
?FailedCheckin_Source=...
FailedCheckin_TariffAtTheTimeOfCheckin string
?FailedCheckin_TariffAtTheTimeOfCheckin=...
FailedCheckin_TeamsAtTheTimeOfCheckin string
?FailedCheckin_TeamsAtTheTimeOfCheckin=...
FailedCheckin_CoworkerFullName string
?FailedCheckin_CoworkerFullName=...
FailedCheckin_BusinessName string
?FailedCheckin_BusinessName=...

Range search querystring parameters
Lets you search failedcheckin records based on a range of date or numeric values.
To_FailedCheckin_CreatedOn date
?To_FailedCheckin_CreatedOn=2010-01-01T20:32
From_FailedCheckin_CreatedOn date
?From_FailedCheckin_CreatedOn=2010-01-01T20:32
To_FailedCheckin_UpdatedOn date
?To_FailedCheckin_UpdatedOn=2010-01-01T20:32
From_FailedCheckin_UpdatedOn date
?From_FailedCheckin_UpdatedOn=2010-01-01T20:32
To_FailedCheckin_CheckinAttemptTime date
?To_FailedCheckin_CheckinAttemptTime=2010-01-01T20:32
From_FailedCheckin_CheckinAttemptTime date
?From_FailedCheckin_CheckinAttemptTime=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "CheckinAttemptTime": 2020-01-01T21:03:54Z,
        "Source": 1,
        "MacAddresses": "null",
        "TeamsAtTheTimeOfCheckin": "false",
        "TariffAtTheTimeOfCheckin": "false",
        "Description": "false",
        "FailedCheckinCoworkerFullName": "...",
        "FailedCheckinBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1a207a42-ad8d-4e85-b4b6-b98bf03a7c1c",
        "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 FailedCheckins by IDs

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

πŸ”’ Requires role "FailedCheckin-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Business": ,
        "CheckinAttemptTime": 2020-01-01T21:03:54Z,
        "Source": 1,
        "MacAddresses": "null",
        "TeamsAtTheTimeOfCheckin": "false",
        "TariffAtTheTimeOfCheckin": "false",
        "Description": "false",
        "FailedCheckinCoworkerFullName": "...",
        "FailedCheckinBusinessName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "121abf1b-4657-4289-9e20-38188241a34d",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "CreatedOn",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single FailedCheckin by Id

Gets one failedcheckin record by its Id.
GET https://spaces.nexudus.com/api/spaces/failedcheckins/:Id

πŸ”’ Requires role "FailedCheckin-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CheckinAttemptTime": 2020-01-01T21:03:54Z,
  "CoworkerId": 12345678,
  "Description": "false",
  "MacAddresses": "null",
  "Source": 1,
  "TariffAtTheTimeOfCheckin": "false",
  "TeamsAtTheTimeOfCheckin": "false",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "fa174cae-60ff-425a-b793-5fd0b990df47",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new FailedCheckin

Creates a new failedcheckin.
POST https://spaces.nexudus.com/api/spaces/failedcheckins

πŸ”’ Requires role "FailedCheckin-Create"

Body parameters
CoworkerId: number optional
BusinessId: number required
CheckinAttemptTime: DateTime required
MacAddresses: string optional
TeamsAtTheTimeOfCheckin: string optional
TariffAtTheTimeOfCheckin: string optional
Description: string optional

Example request

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

{
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "CheckinAttemptTime": 2020-01-01T21:03:54Z,
    "MacAddresses": "null",
    "TeamsAtTheTimeOfCheckin": "false",
    "TariffAtTheTimeOfCheckin": "false",
    "Description": "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 FailedCheckin

Updates an existing failedcheckin.
PUT https://spaces.nexudus.com/api/spaces/failedcheckins

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

πŸ”’ Requires role "FailedCheckin-Edit"

Body parameters
Id: number required
The unique Id of the failedcheckin to update.
CoworkerId: number cleared if missing
BusinessId: number cleared if missing
CheckinAttemptTime: DateTime cleared if missing
MacAddresses: string cleared if missing
TeamsAtTheTimeOfCheckin: string cleared if missing
TariffAtTheTimeOfCheckin: string cleared if missing
Description: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "CoworkerId": 12345678,
    "BusinessId": 12345678,
    "CheckinAttemptTime": 2020-01-01T21:03:54Z,
    "MacAddresses": "null",
    "TeamsAtTheTimeOfCheckin": "false",
    "TariffAtTheTimeOfCheckin": "false",
    "Description": "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 FailedCheckin

Deletes an existing failedcheckin by its Id.
DELETE https://spaces.nexudus.com/api/spaces/failedcheckins/:Id

πŸ”’ Requires role "FailedCheckin-Delete"

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

Example request

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

Example request

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

Example request

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


Enumerated values

Source

GET /api/utils/enums?name=eCheckinSource

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.