Skip to main content

Schedule Work Visit
deprecated

Request

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.

Headers
Authorizationstringrequired

Specify the Access token with prefix 'Bearer'.

Bodyapplication/json
contactsArray of objects, >= 2 items(Contact Info)required

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.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.

Example:
[ { "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" } ]
customerReferenceNumberstring, [ 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.

Example:"cust-ref-123"
ibxLocationobject(IBX Location)required
attachmentsArray of objects, <= 5 items(Attachment)

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API

serviceDetailsobject(Service Detail)required
Payload
{ "contacts": [ { … }, { … }, { … } ], "customerReferenceNumber": "cust-ref-123", "ibxLocation": { "ibx": "AM1", "cages": [ … ] }, "attachments": [ { … } ], "serviceDetails": { "additionalDetails": "Additional notes related to order", "schedule": { … }, "visitors": [ … ], "openCabinet": "false", "supervisionRequired": "false" } }

Responses

Order Created

Bodyapplication/json
successesArray of objects
Response
{ "successes": [ { … } ] }
Was this page helpful?