Work Visit (1.0)
Download OpenAPI specification:Download
Schedule a Work Visit by providing the IBX and cage you will need access to, the dates and times of the visit, and some basic information about the visitors who will be arriving at the site. Work visits have a maximum duration of two weeks. If a visitor needs to be on-site for more than two weeks please add them as a user with IBX access.
Get Work visit Locations Deprecated
The Get work visit locations API returns all IBXs and related cages where the user has 'IBX Access Services Request' permission. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.
query Parameters
| detail | boolean Default: false When enable this flag returns detailed permission with Cage & Cabinets. |
| ibxs | string IBX Filter. Example: AM1, AM2 |
| cages | string Cage Filter. Example: AM1:0G:00EQ |
header Parameters
| Authorization required | string Specify the Access token with prefix 'Bearer'. |
Responses
Response Schema: application/json
Array of objects (Location) | |||||
Array
| |||||
Response samples
- 200
- 400
- 403
- 500
{- "locations": [
- {
- "ibx": "AM1",
- "cages": [
- {
- "cage": "AM1:02:002MC1",
- "cageTypes": [
- "Shared"
], - "accounts": [
- {
- "number": "1111",
- "name": "ABC Network Services",
- "isCreditHold": false,
- "isPOBearing": true,
- "isMonetAccount": false,
- "cabinets": [
- {
- "cabinet": "AM1:02:002MC1:0601",
- "cabinetType": "Shared"
}, - {
- "cabinet": "AM1:02:002MC1:0602",
- "cabinetType": "Shared"
}
]
}
]
}
]
}
]
}Schedule Work Visit Deprecated
The Post work visit API creates a work visit request to grant IBX visitors access for up to two weeks. This can only be done under a user with 'IBX Access Services Request' permission.
header Parameters
| Authorization required | string Specify the Access token with prefix 'Bearer'. |
Request Body schema: application/json
required | Array of objects (Contact Info) >= 2 items Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored. | ||||||||||||||||||||||||||||||||
Array (>= 2 items)
| |||||||||||||||||||||||||||||||||
| customerReferenceNumber | string [ 1 .. 50 ] characters You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. | ||||||||||||||||||||||||||||||||
required | object (IBX Location) | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Array of objects (Attachment) <= 5 items Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API | |||||||||||||||||||||||||||||||||
Array (<= 5 items)
| |||||||||||||||||||||||||||||||||
required | object (Service Detail) | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Responses
Response Schema: application/json
Array of objects | |||||
Array
| |||||
Request samples
- Payload
{- "contacts": [
- {
- "contactType": "ORDERING",
- "userName": "jondoe@test.com"
}, - {
- "contactType": "NOTIFICATION",
- "userName": "jondoe@test.com"
}, - {
- "contactType": "TECHNICAL",
- "name": "John Doe",
- "workPhone": "1111111",
- "workPhonePrefToCall": "ANYTIME",
- "mobilePhone": "1111111",
- "mobilePhonePrefToCall": "ANYTIME"
}
], - "customerReferenceNumber": "cust-ref-123",
- "ibxLocation": {
- "ibx": "AM1",
- "cages": [
- {
- "cage": "AM1:0G:00E",
- "cabinets": [
- "0101"
], - "accountNumber": "12345"
}
]
}, - "attachments": [
- {
- "id": "eb9ab7e9-3785-41e4-af24-74b8dc37b254",
- "name": "uecp-finance-service-api-swagger.yml"
}
], - "serviceDetails": {
- "additionalDetails": "Additional notes related to order",
- "schedule": {
- "startDateTime": "2017-04-05T10:00:00Z",
- "endDateTime": "2017-04-05T12:00:00Z"
}, - "visitors": [
- {
- "firstName": "John",
- "lastName": "Doe",
- "company": "Test Organization",
- "email": "abc@xyz.com",
- "mobilePhoneCountryCode": 1,
- "mobilePhone": "111-111-1112"
}, - {
- "userName": "testuser@test.com"
}
], - "openCabinet": "false",
- "supervisionRequired": "false"
}
}Response samples
- 201
- 400
- 403
- 500
{- "successes": [
- {
- "ibxLocation": {
- "ibx": "AM1",
- "cageDetails": [
- {
- "cage": "AM1:0G:00E",
- "accountNumber": "1111",
- "cabinets": [
- {
- "cabinet": "0501"
}
]
}
]
}, - "response": {
- "OrderNumber": "1-1111"
}
}
]
}