Create FailedCheckin

POST

api

spaces

failedcheckins

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/failedcheckins \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CheckinAttemptTime": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/failedcheckins"

payload = {
    "BusinessId": 123,
    "CheckinAttemptTime": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, CheckinAttemptTime: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/failedcheckins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A FailedCheckin records an unsuccessful check-in attempt by a coworker (see Checkin entity). Each record captures the coworker involved, the location where the attempt occurred, the reason for the failure, and contextual details such as the coworker’s teams and tariff at the time. Failed check-ins are read-only and generated automatically by the system when a check-in is rejected — for example, due to access restrictions, an inactive plan, or an unrecognised device. Use the Description field to inspect the specific failure reason. The Source field indicates how the check-in was initiated (e.g. manual, Wi-Fi, app) and matches the eCheckinSource enum used by the Checkin entity.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the FailedCheckin-Create role.

Enums

eCheckinSource — Source values

Value	Name
0	None
1	Manual
2	DoorAccess
3	NetworkActivity
4	Tile
5	Sensor

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Date and time when the check-in attempt occurred.

Optional Fields

integer

ID of the coworker linked to this record.

string

MAC addresses of the device used during the check-in attempt, if available.

string

Comma-separated list of teams the coworker belonged to at the time of the failed check-in.

string

Name of the pricing plan (tariff) assigned to the coworker at the time of the failed check-in.

string

Reason or explanation for why the check-in attempt failed.

string

Date/time value for checkin attempt time local.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/failedcheckins" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CheckinAttemptTime": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/failedcheckins',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CheckinAttemptTime: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/failedcheckins',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CheckinAttemptTime': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the failedcheckin was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FailedCheckin was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "CheckinAttemptTime: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CheckinAttemptTime"
    }
  ],
  "WasSuccessful": false
}

Update FailedCheckinUpdate an existing FailedCheckin record.

Create FailedCheckin

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/failedcheckins \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CheckinAttemptTime": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/failedcheckins"

payload = {
    "BusinessId": 123,
    "CheckinAttemptTime": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, CheckinAttemptTime: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/failedcheckins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400