Zentry.CheckIns.Api v1.0

Base URLs:

https://api.checkin.zentrypass.com

Authentication

API Key (API_KEY)
- Parameter Name: Api-Key Authentication, in: header.

CheckIn

CreateCheckIn

POST /CheckIn/create

Body parameter

{
  "reservationId": "926d3163ee1ffbbdb47b6a76",
  "location": {
    "latitude": 38.62,
    "longitude": -90.18
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CreateCheckInRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	CheckIn

CheckOut

POST /CheckIn/check-out

Body parameter

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "location": {
    "latitude": 38.62,
    "longitude": -90.18
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CheckOutRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	CheckIn

GetCheckIns

POST /CheckIn

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumTimeIn": "2019-08-24T14:15:22Z",
  "maximumTimeIn": "2019-08-24T14:15:22Z",
  "excludeCheckOuts": true
}

Parameters

Name	In	Type	Required	Description
body	body	GetCheckInsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	CheckInIPagedResponse

Reservation

CreateReservation

POST /Reservation/create

Body parameter

{
  "userId": "926d3163ee1ffbbdb47b6a76",
  "locationId": "686d3163ee1ffbbdb38b6a74",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "reservationDate": "2019-08-24T14:15:22Z",
  "userTimeZone": "America/Chicago"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateReservationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Reservation
400	Bad Request	Bad Request	ProblemDetails

DeleteReservation

DELETE /Reservation

Body parameter

{
  "reservationId": "926d3163ee1ffbbdb47b6a76"
}

Parameters

Name	In	Type	Required	Description
body	body	DeleteReservationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

GetReservations

POST /Reservation

Body parameter

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumReservationDate": "2019-08-24T14:15:22Z",
  "maximumReservationDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	GetReservationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ReservationIPagedResponse

Token

GetUserTokenCount

POST /Token/user

Body parameter

{
  "userId": "926d3163ee1ffbbdb47b6a76",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	GetUserTokenCountRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserTokenCount

Schemas

CheckIn

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "locationId": "686d3163ee1ffbbdb38b6a74",
  "workspaceId": "string",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "reservationDate": "2019-08-24T14:15:22Z",
  "timeIn": "2019-08-24T14:15:22Z",
  "checkInGeo": {
    "latitude": 38.62,
    "longitude": -90.18
  },
  "timeOut": "2019-08-24T14:15:22Z",
  "checkOutGeo": {
    "latitude": 38.62,
    "longitude": -90.18
  },
  "checkedInByUserId": "string",
  "price": 10000,
  "tokenCost": 10
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
userId	string	true	none	Zentry Pass User Id
locationId	string	true	none	Zentry Pass Workspace Location Id
workspaceId	string	true	none	none
employerId	string	true	none	Zentry Pass Employer Id
reservationDate	string(date-time)	true	none	The date of the reservation
timeIn	string(date-time)	true	none	The time of check-in
checkInGeo	Geo	false	none	none
timeOut	string(date-time)¦null	false	none	The time of check-out
checkOutGeo	Geo	false	none	none
checkedInByUserId	string¦null	false	none	The user that performed the check-in
price	integer(int64)	true	none	The cost of the location. Stored in cents.
tokenCost	integer(int32)	true	none	How many tokens the location cost

CheckInIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "userId": "926d3163ee1ffbbdb47b6a76",
      "locationId": "686d3163ee1ffbbdb38b6a74",
      "workspaceId": "string",
      "employerId": "184d3163ee1ffbbdb38b6c07",
      "reservationDate": "2019-08-24T14:15:22Z",
      "timeIn": "2019-08-24T14:15:22Z",
      "checkInGeo": {
        "latitude": 38.62,
        "longitude": -90.18
      },
      "timeOut": "2019-08-24T14:15:22Z",
      "checkOutGeo": {
        "latitude": 38.62,
        "longitude": -90.18
      },
      "checkedInByUserId": "string",
      "price": 10000,
      "tokenCost": 10
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[CheckIn]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

CheckInQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumTimeIn": "2019-08-24T14:15:22Z",
  "maximumTimeIn": "2019-08-24T14:15:22Z",
  "excludeCheckOuts": true
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	List of Zentry Pass CheckIn Ids
userIds	[string]¦null	false	none	List of Zentry Pass User Ids
locationIds	[string]¦null	false	none	List of Zentry Pass Workspace Location Ids
workspaceIds	[string]¦null	false	none	List of Zentry Pass Workspace Ids
employerIds	[string]¦null	false	none	List of Zentry Pass Employer Ids
minimumTimeIn	string(date-time)¦null	false	none	Filter check-ins with a TimeIn greater than this time
maximumTimeIn	string(date-time)¦null	false	none	Filter check-ins with a TimeIn less than this time
excludeCheckOuts	boolean¦null	false	none	Used to get checkins that have not checked out yet

CheckOutRequest

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "location": {
    "latitude": 38.62,
    "longitude": -90.18
  }
}

Name	Type	Required	Restrictions	Description
id	string	true	none	Zentry Pass CheckIn Id
location	Geo	false	none	none

CreateCheckInRequest

{
  "reservationId": "926d3163ee1ffbbdb47b6a76",
  "location": {
    "latitude": 38.62,
    "longitude": -90.18
  }
}

Name	Type	Required	Restrictions	Description
reservationId	string	true	none	Zentry Pass Reservation Id
location	Geo	false	none	none

CreateReservationRequest

{
  "userId": "926d3163ee1ffbbdb47b6a76",
  "locationId": "686d3163ee1ffbbdb38b6a74",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "reservationDate": "2019-08-24T14:15:22Z",
  "userTimeZone": "America/Chicago"
}

Name	Type	Required	Restrictions	Description
userId	string	true	none	Zentry Pass User Id
locationId	string	true	none	Zentry Pass Workspace Location Id
employerId	string	true	none	Zentry Pass Employer Id
reservationDate	string(date-time)	true	none	The date of the reservation
userTimeZone	string	true	none	The user's time zone

DeleteReservationRequest

{
  "reservationId": "926d3163ee1ffbbdb47b6a76"
}

Name	Type	Required	Restrictions	Description
reservationId	string	true	none	Zentry Pass Reservation Id

Geo

{
  "latitude": 38.62,
  "longitude": -90.18
}

Name	Type	Required	Restrictions	Description
latitude	number(double)	true	none	none
longitude	number(double)	true	none	none

GetCheckInsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumTimeIn": "2019-08-24T14:15:22Z",
  "maximumTimeIn": "2019-08-24T14:15:22Z",
  "excludeCheckOuts": true
}

Name	Type	Required	Restrictions	Description
anonymous	CheckInQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetReservationsRequest

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumReservationDate": "2019-08-24T14:15:22Z",
  "maximumReservationDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
anonymous	ReservationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUserTokenCountRequest

{
  "userId": "926d3163ee1ffbbdb47b6a76",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Gets the number of tokens used in the passed time frame

Name	Type	Required	Restrictions	Description
userId	string	true	none	Zentry Pass User Id
employerId	string	true	none	Zentry Pass Employer Id
fromDate	string(date-time)¦null	false	none	Limit token count to reservations and checkins greater than this date. If this is null, then defaults to the start of the month.
toDate	string(date-time)¦null	false	none	Limit token count to reservations and checkins less than this date. If FromDate is null, then this value is ignored.

HttpValidationProblemDetails

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Name	Type	Required	Restrictions	Description
anonymous	ProblemDetails	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» additionalProperties	any	false	none	none
» errors	object	true	none	none
»» additionalProperties	[string]	false	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

ProblemDetails

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none
type	string¦null	false	none	none
title	string¦null	false	none	none
status	integer(int32)¦null	false	none	none
detail	string¦null	false	none	none
instance	string¦null	false	none	none

Reservation

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "locationId": "686d3163ee1ffbbdb38b6a74",
  "workspaceId": "686d3163ee1ffbbdb38b6a74",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "employerId": "184d3163ee1ffbbdb38b6c07",
  "reservationDate": "2019-08-24T14:15:22Z",
  "price": 10000,
  "tokenCost": 10
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
locationId	string	true	none	Zentry Pass Workspace Location Id
workspaceId	string	true	none	Zentry Pass Workspace Id
userId	string	true	none	Zentry Pass User Id
employerId	string	true	none	Zentry Pass Employer Id
reservationDate	string(date-time)	true	none	The date of the reservation
price	integer(int64)	true	none	The cost of the location. Stored in cents.
tokenCost	integer(int32)	true	none	How many tokens the location cost

ReservationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "locationId": "686d3163ee1ffbbdb38b6a74",
      "workspaceId": "686d3163ee1ffbbdb38b6a74",
      "userId": "926d3163ee1ffbbdb47b6a76",
      "employerId": "184d3163ee1ffbbdb38b6c07",
      "reservationDate": "2019-08-24T14:15:22Z",
      "price": 10000,
      "tokenCost": 10
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Reservation]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

ReservationQuery

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "926d3163ee1ffbbdb47b6a76"
  ],
  "locationIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "workspaceIds": [
    "986d3163ee1ffbbdb38b6n34"
  ],
  "employerIds": [
    "184d3163ee1ffbbdb38b6c07"
  ],
  "minimumReservationDate": "2019-08-24T14:15:22Z",
  "maximumReservationDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
userIds	[string]¦null	false	none	List of Zentry Pass User Ids
locationIds	[string]¦null	false	none	List of Zentry Pass Workspace Location Ids
workspaceIds	[string]¦null	false	none	List of Zentry Pass Workspace Ids
employerIds	[string]¦null	false	none	List of Zentry Pass Employer Ids
minimumReservationDate	string(date-time)¦null	false	none	Filter reservations with a reservation date greater than this time
maximumReservationDate	string(date-time)¦null	false	none	Filter reservations with a reservation date less than this time

UserTokenCount

{
  "userId": "string",
  "tokenCount": 0
}

Name	Type	Required	Restrictions	Description
userId	string	true	none	none
tokenCount	integer(int32)	true	none	none

Zentry.CheckIns.Api v1.0

CheckIn​

CreateCheckIn​

Parameters

Responses

CheckOut​

Parameters

Responses

GetCheckIns​

Parameters

Responses

Reservation​

CreateReservation​

Parameters

Responses

DeleteReservation​

Parameters

Responses

GetReservations​

Parameters

Responses

Token​

GetUserTokenCount​

Parameters

Responses

Schemas​

CheckIn​

CheckInIPagedResponse​

CheckInQuery​

CheckOutRequest​

CreateCheckInRequest​

CreateReservationRequest​

DeleteReservationRequest​

Geo​

GetCheckInsRequest​

GetReservationsRequest​

GetUserTokenCountRequest​

HttpValidationProblemDetails​

IPagedRequest​

ProblemDetails​

Reservation​

ReservationIPagedResponse​

ReservationQuery​

UserTokenCount​

CheckIn

CreateCheckIn

CheckOut

GetCheckIns

Reservation

CreateReservation

DeleteReservation

GetReservations

Token

GetUserTokenCount

Schemas

CheckIn

CheckInIPagedResponse

CheckInQuery

CheckOutRequest

CreateCheckInRequest

CreateReservationRequest

DeleteReservationRequest

Geo

GetCheckInsRequest

GetReservationsRequest

GetUserTokenCountRequest

HttpValidationProblemDetails

IPagedRequest

ProblemDetails

Reservation

ReservationIPagedResponse

ReservationQuery

UserTokenCount