Skip to main content

Zentry.CheckIns.Api v1.0

Base URLs:

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

NameInTypeRequiredDescription
bodybodyCreateCheckInRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKCheckIn
400Bad RequestBad RequestProblemDetails

CheckOut

POST /CheckIn/{id}/check-out

Body parameter

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

Parameters

NameInTypeRequiredDescription
idpathstringtruenone
bodybodyCheckOutRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKCheckIn

GetCheckIns

POST /CheckIn

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetCheckInsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKCheckInIPagedResponse

DayPassCheckIn

GetDayPassCheckIns

POST /DayPassCheckIn

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetDayPassCheckInsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKDayPassCheckInIPagedResponse

DayPassReservation

GetDayPassReservations

POST /DayPassReservation

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetDayPassReservationsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKDayPassReservationIPagedResponse

GetDayPassReservationUserCostBreakdown

POST /DayPassReservation/user-cost-preview

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateDayPassReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKGetDayPassUserCostBreakdownResponse
400Bad RequestBad RequestProblemDetails

GetDayPassReservationTokenCostBreakdown

POST /DayPassReservation/token-cost-preview

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateDayPassReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKGetDayPassTokenCostBreakdownResponse
400Bad RequestBad RequestProblemDetails

Reservation

CreateDayPassReservation

POST /Reservation/create/daypass

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateDayPassReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKReservation
400Bad RequestBad RequestProblemDetails

CreateRoomReservation

POST /Reservation/create/room

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"roomId": "184d3163ee1ffbbdb38b6c07",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateRoomReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKReservation
400Bad RequestBad RequestProblemDetails

ApproveReservation

PUT /Reservation/{id}/approve

Parameters

NameInTypeRequiredDescription
idpathstringtruenone

Responses

StatusMeaningDescriptionSchema
200OKOKReservation

CancelReservation

DELETE /Reservation

Body parameter

{
"reservationId": "926d3163ee1ffbbdb47b6a76"
}

Parameters

NameInTypeRequiredDescription
bodybodyCancelReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKReservation

GetReservations

POST /Reservation

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetReservationsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKReservationIPagedResponse

RoomCheckIn

GetRoomCheckIns

POST /RoomCheckIn

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetRoomCheckInsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKRoomCheckInIPagedResponse

RoomReservation

GetRoomReservations

POST /RoomReservation

Body parameter

{
"offset": 0,
"limit": 25,
"userIds": [
"926d3163ee1ffbbdb47b6a76"
],
"locationIds": [
"686d3163ee1ffbbdb38b6a74"
],
"workspaceIds": [
"986d3163ee1ffbbdb38b6n34"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumReservationDate": "2019-08-24T14:15:22Z",
"maximumReservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"statuses": [
"Approved",
"Pending"
],
"roomIds": [
"184d3163ee1ffbbdb38b6c07"
],
"occupiedDateRange": {
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
}

Parameters

NameInTypeRequiredDescription
bodybodyGetRoomReservationsRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKRoomReservationIPagedResponse

GetRoomReservationUserCostBreakdown

POST /RoomReservation/user-cost-preview

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"roomId": "184d3163ee1ffbbdb38b6c07",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateRoomReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKGetRoomUserCostBreakdownResponse
400Bad RequestBad RequestProblemDetails

GetRoomReservationTokenCostBreakdown

POST /RoomReservation/token-cost-preview

Body parameter

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"roomId": "184d3163ee1ffbbdb38b6c07",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

Parameters

NameInTypeRequiredDescription
bodybodyCreateRoomReservationRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKGetRoomTokenCostBreakdownResponse
400Bad RequestBad RequestProblemDetails

Token

GetUserTokenCount

POST /Token/user

Body parameter

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

Parameters

NameInTypeRequiredDescription
bodybodyGetUserTokenCountRequestfalsenone

Responses

StatusMeaningDescriptionSchema
200OKOKUserTokenCount

Schemas

CancelReservationRequest

{
"reservationId": "926d3163ee1ffbbdb47b6a76"
}

NameTypeRequiredRestrictionsDescription
reservationIdstringtruenoneZentry Pass Reservation Id

CheckIn

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true
}

NameTypeRequiredRestrictionsDescription
idstringtruenoneThe unique identifier for this entity
dateCreatedstring(date-time)truenoneThe initial date this entity was created
dateUpdatedstring(date-time)truenoneThe last time this entity was updated
userIdstringtruenoneZentry Pass User Id
locationIdstringtruenoneZentry Pass Workspace Location Id
workspaceIdstringtruenoneZentry Pass Workspace Id
tenantIdstringtruenoneZentry Pass Tenant Id
employerIdstringtrueread-onlyShould use TenantId
reservationDatestring(date-time)truenoneThe date of the reservation
reservationTypeReservationTypetruenonenone
timeInstring(date-time)truenoneThe time of check-in
checkInGeoGeofalsenonenone
timeOutstring(date-time)¦nullfalsenoneThe time of check-out
checkOutGeoGeofalsenonenone
checkedInByUserIdstring¦nullfalsenoneThe user that performed the check-in
checkedOutByUserIdstring¦nullfalsenoneThe user that performed the check-in
priceinteger(int64)truenoneThe cost of the check-in. Stored in cents.
tokenCostinteger(int32)¦nullfalsenoneHow many tokens the check-in cost the user.
paymentIdstring¦nullfalsenoneZentry Pass Payment Id
isMarketplacebooleantruenoneFlag indicating if this is a marketplace checkin

CheckInIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[CheckIn]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

CheckInQuery

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

NameTypeRequiredRestrictionsDescription
offsetinteger(int32)truenoneHow far to skip into a collection
limitinteger(int32)truenoneHow many results to return
ids[string]¦nullfalsenoneList of Zentry Pass CheckIn Ids
userIds[string]¦nullfalsenoneList of Zentry Pass User Ids
locationIds[string]¦nullfalsenoneList of Zentry Pass Workspace Location Ids
workspaceIds[string]¦nullfalsenoneList of Zentry Pass Workspace Ids
tenantIds[string]¦nullfalsenoneList of Zentry Pass Tenant Ids
employerIds[string]¦nullfalsenoneShould use TenantIds
minimumTimeInstring(date-time)¦nullfalsenoneFilter check-ins with a TimeIn greater than this time
maximumTimeInstring(date-time)¦nullfalsenoneFilter check-ins with a TimeIn less than this time
excludeCheckOutsboolean¦nullfalsenoneUsed to get checkins that have not checked out yet
reservationTypeReservationTypefalsenonenone

CheckOutRequest

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

NameTypeRequiredRestrictionsDescription
locationGeofalsenonenone

CreateCheckInRequest

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

NameTypeRequiredRestrictionsDescription
reservationIdstringtruenoneZentry Pass Reservation Id
locationGeofalsenonenone

CreateDayPassReservationRequest

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}

NameTypeRequiredRestrictionsDescription
anonymousCreateReservationRequestfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

CreateReservationRequest

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}

NameTypeRequiredRestrictionsDescription
userIdstringtruenoneZentry Pass User Id
locationIdstringtruenoneZentry Pass Workspace Location Id
tenantIdstringtruenoneZentry Pass Tenant Id
employerIdstring¦nullfalsenoneShould use TenantId
reservationDatestring(date-time)truenoneThe date of the reservation

CreateRoomReservationRequest

{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"roomId": "184d3163ee1ffbbdb38b6c07",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

NameTypeRequiredRestrictionsDescription
anonymousCreateReservationRequestfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» roomIdstringtruenoneZentry Pass Room Id
» reservationEndDatestring(date-time)truenoneThe date the reservation ends
» numberOfGuestsinteger(int32)truenoneHow many guests will be in the room

DateRange

{
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}

NameTypeRequiredRestrictionsDescription
fromstring(date-time)truenoneThe start of the date range
tostring(date-time)truenoneThe end of the date range

DayPassCheckIn

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true
}

NameTypeRequiredRestrictionsDescription
anonymousCheckInfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

DayPassCheckInIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[DayPassCheckIn]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

DayPassCheckInQuery

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

NameTypeRequiredRestrictionsDescription
anonymousCheckInQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

DayPassReservation

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true
}

NameTypeRequiredRestrictionsDescription
anonymousReservationfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» reservationTypeReservationTypetruenonenone

DayPassReservationIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[DayPassReservation]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

DayPassReservationQuery

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

NameTypeRequiredRestrictionsDescription
anonymousReservationQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

Fee

{
"name": "string",
"amount": 0
}

NameTypeRequiredRestrictionsDescription
namestringtruenoneThe name of the fee
amountinteger(int64)truenoneThe amount of the fee in cents

Geo

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

NameTypeRequiredRestrictionsDescription
latitudenumber(double)truenonenone
longitudenumber(double)truenonenone

GetCheckInsRequest

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

NameTypeRequiredRestrictionsDescription
anonymousCheckInQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetDayPassCheckInsRequest

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

NameTypeRequiredRestrictionsDescription
anonymousDayPassCheckInQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetDayPassReservationsRequest

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

NameTypeRequiredRestrictionsDescription
anonymousDayPassReservationQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetDayPassTokenCostBreakdownResponse

{
"tokens": 0
}

NameTypeRequiredRestrictionsDescription
tokensinteger(int32)truenoneThe amount of tokens

GetDayPassUserCostBreakdownResponse

{
"amount": 0,
"fees": [
{
"name": "string",
"amount": 0
}
],
"feeTotal": 0,
"taxes": 0,
"total": 0
}

NameTypeRequiredRestrictionsDescription
amountinteger(int64)truenoneThe original amount in cents
fees[Fee]¦nullfalsenoneBreakdown of all the fees
feeTotalinteger(int64)¦nullfalseread-onlyThe amount in fees in cents.
taxesinteger(int64)truenoneThe amount of taxes in cents.
totalinteger(int64)truenoneThe total amount in cents

GetReservationsRequest

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

NameTypeRequiredRestrictionsDescription
anonymousReservationQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetRoomCheckInsRequest

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

NameTypeRequiredRestrictionsDescription
anonymousRoomCheckInQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetRoomReservationsRequest

{
"offset": 0,
"limit": 25,
"userIds": [
"926d3163ee1ffbbdb47b6a76"
],
"locationIds": [
"686d3163ee1ffbbdb38b6a74"
],
"workspaceIds": [
"986d3163ee1ffbbdb38b6n34"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumReservationDate": "2019-08-24T14:15:22Z",
"maximumReservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"statuses": [
"Approved",
"Pending"
],
"roomIds": [
"184d3163ee1ffbbdb38b6c07"
],
"occupiedDateRange": {
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
}

NameTypeRequiredRestrictionsDescription
anonymousRoomReservationQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone

GetRoomTokenCostBreakdownResponse

{
"tokens": 0,
"isFullDay": true
}

NameTypeRequiredRestrictionsDescription
tokensinteger(int32)truenoneThe amount of tokens
isFullDaybooleantruenoneFlag indicating if the cost breakdown was for a full day

GetRoomUserCostBreakdownResponse

{
"amount": 0,
"fees": [
{
"name": "string",
"amount": 0
}
],
"feeTotal": 0,
"taxes": 0,
"total": 0,
"isFullDay": true
}

NameTypeRequiredRestrictionsDescription
amountinteger(int64)truenoneThe original amount in cents
fees[Fee]¦nullfalsenoneBreakdown of all the fees
feeTotalinteger(int64)¦nullfalseread-onlyThe amount in fees in cents.
taxesinteger(int64)truenoneThe amount of taxes in cents.
totalinteger(int64)truenoneThe total amount in cents
isFullDaybooleantruenoneFlag indicating if the cost breakdown was for a full day

GetUserTokenCountRequest

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

Gets the number of tokens used in the passed time frame

NameTypeRequiredRestrictionsDescription
userIdstringtruenoneZentry Pass User Id
tenantIdstringtruenoneZentry Pass Tenant Id
employerIdstring¦nullfalsenoneShould use TenantId
fromDatestring(date-time)¦nullfalsenoneLimit token count to reservations and checkins greater than this date. If this is null, then defaults to the start of the month.
toDatestring(date-time)¦nullfalsenoneLimit 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"
]
}
}

NameTypeRequiredRestrictionsDescription
anonymousProblemDetailsfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» additionalPropertiesanyfalsenonenone
» errorsobjecttruenonenone
»» additionalProperties[string]falsenonenone

IPagedRequest

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

NameTypeRequiredRestrictionsDescription
offsetinteger(int32)trueread-onlyHow far to skip into a collection
limitinteger(int32)trueread-onlyHow many results to return

ProblemDetails

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

NameTypeRequiredRestrictionsDescription
additionalPropertiesanyfalsenonenone
typestring¦nullfalsenonenone
titlestring¦nullfalsenonenone
statusinteger(int32)¦nullfalsenonenone
detailstring¦nullfalsenonenone
instancestring¦nullfalsenonenone

Reservation

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true
}

NameTypeRequiredRestrictionsDescription
idstringtruenoneThe unique identifier for this entity
dateCreatedstring(date-time)truenoneThe initial date this entity was created
dateUpdatedstring(date-time)truenoneThe last time this entity was updated
reservationTypeReservationTypetruenonenone
statusReservationStatustruenonenone
locationIdstringtruenoneZentry Pass Workspace Location Id
workspaceIdstringtruenoneZentry Pass Workspace Id
userIdstringtruenoneZentry Pass User Id
tenantIdstringtruenoneZentry Pass Tenant Id
employerIdstringtrueread-onlyShould use TenantId
reservationDatestring(date-time)truenoneThe date of the reservation
priceinteger(int64)truenoneThe cost of the reservation. Stored in cents.
tokenCostinteger(int32)¦nullfalsenoneHow many tokens the reservation cost the user.
paymentIdstring¦nullfalsenoneZentry Pass Payment Id
isMarketplacebooleantrueread-onlyFlag indicating if this is a marketplace reservation
isWithin24Hoursbooleantrueread-onlyFlag indicating if the reservation is within 24 hours

ReservationIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[Reservation]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

ReservationQuery

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

NameTypeRequiredRestrictionsDescription
offsetinteger(int32)truenoneHow far to skip into a collection
limitinteger(int32)truenoneHow many results to return
userIds[string]¦nullfalsenoneList of Zentry Pass User Ids
locationIds[string]¦nullfalsenoneList of Zentry Pass Workspace Location Ids
workspaceIds[string]¦nullfalsenoneList of Zentry Pass Workspace Ids
tenantIds[string]¦nullfalsenoneList of Zentry Pass Tenant Ids
employerIds[string]¦nullfalsenoneShould use TenantIds
minimumReservationDatestring(date-time)¦nullfalsenoneFilter reservations with a reservation date greater than this time
maximumReservationDatestring(date-time)¦nullfalsenoneFilter reservations with a reservation date less than this time
reservationTypeReservationTypefalsenonenone
statuses[ReservationStatus]¦nullfalsenoneThe status of the reservation

ReservationStatus

"Pending"

NameTypeRequiredRestrictionsDescription
anonymousstringfalsenonenone

Enumerated Values

PropertyValue
anonymousPending
anonymousCancelled
anonymousApproved
anonymousCompleted

ReservationType

"DayPass"

NameTypeRequiredRestrictionsDescription
anonymousstringfalsenonenone

Enumerated Values

PropertyValue
anonymousDayPass
anonymousRoom

RoomCheckIn

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"roomId": "686d3163ee1ffbbdb38b6a74",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

NameTypeRequiredRestrictionsDescription
anonymousCheckInfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» roomIdstringtruenoneZentry Pass Room Id
» reservationEndDatestring(date-time)truenoneThe date the reservation ends
» numberOfGuestsinteger(int32)truenoneHow many guests will be in the room

RoomCheckInIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "526d3163ee1ffbbdb38b6v02",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"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",
"checkedOutByUserId": "string",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"roomId": "686d3163ee1ffbbdb38b6a74",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[RoomCheckIn]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

RoomCheckInQuery

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

NameTypeRequiredRestrictionsDescription
anonymousCheckInQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» roomIds[string]¦nullfalsenoneZentry Pass room id
» occupiedDateRangeDateRangefalsenonenone

RoomReservation

{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true,
"roomId": "686d3163ee1ffbbdb38b6a74",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}

NameTypeRequiredRestrictionsDescription
anonymousReservationfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» reservationTypeReservationTypetruenonenone
» roomIdstringtruenoneZentry Pass Room Id
» reservationEndDatestring(date-time)truenoneThe date the reservation ends
» numberOfGuestsinteger(int32)truenoneHow many guests will be in the room

RoomReservationIPagedResponse

{
"data": [
{
"id": "184d3163ee1ffbbdb38b6c07",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"status": "Pending",
"locationId": "686d3163ee1ffbbdb38b6a74",
"workspaceId": "686d3163ee1ffbbdb38b6a74",
"userId": "926d3163ee1ffbbdb47b6a76",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z",
"price": 10000,
"tokenCost": 10,
"paymentId": "187g3163ee1ffbbdb38b8x09",
"isMarketplace": true,
"isWithin24Hours": true,
"roomId": "686d3163ee1ffbbdb38b6a74",
"reservationEndDate": "2019-08-24T14:15:22Z",
"numberOfGuests": 5
}
],
"pagedRequest": {
"offset": 0,
"limit": 25
},
"totalCount": 100
}

NameTypeRequiredRestrictionsDescription
data[RoomReservation]trueread-onlyThe paged data
pagedRequestIPagedRequesttruenonenone
totalCountinteger(int32)trueread-onlyThe total number of items available

RoomReservationQuery

{
"offset": 0,
"limit": 25,
"userIds": [
"926d3163ee1ffbbdb47b6a76"
],
"locationIds": [
"686d3163ee1ffbbdb38b6a74"
],
"workspaceIds": [
"986d3163ee1ffbbdb38b6n34"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumReservationDate": "2019-08-24T14:15:22Z",
"maximumReservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"statuses": [
"Approved",
"Pending"
],
"roomIds": [
"184d3163ee1ffbbdb38b6c07"
],
"occupiedDateRange": {
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
}

NameTypeRequiredRestrictionsDescription
anonymousReservationQueryfalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» roomIds[string]¦nullfalsenoneZentry Pass room id
» occupiedDateRangeDateRangefalsenonenone

UserTokenCount

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

NameTypeRequiredRestrictionsDescription
userIdstringtruenonenone
tokenCountinteger(int32)truenonenone