Scheduling Work Visits (2.0)
Download OpenAPI specification:Download
Work visits can be scheduled at the request of the customer. This service can only be scheduled by a user with IBX Access Services ordering permission. Work visits are only applicable for visits up to 14 days long. Please note that work visits that exceed 14 days require Security Access approval instead.
Schedule Work Visit Services
This method creates a work visit request that grants IBX visitors access for up to two weeks. This can only be done by a user with work visit request permission.
Authorizations:
Request Body schema: application/json
| description | string [ 10 .. 4000 ] characters Description of the Work Visit | ||||||||||||||||||||||
| customerReferenceId | string [ 1 .. 40 ] characters Customer Reference Number / External Reference Number | ||||||||||||||||||||||
object (purchaseOrder) Purchase Order | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (Attachment) <= 5 items File(s) attached to the Work visit. To learn about including attachments in your request, see POST Attachments API. | |||||||||||||||||||||||
Array (<= 5 items)
| |||||||||||||||||||||||
Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, specify the Technical contact and Notification contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users). | |||||||||||||||||||||||
Array Any of
| |||||||||||||||||||||||
required | object | ||||||||||||||||||||||
| |||||||||||||||||||||||
Responses
| Location | string Example: "/orders/1-23232322" Location of Work Visit request "/orders/1-23232322" |
Request samples
- Payload
{- "description": "Monthly Routine check",
- "customerReferenceId": "048837d6-4cd8-401f-ba41-a4ac015c3f3e",
- "purchaseOrder": {
- "type": "EXISTING",
- "number": 1091238010,
- "amount": "2020",
- "startDate": "2020-05-22",
- "endDate": "2021-05-22",
- "attachmentId": "8d0bef9c-cca9-11ea-87d0-0242ac130003"
}, - "attachments": [
- {
- "id": "c77c5f58-a7ea-4e88-9fc4-1a2900027425",
- "name": "error-log"
}
], - "contacts": [
- {
- "registeredUsers": [
- "john_doe1"
], - "type": "NOTIFICATION",
- "availability": "WORK_HOURS",
- "timezone": "America/Los_Angeles"
}
], - "details": {
- "cages": [
- {
- "id": "DC2:01:123456",
- "accountNumber": "1234567890",
- "cabinetId": "DC2:01:123456:0101"
}
], - "openCabinet": false,
- "visitStartDateTime": "2019-08-24T14:15:22Z",
- "visitEndDateTime": "2019-08-24T14:15:22Z",
- "visitors": [
- {
- "registeredUsers": [
- "john_doe1"
]
}
]
}
}Response samples
- 400
- 403
- 500
[- {
- "errorCode": "EQ-2016011",
- "errorMessage": "One or more mandatory properties are missing.",
- "correlationId": "210407001942756",
- "additionalInfo": [
- {
- "property": "details.cages[0].id",
- "reason": "details.cages[0].id is required"
}
]
}
]Update a work visit order
This method modifies work visit details, such as contacts and visiting information, for a user with work visit request permission.
Authorizations:
path Parameters
| orderId required | string [ 1 .. 100 ] characters Identifier of the work visit orders |
Request Body schema: application/jsonrequired
The work visit order to be updated
Array of objects (ContactRequestRegisteredUser_Update) <= 1 items | |||||||
Array (<= 1 items)
| |||||||
object | |||||||
| |||||||
Responses
Request samples
- Payload
{- "contacts": [
- {
- "registeredUsers": [
- "john_doe1"
], - "type": "NOTIFICATION"
}
], - "details": {
- "visitStartDateTime": "2020-12-17'T'09:15:44Z",
- "visitEndDateTime": "2020-12-18'T'09:15:44Z",
- "openCabinet": false
}
}Response samples
- 400
- 403
- 500
[- {
- "errorCode": "EQ-2016011",
- "errorMessage": "One or more mandatory properties are missing.",
- "correlationId": "210407001942756",
- "additionalInfo": [
- {
- "property": "contacts[0].type",
- "reason": "contacts[0].type is required"
}
]
}
]