workvisit-v1

title: "DEPRECATION: WorkVisit (V1)"

 

Deprecation of Work Visit v1 API

Equinix will be deprecating Work Visit v1 API by 1st May 2023.
Therefore, we strongly recommend users migrate to Work Visit v2 API and Lookup v2 (location search) API before this date.
We will end support for workvisit_v1 API on 1 Dec 2022.
For information on the API v2, see the Workvisit v2 and Lookup v2 documentation.

If you have any questions, contact Equinix API support at api-support@equinix.com.

WorkVisit (V1) API allows a user with Work Visit permission to get the permitted Work Visit location information and schedule Work Visits.

To schedule a work visit, refer to Schedule work visit (V1) in the Getting Started.

 

To view an enhanced version of this API, refer to Lookup (V2) and WorkVisits (V2) in the API Reference section.

GET Workvisit Locations

	GET /workvisit/locations
Method	GET
URL or End Point	/v1/orders/workvisit/locations
Headers	Authorization, Content-Type
Query Parameters	detail, ibxs, cages
Body	Not applicable

The Get workvisit locations API returns all IBXs and related cages where the user has Work Visit 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.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The response returns all the cabinets that the user may order work visits for in the cage, AM1:0G:00EQ11, located in IBX, AM1.

curl -X
GET "https://api.equinix.com/v1/orders/workvisit/locations"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query parameter name	Mandatory	Type	Example	Applicable Values	Description
detail	No	boolean	true	true, false	Defines if the information returned is detailed. If 'true', IBX location code and detailed cage and cabinet information would be returned. If 'false', the only information returned would be IBX location code. Default value : false.
ibxs	No	string	AM1		The IBXs that the user has access to. These are represented by the IBX location codes. E.g. AM1 represents an IBX in Amsterdam, Netherlands. By specifying single or multiple IBX location codes (ex: AM1 or AM1, AM2, AM3), the constraint is placed on specific IBXs. Default value : all IBXs where the user has this permission
cages	No	string	AM1:0G:00EQ11		ID of cage that the user has access to.  By specifying single or multiple cage IDs (ex: AM1:0G:00EQ11 or AM1:0G:00EQ11, AM1:0G:00EQ11-1), the constraint is placed on specific cages. Default value : all cages where the user has this permission

{
  "locations": [
    {
      "ibx": "AM1",
      "cages": [
        {
          "cage": "AM1:0G:00EQ11",
          "cageTypes": [
            "Shared"
          ],
          "accounts": [
            {
              "number": "108812",
              "name": "John Smith, Inc.",
              "poTracking": false,
              "pricingEnabled": false,
              "pricingEnforced": false,
              "cabinets": [
                {
                  "cabinet": "AM1:0G:00EQ11:0501",
                  "cabinetReference": "ls99at5",
                  "cabinetType": "Cabinet"
                }
              ],
              "isCreditHold": false,
              "isPOBearing": true,
              "isMonetAccount": false
            }
          ]
        }
      ],
      "accessRestricted": true,
      "specialPrivilege": false
    }
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
locations	array [objects]		The IBX locations that the user has access to.
ibx	string	AM1	The IBX location code.
cages	array [objects]		Information of the cages that the user has access to.
cage	string	AM1:0G:00EQ11	ID of the cage that the user has access to.
cageTypes	string	Shared	Type of cage. Cage type - Description Shared - Indicates that the cage is shared by more than one customer, so provision of ID of cabinet(s) is mandatory. Private - Indicates that the cage is privately held by one customer, so provision of ID of cabinet(s) is optional. IBXflex - there are no cabinets.
accounts	array [objects]		Accounts information of the cage that consists of cage account number, cage account name, purchase order tracking status, pricing enabled status, cabinets information, credit status of account, PO number requirement from account, and MonetAccount classification.
number	string	108812	The customer account number linked to the cage.
name	string	John Smith, Inc.	The customer account name linked to the cage.
poTracking	boolean	false	Indicates if purchase order tracking is required for the customer account. You may ignore this.
pricingEnabled	boolean	false	Indicates if the pricing needs to be provided at the time of ordering for this customer account. You may ignore this.
pricingEnforced	boolean	false	Indicates if the pricing disclaimer needs to be displayed before an order is submitted for this customer account. You may ignore this.
cabinets	array [objects]		Cabinet information that consists of cabinet ID and cabinet type.
cabinet	string	AM1:0G:00EQ11:0501	ID of the cabinet that the user has access to.
cabinetReference	string	ls99at5	Customer's cabinet reference number.
cabinetType	string	Cabinet	Type of cabinet. Cabinet type - Description Cabinet - Cabinet that is not a demarcation point for a cross connection. Demarcation point - Cabinet that is a demarcation point for a cross connection.
isCreditHold	boolean	false	Credit status of the customer account. If 'true', customer account is unable to place billable orders. If 'false', customer account is free to make orders. Customers can schedule work visits regardless of credit status.
isPOBearing	boolean	true	Purchase order bearing status of customer account. If 'true', it is mandatory to include the purchase order number when placing billable orders. If 'false', purchase order number is not required. Purchase order information is not required when ordering work visits. You may ignore this.
isMonetAccount	boolean	false	Indicates that this account has cages that require submarine engineering support. If 'true', the field "needSupportFromASubmarineCableStationEngineer" must be provided when placing orders. If 'false', no additional field is required when placing orders.
accessRestricted	boolean	true	This field was added in response to the COVID-19 situation. Unless otherwise stated, you may ignore this. Indicates if this IBX access is restricted. If 'true', access is restricted and a Work Visit Request Form must be included when placing a work visit order. If 'false', there is no restriction and a Work Visit Request Form is not required when placing a work visit order.
specialPrivilege	boolean	false	Indicates if this IBX requires special privilege. You may ignore this.

 

If you get “Insufficient permissions” error, contact your Master Administrator.