FacilityAccess-v1 1.0.0

ServiceRequests

1. Authenticate

Prerequisites

  1. You should have registered in our developer portal. Check this link about how to register an Account.
  2. You should request access to the playground, sandbox and production environment using our Support page. Here is the link to support page to request access to our environments.
  3. You should have an App created in your account to get the client id and client secret. Check this link about how to create an App.

Note : The time data attribute on APIs follows a 24-hour clock starting at 00:00 and ending at 23:59.

 

Authentication

The bearer token obtained after successful authentication should be passed as credential when calling this API for authentication. Check the Access Token API link for instructions on how to generate your bearer token.

 

 

Read the Get Started documentation if you are unaware of your client credentials.

 

2. Permissions

3. Get Information

Get Account Information

Master account Id and account Id need to be passed in the header for this API call. This is needed to indicate your legal entity.
Refer to the Accounts API for instructions on how to retrieve your account information. You may skip this step if you already know your master account Id and account Id.

 

Get Site Information

Retrieve the available facility information which are assigned to you. You need the site code to indicate to which facility you want to make a request.
Refer to the Sites API for instructions on how to retrieve your site information. You may skip this step if you already know your sites.

 

Get Location Information

Retrieve the available location information which are assigned to you. You need the location name to indicate to which location in the facility you want to make a request.
Refer to the Locations API for instructions on how to retrieve your location information. You may skip this step if you already know your locations.

4. Request New Permanent Badge

The method can be used to request a permanent badge for facility access. 

 Method POST
End point /v1/facility-access/perm-badges
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body firstName, lastName, email, phone, company, badgeStartDate, badgeExpirationDate, sites [{site, locations [{location, accessStartDate, accessEndDate}]}], emailNotifications

 

AccessStartTime : Specifies the start time of the access privilege.

AccessEndTime : Specifies the end time of the access privilege.

Time Format : HH:MM:SS

Time Zone: Local time at the data centre when the technician is supposed to report to work for the day

 

Sample Curl Request

curl --location --request POST 'https://api.digitalrealty.com/v1/facility-access/perm-badges' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"firstName": "John",
"lastName": "Doe",
"email": "john_doe@email.com",
"phone": "1234567890",
"company": "ABC Company",
"badgeStartDate": "2023-06-07",
"badgeExpirationDate": "2023-06-08",
"sites": [{
    "site": "IAD024",
    "locations": [{
        "location": "ABC Cage F150-B",
        "accessStartDate": "2023-06-07",
        "accessEndDate": "2023-06-08"
        }]
    }],
"emailNotifications": "jane_doe@email.com"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
firstName true string(20) First name of the requestor.
lastName true string(20) Last name of the requestor.
email true string(50) Email address of the requestor.
phone false string(40) Phone number of the requestor.
company false string(120) Company name of the requestor.
badgeStartDate true string($date)

Date of the badge activation.
format: [yyyy-MM-dd]

badgeStartDate >= current date
badgeExpirationDate false string($date)

Date of the badge expiration.
format: [yyyy-MM-dd]

badgeExpirationDate >= badgeStartDate
sites true array Array of site objects.
> site true string(6) The site of badge access privileges.
> locations true array Array of location objects.
> > location true string The location of badge access privileges.
> > accessStartDate true string($date)

Date specific access privileges start
format: [yyyy-MM-dd]

accessStartDate >= badgeStartDate but < badgeExpirationDate
> > accessEndDate false string($date)

Date specific access privileges end
format: [yyyy-MM-dd]

accessEndDate <=  badgeExpirationDate but >= badgeStartDate
emailNotifications false string(32k) Personnel's email addresses designated to be notified of the request. You can add one or more email addresses in the field by inserting a comma as a separator : "email_1, email_2, email_3"

 

Sample JSON Response

{
    "workOrder": [
        {
            "workOrderId": "WO8744051"
        }
    ]
}

 

Payload Description

Field Name Type Description
workOrder array Array of workOrderId objects
workOrderId string(20) Identifier of the facility access work order.

 

5. Retrieve Permanent Badge Ticket Information

Retrieve Permanent Badge List

This method can be used to retrieve all permanent badge requests of the customer’s account.

 Method GET
End point /v1/facility-access/perm-badges
Headers Authorization, Master-Account-Id, Account-Id
Query Parameters site, status, createdBy, size, page
Body n/a

 

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v1/facility-access/perm-badges' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.

 

Query Parameters

Field Name Mandatory Type Description
site false string(6) Filter by the DLR facility that handles the tickets.
status false string(enum)

Filter by state of the tickets.

Values: [Pending Approval, Approved, In Progress, Completed, Approval Denied, Cancelled]
createdBy false string(40) Filter by user who generated the work order.
size false integer The maximum number of search results to return.
Default value: 25
page false integer The page number of the returning search results.
Default value: 0

 

Body

n/a

Sample JSON Response

{
  "content": [
        {
            "id": "WO8744496",
            "title": "Request for Modify Permanent badge",
            "status": "Pending Approval",
            "site": "PHX015",
            "requestType": "Permanent Badge",
            "category": "Modify Badge",
            "isBulkRequest": false,
            "createdOn": "2023-06-07 14:05:19",
            "updatedOn": "2023-06-07 14:06:09",
            "closedOn": "",
            "createdBy": "portaluser test",
            "ticketType": "Facility Access",
            "description": "Request for Modify Permanent badge",
            "location": "COLO 8 ABC Cage 8.06"
        }
  ],
  "pageable": {
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "size": 25,
    "number": 0,
    "first": true,
    "numberOfElements": 1,
    "empty": false
  }
}

 

Payload Description

Field Name Type Description
id string(20) Identifier of the ticket.
title string(160) Label on the work order.
status string(enum)

Designates the stage of the ticket.

Pending Approval = ticket was submitted successfully but is pending approval before it is created in the downstream system(s). At this point in the process the ticket exists only on the Global Portal.
Approved= ticket was created but work on it has not started. Two use cases:
     Approved and created in the downstream systems.
        This includes tickets with a mix of approved/denied access to sites/locations
     No approval is needed = tickets are automatically created in the downstream systems.
In Progress = ticket has been assigned to a DLR resource and in the process of being addressed
Completed = all work on the ticket has been completed
Approval Denied = the entire ticket was not approved by a user with the proper permissions.
Cancelled = ticket was cancelled as it was not necessary (created by mistake, duplicate, etc).
site string(6) Identifier of the DLR facility.
requestType string(enum) Type of the facility access request.
value: [Permanent Badge]
category string(enum) Category of the facility access request.
value: [New Badge,Modify Badge,Terminate All Access]
isBulkRequest boolean Indication if for multiple visitors is use.
createdOn string(date-time) Date on which the work order was generated.
format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]
updatedOn string(date-time) Last date on which the work order details were modified.
format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]
closedOn string(date-time) Date on which the work order’s status was marked Completed.
format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]
createdBy string(40) Designates the user that initially generated the work order.
ticketType string(enum) Type of the ticket.
value: [Facility Access]
description string Short description of work order.
location string Identifier of customer premise within DLR facility.

Retrieve Permanent Badge Details

The method can be used to retrieve details of a facility access request.

 Method GET
End point /v1/facility-access/access-tickets/{ticketId}
Headers Authorization, Master-Account-Id, Account-Id
Query Parameters n/a
Body n/a

 

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v1/facility-access/access-tickets/<ticketId>' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.

 

Query Parameters

n/a

Body

n/a

Sample JSON Response

{
    "ticketId": "WO9284318",
    "ticketType": "Security",
    "ticketStatus": "In Progress",
    "requester": "Random User",
    "ticketCreatedDate": "2023-06-08 08:38:07",
    "ticketUpdatedDate": "2023-06-08 08:40:09",
    "requestType": "Permanent Badge",
    "ticketCategory": "New Badge",
    "contactFirstName": "John",
    "contactLastName": "Doe",
    "contactEmail": "john_doe@email.com",
    "contactPhone": "1234567890",
    "representingCompany": "ABC Company",
    "badgeStartDate": "2023-06-07",
    "badgeEndDate": "2023-06-08",
    "site": [
        {
            "site": "IAD024",
            "locations": [
                {
                    "location": "ABC Cage F150-B"
                }
            ],
            "address": "43830 Devin Shafron Drive (Bldg F)"
        }
    ],
    "modifiedBy": "system",
    "emailNotifications": "jane_doe@email.com",
    "visitorType": "Unescorted visitor",
    "visitorBadgeType": "Permanent Badge Request",
    "visitorHostFirstName": "",
    "visitorHostLastName": "",
    "hostCompany": "ABC Corporation",
    "notes": "",
    "contactType": "Request for New Permanent badge",
    "escortFirstName": "",
    "escortLastName": "",
    "visitorBadgeStartDate": "2023-06-07",
    "visitorBadgeEndDate": "2023-06-08",
    "customerExternalReference": "",
    "workDescription": "",
    "description": "Request for New Permanent badge",
    "bulkRequest": false
}

 

Payload Description

Field Name Type Description
ticketId string(20) Identifier of the ticket.
ticketType string(enum)

The type of the ticket.

Value: [Facility Access]
ticketStatus string(enum)

Designates the stage of the ticket.
Pending Approval = ticket was submitted successfully but is pending approval before it is created in the downstream system(s). At this point in the process the ticket exists only on the Global Portal..
Approved = ticket was created but work on it has not started. Two use cases:

  • Approved and created in the downstream systems. This includes tickets with a mix of approved/denied access to sites/locations.
  • No approval is needed; tickets are automatically created in the downstream systems.

In Progress = ticket has been assigned to a DLR resource and in the process of being addressed.
Completed = all work on the ticket has been completed.
Approval Denied = the entire ticket was not approved by a user with the proper permissions.
Cancelled = ticket was cancelled as it was not necessary (created by mistake, duplicate, etc)
requester string(40) Designates the user that initially generated the work order.
ticketCreatedDate string(date-time) Date on which the work order was generated.
format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]
ticketUpdatedDate string(date-time) Last date on which the work order details were modified.
format: [yyyy-MM-dd HH:mm:ss] timezone: [UTC]
requestType string(enum)

Type of the facility access request.

Value: [Permanent Badge]
ticketCategory string(enum)

Category of the facility access request.

Value: [New Badge,Modify Badge,Terminate All Access]
contactFirstName string(20) First name of the contact.
contactLastName string(20) Last name of the contact.
contactEmail string(50) Contact’s email address.
contactPhone string(40) Contact’s phone number.
representingCompany string(120) Company representing.
badgeStartDate string($date) Date of the badge activation.
format: [yyyy-MM-dd]
badgeEndDate string($date) Date of the badge expiration.
format: [yyyy-MM-dd]
site array Array of site objects.
> site string Site work will be performed.
> locations array Array of location objects.
>> location string Space within the facility where access needed (suite, cage, etc.)
> address string Site Address.
modifiedBy string(40) Designates the user that modified the work order.
emailNotifications string(32k) Personnel's email addresses designated to be notified of the request. You can add one or more email addresses in the field by inserting a comma as a separator : "email_1, email_2, email_3".
visitorType string(enum) Indicates if visitors access is escorted.
Values: [true = Escorted visitor, false = Unescorted visitor]
Default Value for visitorType = true.
visitorBadgeType string(enum) The Type of visitor badge.
Values: [Visitor Access (Escorted),Visitor Access (Extended),Visitor Access (Unescorted)]
visitorHostFirstName string(20) First name of host.
visitorHostLastName string(20) Last name of host.
hostCompany string(120) Company hosting the visitor.
notes string(32k) Add additional information needed.
contactType string Short description of the visit.
escortFirstName string(20) First name of person escorting visitor.
escortLastName string(20) Last name of person escorting visitor.
visitorBadgeStartDate string($date) Date the visitor access will begin.
format: [yyyy-MM-dd]   
visitorBadgeStartDate >= current date but not > 90 days in the future
visitorBadgeEndDate string($date) Date the visitor access will end.
format: [yyyy-MM-dd]
visitorBadgeEndDate >= visitorBadgeStartDate but not greater than 365 days from visitorBadgeStartDate
customerExternalReference string(40) Customer external reference number.
workDescription string(32k) The Description of the work.
description string Short description of work order.
bulkRequest boolean Indicates if this is a request for more than four visitors.

6. Modify Permanent Badge

Modify Badge endpoint should be called to Add/Remove access, Update the badge holder information when a Permanent Badge already exists

The method can be used to modify a permanent badge. 

 Method PUT
End point /v1/facility-access/perm-badges/modify
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body firstName, lastName,phone, email, company, badgeStartDate, badgeExpirationDate, addSites [{site, locations [{location}]}], emailNotifications

 

The following fields are editable BASED on the (Ticket Status)

Field Name Mandatory Status
firstName true All Statuses except Approval Denied, Completed, or Cancelled
lastName true All Statuses except Approval Denied, Completed, or Cancelled
phone false All Statuses except Approval Denied, Completed, or Cancelled
email true All Statuses except Approval Denied, Completed, or Cancelled
company true All Statuses except Approval Denied, Completed, or Cancelled
badgeStartDate true All Statuses except Approval Denied, Completed, or Cancelled
badgeExpirationDate false All Statuses except Approval Denied, Completed, or Cancelled
addSites true All Statuses except Approval Denied, Completed, or Cancelled
>site true All Statuses except Approval Denied, Completed, or Cancelled
>locations true All Statuses except Approval Denied, Completed, or Cancelled
>>location true All Statuses except Approval Denied, Completed, or Cancelled
emailNotifications false All statuses except Approval Denied, Completed, or Cancelled

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/perm-badges/modify' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+918898805959",
    "email": "john_doe6@email.com",
    "company": "ABC Company",
    "badgeStartDate": "2023-06-07",
    "badgeExpirationDate": "2023-06-10",
    "addSites": [
        {
            "site": "IAD024",
            "locations": [
                {
                    "location": "ABC Cage F150-B"

                }
            ]
        }
    ],
    "emailNotifications": "jane_doe23456@email.com",

}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
firstName true string(20) First name of the requestor.
lastName true string(20) Last name of the requestor.
phone false string(40) Phone number of the requestor.
email true string(50) Email address of the requestor.
company true string(120) Company name of the requestor.
badgeStartDate true string($date)

Date of the badge activation.
format: [yyyy-MM-dd]

badgeStartDate >= current date 
badgeExpirationDate false string($date)

Date of the badge expiration.
format: [yyyy-MM-dd]

badgeExpirationDate >= badgeStartDate 
addSites true array Array of site objects.
> site true string(6) The site of badge access privileges.
> locations true array Array of location objects.
> > location true string The location of badge access privileges.
emailNotifications false string(32k) Personnel's email addresses designated to be notified of the request. You can add one or more email addresses in the field by inserting a comma as a separator : "email_1, email_2, email_3".

 

 

 

Sample JSON Response

{
    "workOrder": [
        {
            "workOrderId": "WO8744051"
        }
    ]
}

 

Payload Description

Field Name Type Description
workOrder array Array of workOrderId objects
workOrderId string(20) Identifier of the facility access work order.

7. Edit New Permanent Badge Work Order

The method can be used to edit a New Permanent Badge Work Order.

 Method PUT
End point /v1/facility-access/access-tickets/{workOrderId}
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body visitorPhone,emailNotifications

 

The following fields are editable BASED on the (Ticket Status)

Field Name Status
firstName Only while the ticket is in Pending Approval or Approved status
lastName All Statuses
email Only while the ticket is in Pending Approval or Approved status
phone All Statuses
company Only while the ticket is in Pending Approval or Approved status
badgeStartDate Only while the ticket is in Pending Approval or Approved status
badgeExpirationDate Only while the ticket is in Pending Approval or Approved status
emailNotifications All statuses except for Approval Denied, Completed or Cancelled
attachments All statuses except for Approval Denied, Completed or Cancelled

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/access-tickets/<workOrderId>' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john_doe6@email.com",
    "phone": "+918898805959",
    "company": "ABC Company",
    "badgeStartDate": "2023-06-07",
    "badgeExpirationDate": "2023-06-10",
    "emailNotifications": "jane_doe23456@email.com",
    "attachments": "test.pdf"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
firstName true string(20) First name of the requestor.
lastName true string(20) Last name of the requestor.
email true string(50) Email address of the requestor.
phone false string(40) Phone number of the requestor.
company false string(120) Company name of the requestor.
badgeStartDate true string($date)

Date of the badge activation.
format: [yyyy-MM-dd]

badgeStartDate >= current date
badgeExpirationDate false string($date)

Date of the badge expiration.
format: [yyyy-MM-dd]

badgeExpirationDate >= badgeStartDate 
emailNotifications false string(32k) Personnel's email addresses designated to be notified of the request. You can add one or more email addresses in the field by inserting a comma as a separator : "email_1, email_2, email_3".
attachments false string($binary) The file to be attached.

 

Sample JSON Response

{
    "workOrderId": "WO8741409"
}

 

Payload Description

Field Name Type Description
workOrderId string(20) Identifier of the facility access work order.

8. Edit Modify Permanent Badge Work Order

'The method can be used to edit a Modify Permanent Badge Work Order

 Method PUT
End point /v1/facility-access/access-tickets/{workOrderId}
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body visitorPhone,emailNotifications

 

The following fields are editable BASED on the (Ticket Status)

Field Name Status
visitorPhone All statuses except Approval Denied, Completed, or Cancelled
emailNotifications All statuses except Approval Denied, Completed, or Cancelled

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/access-tickets/<workOrderId>' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "visitorPhone":"+918898805959",
    "emailNotifications": "test2@email.com,jane_doe@email.com"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
visitorPhone false string(40) Phone number of the requestor.
emailNotifications false string(32k) Personnel's email addresses designated to be notified of the request. You can add one or more email addresses in the field by inserting a comma as a separator : "email_1, email_2, email_3".

 

Sample JSON Response

{
    "workOrderId": "WO1234567"
}

 

Payload Description

Field Name Type Description
workOrderId string(20) Identifier of the facility access work order.

9. Edit Terminate Permanent Badge Work Order

The method can be used to Edit a Terminate Permanent Badge Work Order.

 Method PUT
End point /v1/facility-access/access-tickets/{workOrderId}
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body visitorPhone,emailNotifications

 

The following fields are editable BASED on the (Ticket Status)

Field Name Status
badgeExpirationDate Only while the ticket is in Pending Approval Status

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/access-tickets/<workOrderId>' \
--header 'Master-Account-Id: < Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "badgeExpirationDate":"2023-06-10"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
badgeExpirationDate true string($date)

Date of the badge expiration.
format: [yyyy-MM-dd]

badgeExpirationDate >= badgeStartDate

 

Sample JSON Response

{
    "workOrderId": "WO1234567"
}

 

Payload Description

Field Name Type Description
workOrderId string(20) Identifier of the facility access work order.

10. Cancel Permanent Badge Ticket

The method can be used to cancel a facility access request while the ticket status is still "New" or "In Progress". 

 Method PUT
End point /v1/facility-access/access-tickets/{workOrderId}/cancel
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body cancelReason

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/access-tickets/<workOrderId>/cancel' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cancelReason": "Request no longer needed"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.

value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
cancelReason false string(enum) Reason of the cancellation.

values: [Duplicate request, Request entered in error, Request no longer needed]

default: [Request no longer needed]

 

Sample JSON Response

{
  "result": {
    "status": "Work Order WO8741481 has been cancelled."
  }
}

 

Payload Description

Field Name Type Description
status string(255) Acknowledgement message of the cancellation.

11. Terminate Permanent Badge

The method can be used to terminate a permanent badge for facility access. 

 Method PUT
End point /v1/facility-access/perm-badges/terminate
Headers Authorization, Master-Account-Id, Account-Id, Content-Type
Query Parameters n/a
Body firstName, lastName, email, company, badgeExpirationDate

 

Sample Curl Request

curl --location --request PUT 'https://api.digitalrealty.com/v1/facility-access/perm-badges/terminate' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john_doe@email.com",
    "company": "ABC Company",
    "badgeExpirationDate": "2023-10-03"
}'

 

Headers

Field Name Mandatory Type Description
Master-Account-Id true string Customer master account identifier.
Account-Id true string Customer account identifier.
Authorization true string Token-based authentication.
Content-Type true string Indicates the request body format.
value: [application/json]

 

Query Parameters

n/a

Body

Field Name Mandatory Type Description
firstName true string(20) First name of the requestor.
lastName true string(20) Last name of the requestor.
email true string(50) Email address of the requestor.
company true string(120) Company name of the requestor.
badgeExpirationDate true string($date)

Date of the badge expiration.
format: [yyyy-MM-dd].

badgeExpirationDate >= badgeStartDate but not greater than 365 days from badgeStartDate

 

Sample JSON Response

{
    "workOrder": [
        {
            "workOrderId": "WO8744051"
        }
    ]
}

 

Payload Description

Field Name Type Description
workOrder array Array of workOrderId objects
workOrderId string(20) Identifier of the facility access work order.

12. Add a Comment or Attachment

Add Comments

Add comments to an existing work order. Multiple comments can be added to a work order as long as the status of the order is not closed or cancelled. Refer to the Comments API instructions on how to add comments. You may skip this step if you already know how to add comments.

 

Add Attachments

Add attachments to an existing work order. Multiple attachments can be added to a work order as long as the status of the order is not closed or cancelled. Refer to the Attachments API for instructions on how to add attachments. You may skip this step if you already know how to add attachments.

Response Codes


Please check the Response Codes overview in case of any issues.


Need Help?

Have not found what you are looking for, please do not hesitate to reach out to us!

FAQs
Contact Us
globe