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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateCheckInRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CheckIn |
| 400 | Bad Request | Bad Request | ProblemDetails |
CheckOut
POST /CheckIn/{id}/check-out
Body parameter
{
"location": {
"latitude": 38.62,
"longitude": -90.18
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| 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"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumTimeIn": "2019-08-24T14:15:22Z",
"maximumTimeIn": "2019-08-24T14:15:22Z",
"excludeCheckOuts": true,
"reservationType": "DayPass"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetCheckInsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CheckInIPagedResponse |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetDayPassCheckInsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | DayPassCheckInIPagedResponse |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetDayPassReservationsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | DayPassReservationIPagedResponse |
GetDayPassReservationUserCostBreakdown
POST /DayPassReservation/user-cost-preview
Body parameter
{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateDayPassReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetDayPassUserCostBreakdownResponse |
| 400 | Bad Request | Bad Request | ProblemDetails |
GetDayPassReservationTokenCostBreakdown
POST /DayPassReservation/token-cost-preview
Body parameter
{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateDayPassReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetDayPassTokenCostBreakdownResponse |
| 400 | Bad Request | Bad Request | ProblemDetails |
Reservation
CreateDayPassReservation
POST /Reservation/create/daypass
Body parameter
{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateDayPassReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Reservation |
| 400 | Bad Request | Bad Request | ProblemDetails |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateRoomReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Reservation |
| 400 | Bad Request | Bad Request | ProblemDetails |
ApproveReservation
PUT /Reservation/{id}/approve
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Reservation |
CancelReservation
DELETE /Reservation
Body parameter
{
"reservationId": "926d3163ee1ffbbdb47b6a76"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CancelReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Reservation |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetReservationsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ReservationIPagedResponse |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetRoomCheckInsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | RoomCheckInIPagedResponse |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetRoomReservationsRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | RoomReservationIPagedResponse |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateRoomReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetRoomUserCostBreakdownResponse |
| 400 | Bad Request | Bad Request | ProblemDetails |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateRoomReservationRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | GetRoomTokenCostBreakdownResponse |
| 400 | Bad Request | Bad Request | ProblemDetails |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GetUserTokenCountRequest | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | UserTokenCount |
Schemas
CancelReservationRequest
{
"reservationId": "926d3163ee1ffbbdb47b6a76"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reservationId | string | true | none | Zentry 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
}
| 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 | Zentry Pass Workspace Id |
| tenantId | string | true | none | Zentry Pass Tenant Id |
| employerId | string | true | read-only | Should use TenantId |
| reservationDate | string(date-time) | true | none | The date of the reservation |
| reservationType | ReservationType | true | none | none |
| 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 |
| checkedOutByUserId | string¦null | false | none | The user that performed the check-in |
| price | integer(int64) | true | none | The cost of the check-in. Stored in cents. |
| tokenCost | integer(int32)¦null | false | none | How many tokens the check-in cost the user. |
| paymentId | string¦null | false | none | Zentry Pass Payment Id |
| isMarketplace | boolean | true | none | Flag 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
}
| 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"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumTimeIn": "2019-08-24T14:15:22Z",
"maximumTimeIn": "2019-08-24T14:15:22Z",
"excludeCheckOuts": true,
"reservationType": "DayPass"
}
| 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 |
| tenantIds | [string]¦null | false | none | List of Zentry Pass Tenant Ids |
| employerIds | [string]¦null | false | none | Should use TenantIds |
| 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 |
| reservationType | ReservationType | false | none | none |
CheckOutRequest
{
"location": {
"latitude": 38.62,
"longitude": -90.18
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| 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 |
CreateDayPassReservationRequest
{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CreateReservationRequest | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
CreateReservationRequest
{
"userId": "926d3163ee1ffbbdb47b6a76",
"locationId": "686d3163ee1ffbbdb38b6a74",
"tenantId": "184d3163ee1ffbbdb38b6c07",
"employerId": "string",
"reservationDate": "2019-08-24T14:15:22Z"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| userId | string | true | none | Zentry Pass User Id |
| locationId | string | true | none | Zentry Pass Workspace Location Id |
| tenantId | string | true | none | Zentry Pass Tenant Id |
| employerId | string¦null | false | none | Should use TenantId |
| reservationDate | string(date-time) | true | none | The 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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CreateReservationRequest | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » roomId | string | true | none | Zentry Pass Room Id |
| » reservationEndDate | string(date-time) | true | none | The date the reservation ends |
| » numberOfGuests | integer(int32) | true | none | How many guests will be in the room |
DateRange
{
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| from | string(date-time) | true | none | The start of the date range |
| to | string(date-time) | true | none | The 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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CheckIn | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [DayPassCheckIn] | true | read-only | The paged data |
| pagedRequest | IPagedRequest | true | none | none |
| totalCount | integer(int32) | true | read-only | The 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"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CheckInQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Reservation | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » reservationType | ReservationType | true | none | none |
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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [DayPassReservation] | true | read-only | The paged data |
| pagedRequest | IPagedRequest | true | none | none |
| totalCount | integer(int32) | true | read-only | The 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"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ReservationQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
Fee
{
"name": "string",
"amount": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | The name of the fee |
| amount | integer(int64) | true | none | The amount of the fee in cents |
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"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumTimeIn": "2019-08-24T14:15:22Z",
"maximumTimeIn": "2019-08-24T14:15:22Z",
"excludeCheckOuts": true,
"reservationType": "DayPass"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CheckInQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | DayPassCheckInQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | DayPassReservationQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
GetDayPassTokenCostBreakdownResponse
{
"tokens": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokens | integer(int32) | true | none | The amount of tokens |
GetDayPassUserCostBreakdownResponse
{
"amount": 0,
"fees": [
{
"name": "string",
"amount": 0
}
],
"feeTotal": 0,
"taxes": 0,
"total": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | integer(int64) | true | none | The original amount in cents |
| fees | [Fee]¦null | false | none | Breakdown of all the fees |
| feeTotal | integer(int64)¦null | false | read-only | The amount in fees in cents. |
| taxes | integer(int64) | true | none | The amount of taxes in cents. |
| total | integer(int64) | true | none | The 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"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ReservationQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | RoomCheckInQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
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"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | RoomReservationQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
GetRoomTokenCostBreakdownResponse
{
"tokens": 0,
"isFullDay": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokens | integer(int32) | true | none | The amount of tokens |
| isFullDay | boolean | true | none | Flag 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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | integer(int64) | true | none | The original amount in cents |
| fees | [Fee]¦null | false | none | Breakdown of all the fees |
| feeTotal | integer(int64)¦null | false | read-only | The amount in fees in cents. |
| taxes | integer(int64) | true | none | The amount of taxes in cents. |
| total | integer(int64) | true | none | The total amount in cents |
| isFullDay | boolean | true | none | Flag 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
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| userId | string | true | none | Zentry Pass User Id |
| tenantId | string | true | none | Zentry Pass Tenant Id |
| employerId | string¦null | false | none | Should use TenantId |
| 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",
"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
}
| 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 |
| reservationType | ReservationType | true | none | none |
| status | ReservationStatus | true | none | none |
| 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 |
| tenantId | string | true | none | Zentry Pass Tenant Id |
| employerId | string | true | read-only | Should use TenantId |
| reservationDate | string(date-time) | true | none | The date of the reservation |
| price | integer(int64) | true | none | The cost of the reservation. Stored in cents. |
| tokenCost | integer(int32)¦null | false | none | How many tokens the reservation cost the user. |
| paymentId | string¦null | false | none | Zentry Pass Payment Id |
| isMarketplace | boolean | true | read-only | Flag indicating if this is a marketplace reservation |
| isWithin24Hours | boolean | true | read-only | Flag 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
}
| 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"
],
"tenantIds": [
"184d3163ee1ffbbdb38b6c07"
],
"employerIds": [
"string"
],
"minimumReservationDate": "2019-08-24T14:15:22Z",
"maximumReservationDate": "2019-08-24T14:15:22Z",
"reservationType": "DayPass",
"statuses": [
"Approved",
"Pending"
]
}
| 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 |
| tenantIds | [string]¦null | false | none | List of Zentry Pass Tenant Ids |
| employerIds | [string]¦null | false | none | Should use TenantIds |
| 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 |
| reservationType | ReservationType | false | none | none |
| statuses | [ReservationStatus]¦null | false | none | The status of the reservation |
ReservationStatus
"Pending"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Pending |
| anonymous | Cancelled |
| anonymous | Approved |
| anonymous | Completed |
ReservationType
"DayPass"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | DayPass |
| anonymous | Room |
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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CheckIn | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » roomId | string | true | none | Zentry Pass Room Id |
| » reservationEndDate | string(date-time) | true | none | The date the reservation ends |
| » numberOfGuests | integer(int32) | true | none | How 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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [RoomCheckIn] | true | read-only | The paged data |
| pagedRequest | IPagedRequest | true | none | none |
| totalCount | integer(int32) | true | read-only | The 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"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CheckInQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » roomIds | [string]¦null | false | none | Zentry Pass room id |
| » occupiedDateRange | DateRange | false | none | none |
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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Reservation | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » reservationType | ReservationType | true | none | none |
| » roomId | string | true | none | Zentry Pass Room Id |
| » reservationEndDate | string(date-time) | true | none | The date the reservation ends |
| » numberOfGuests | integer(int32) | true | none | How 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
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [RoomReservation] | true | read-only | The paged data |
| pagedRequest | IPagedRequest | true | none | none |
| totalCount | integer(int32) | true | read-only | The 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"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ReservationQuery | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » roomIds | [string]¦null | false | none | Zentry Pass room id |
| » occupiedDateRange | DateRange | false | none | none |
UserTokenCount
{
"userId": "string",
"tokenCount": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| userId | string | true | none | none |
| tokenCount | integer(int32) | true | none | none |