Difference between revisions of "Exchange Resource Mailbox (Rest API)"

From Rackspace Email & Apps API
Jump to: navigation, search
(Updated import documentation)
 
(2 intermediate revisions by the same user not shown)
Line 82: Line 82:
  
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
−
* Calendar Processing [[#Read_2|Read]] [[#Update_2|Update]]
+
* Calendar Processing [[#Read_2|Read]]
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 147: Line 147:
  
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
−
* Delegate [[#List_2|List]] [[#Bulk_Update|Bulk Update]]
+
* Delegate [[#List_2|List]]
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 168: Line 168:
  
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
−
* Permission [[#List_3|List]] [[#Bulk_Update_2|Bulk Update]]
+
* Permission [[#List_3|List]]
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 201: Line 201:
  
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
 
* Exchange Resource [[#Create|Create]], [[#Update|Update]]
−
* Policy [[#List_4|List]] [[#Bulk_Update_3|Bulk Update]]
+
* Policy [[#List_4|List]]
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 881: Line 881:
 
</pre>
 
</pre>
  
−
===== Update =====
+
==== Delegates ====
−
Although Calendar Processing settings can be updated as part of the base Exchange Resource update, a convenience route is also available for just sending just the Calendar Processing part of the request.
+
 
 +
===== List =====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Verb
 
! Verb
−
| PUT
+
| GET
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/calendarProcessing
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/delegates
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to update an existing resource mailbox's calendar processing data.
+
| Use this route to list an existing resource mailbox's delegates data. (see [[Common Exchange API Concepts#Listings|Listings]])
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Calendar_Processing|Calendar Processing]]
+
| [[#Delegates|Delegates]] Listing
 +
|}
 +
 
 +
HTTP Codes
 +
 
 +
{| class="wikitable"
 +
! Code
 +
! Condition
 +
|-
 +
| 200 OK
 +
| The data was successfully retrieved.
 +
|-
 +
| 404 Not Found
 +
| The domain does not exist, the domain does not have Exchange, or the resource was not found.  Inspect the <tt>itemNotFondFault</tt> for more detail.
 
|}
 
|}
  
 
<pre>
 
<pre>
 
Request:
 
Request:
−
PUT https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/calendarProcessing
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/delegates
−
{
+
 
−
  "AutoBooking": "AutoUpdate",
+
Response:
−
  "BookingWindowInDays": 180,
+
200 OK
−
  "EnforceSchedulingHorizon": true,
+
{
−
  "AllowConflicts": false,
+
  "Delegates": [
−
  "AllowRecurringMeetings": true,
+
    {
−
  "ScheduleOnlyDuringWorkHours": false,
+
      "Value": "user1"
−
  "MaximumDurationInMinutes": 1440,
+
    },
−
  "MaximumConflictInstances": 0,
+
    {
−
  "ConflictPercentageAllowed": 0,
+
      "Value": "user2"
−
  "AdditionalResponse": {
+
    },
−
    "Enable": false
+
    {
−
  }
+
      "Value": "user3"
 +
    }
 +
  ],
 +
  "Limit": 50,
 +
  "Total": 3,
 +
  "Order": "asc"
 
}
 
}
−
 
−
 
−
Response:
 
−
204 No Content
 
 
</pre>
 
</pre>
  
−
==== Delegates ====
+
==== Permissions ====
  
 
===== List =====
 
===== List =====
Line 930: Line 945:
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/delegates
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/permissions
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to list an existing resource mailbox's delegates data. (see [[Common Exchange API Concepts#Listings|Listings]])
+
| Use this route to list an existing resource mailbox's permissions data. (see [[Common Exchange API Concepts#Listings|Listings]])
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Delegates|Delegates]] Listing
+
| [[#Permission|Permission]] Listing
 
|}
 
|}
  
Line 954: Line 969:
 
<pre>
 
<pre>
 
Request:
 
Request:
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/delegates
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/permissions
 +
 
  
 
Response:
 
Response:
 
200 OK
 
200 OK
 
{
 
{
−
  "Delegates": [
+
  "Permissions": [
 
    {
 
    {
−
      "Value": "user1"
+
      "Recipient": "user5",
 +
      "Types": [
 +
        "FullAccess"
 +
      ]
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user2"
+
      "Recipient": "user6",
 +
      "Types": [
 +
        "SendAs"
 +
      ]
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user3"
+
      "Recipient": "user7",
−
    }
+
      "Types": [
 +
        "FullAccess",
 +
        "SendAs"
 +
      ]
 +
    }
 
  ],
 
  ],
 
  "Limit": 50,
 
  "Limit": 50,
Line 976: Line 1,002:
 
</pre>
 
</pre>
  
−
===== Bulk Update =====
+
==== Policies ====
  
−
Although Delegates settings can be updated as part of the base Exchange Resource update, a convenience route is also available for just sending the just the Delegates part of the request.
+
BookIn, RequestIn, and RequestOutOf policies can all be accessed via the resource's URL followed by <tt>/bookInPolicy</tt>, <tt>/requestInPolicy</tt>, and <tt>/requestOutOfPolicy</tt>, respectively.  Examples in this section will use BookInPolicy, but the interface for the three is all the same.
 +
 
 +
===== List =====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Verb
 
! Verb
−
| Put
+
| GET
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/delegates
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/bookInPolicy
 +
 
 +
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestInPolicy
 +
 
 +
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestOutOfPolicy
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to update an existing resource mailbox's delegates data.
+
| Use this route to list an existing resource mailbox's policies data. (see [[Common Exchange API Concepts#Listings|Listings]])
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Delegate|Delegate]] Array
+
| [[#Recipient|Recipient]] Listing
 
|}
 
|}
  
Line 1,002: Line 1,034:
 
| 200 OK
 
| 200 OK
 
| The data was successfully retrieved.
 
| The data was successfully retrieved.
−
|-
 
−
| 400 Bad Request
 
−
| The request was invalid.  Inspect the <tt>validationFault</tt> response for more detail.
 
 
|-
 
|-
 
| 404 Not Found
 
| 404 Not Found
Line 1,012: Line 1,041:
 
<pre>
 
<pre>
 
Request:
 
Request:
−
PUT https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/delegates
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/bookInPolicy
−
[
+
 
 +
 
 +
Response:
 +
{
 +
  "Recipients": [
 
    {
 
    {
−
      "Value": "user1",
+
      "Value": "user1"
−
      "Action": "Remove"
 
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user2",
+
      "Value": "user2"
−
      "Action": "Remove"
 
−
    },
 
−
    {
 
−
      "Value": "user5",
 
−
      "Action": "Add"
 
 
    }
 
    }
−
]
+
  ],
−
 
+
  "AllUsers":false,
−
 
+
  "Limit": 50,
−
Response:
+
  "Total": 2,
−
204 No Content
+
  "Order": "asc"
 +
}
 
</pre>
 
</pre>
  
−
==== Permissions ====
+
=== New Resource Options ===
 +
<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/resourceOptions/</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource add operation.
  
−
===== List =====
+
==== Available Delegates Recipients ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,042: Line 1,071:
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/permissions
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailableDelegatesRecipients
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to list an existing resource mailbox's permissions data. (see [[Common Exchange API Concepts#Listings|Listings]])
+
| Use this route to list recipients that can be delegates for a new resource on a given domain.
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Permission|Permission]] Listing
+
| [[#Recipient|Recipient]] Listing
−
|}
 
−
 
 
−
HTTP Codes
 
−
 
 
−
{| class="wikitable"
 
−
! Code
 
−
! Condition
 
−
|-
 
−
| 200 OK
 
−
| The data was successfully retrieved.
 
−
|-
 
−
| 404 Not Found
 
−
| The domain does not exist, the domain does not have Exchange, or the resource was not found.  Inspect the <tt>itemNotFondFault</tt> for more detail.
 
 
|}
 
|}
  
 
<pre>
 
<pre>
 
Request:
 
Request:
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/permissions
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailableDelegatesRecipients
  
  
Line 1,072: Line 1,088:
 
200 OK
 
200 OK
 
{
 
{
−
  "Permissions": [
+
  "Recipients": [
 
    {
 
    {
−
      "Recipient": "user5",
+
      "Value": "user1"
−
      "Types": [
 
−
        "FullAccess"
 
−
      ]
 
 
    },
 
    },
 
    {
 
    {
−
      "Recipient": "user6",
+
      "Value": "user10"
−
      "Types": [
+
    },
−
        "SendAs"
+
    {
−
      ]
+
      "Value": "user2"
 +
    },
 +
    {
 +
      "Value": "user3"
 +
    },
 +
    {
 +
      "Value": "user4"
 +
    },
 +
    {
 +
      "Value": "user5"
 
    },
 
    },
 
    {
 
    {
−
      "Recipient": "user7",
+
      "Value": "user6"
−
      "Types": [
+
    },
−
        "FullAccess",
+
    {
−
        "SendAs"
+
      "Value": "user7"
−
      ]
+
    },
−
    }
+
    {
−
  ],
+
      "Value": "user8"
−
  "Limit": 50,
+
    },
−
  "Total": 3,
+
    {
−
  "Order": "asc"
+
      "Value": "user9"
 +
    }
 +
  ],
 +
  "Limit": 50,
 +
  "Total": 10,
 +
  "Order": "asc"
 
}
 
}
 
</pre>
 
</pre>
  
−
===== Bulk Update =====
+
==== Available Permissions Recipients ====
−
 
 
−
Although Permissions settings can be updated as part of the base Exchange Resource update, a convenience route is also available for just sending the just the Permissions part of the request.
 
−
Note: to remove a recipient from the permissions list, set the permission type array to an empty array.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Verb
 
! Verb
−
| Put
+
| GET
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/calendarProcessing
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailablePermissionsRecipients
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to read an existing resource mailbox's calendar processing data.
+
| Use this route to list recipients that can have permissions for a new resource on a given domain.
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Permission|Permission]] Array
+
| [[#Recipient|Recipient]] Listing
 
|}
 
|}
  
−
HTTP Codes
+
<pre>
 +
Request:
 +
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailablePermissionsRecipients
  
−
{| class="wikitable"
+
Response:
−
! Code
+
{
−
! Condition
+
  "Recipients": [
−
|-
+
    {
−
| 200 OK
+
      "Value": "user1"
−
| The data was successfully retrieved.
+
    },
−
|-
+
    {
−
| 400 Bad Request
+
      "Value": "user10"
−
| The request was invalid.  Inspect the <tt>validationFault</tt> response for more detail.
+
    },
−
|-
+
    {
−
| 404 Not Found
+
      "Value": "user2"
−
| The domain does not exist, the domain does not have Exchange, or the resource was not found.  Inspect the <tt>itemNotFondFault</tt> for more detail.
+
    },
−
|}
+
    {
 +
      "Value": "user3"
 +
    },
 +
    {
 +
      "Value": "user4"
 +
    },
 +
    {
 +
      "Value": "user5"
 +
    },
 +
    {
 +
      "Value": "user6"
 +
    },
 +
    {
 +
      "Value": "user7"
 +
    },
 +
    {
 +
      "Value": "user8"
 +
    },
 +
    {
 +
      "Value": "user9"
 +
    }
 +
  ],
 +
  "Limit": 50,
 +
  "Total": 10,
 +
  "Order": "asc"
 +
}
 +
</pre>
  
 +
==== Available Policy Recipients ====
  
−
<pre>
+
Available BookIn, RequestIn, and RequestOutOf policy recipients can all be accessed via the resourceOptions URL followed by <tt>/availableBookInPolicyRecipients</tt>, <tt>/availableRequestInPolicyRecipients</tt>, and <tt>/availableRequestOutOfRecipients</tt>, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.
−
Request:
 
−
PUT https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/permissions
 
−
[
 
−
  {
 
−
    "Recipient": "user5",
 
−
    "Types": [
 
−
      "FullAccess",
 
−
      "SendAs"
 
−
    ]
 
−
  },
 
−
  {
 
−
    "Recipient": "user7",
 
−
    "Types": []
 
−
  },
 
−
  {
 
−
    "Recipient": "user8",
 
−
    "Types": [
 
−
      "FullAccess"
 
−
    ]
 
−
  }
 
−
]
 
−
 
 
−
Response:
 
−
204 No Content
 
−
</pre>
 
−
 
 
−
==== Policies ====
 
−
 
 
−
BookIn, RequestIn, and RequestOutOf policies can all be accessed via the resource's URL followed by <tt>/bookInPolicy</tt>, <tt>/requestInPolicy</tt>, and <tt>/requestOutOfPolicy</tt>, respectively. Examples in this section will use BookInPolicy, but the interface for the three is all the same.
 
−
 
 
−
===== List =====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,173: Line 1,195:
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/bookInPolicy
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableBookInPolicyRecipients
  
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestInPolicy
+
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestInPolicyRecipients
  
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestOutOfPolicy
+
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestOutOfRecipients
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to list an existing resource mailbox's policies data. (see [[Common Exchange API Concepts#Listings|Listings]])
+
| Use this route to list recipients that can be in policies for a new resource on a given domain.
 
|-
 
|-
 
! Model
 
! Model
Line 1,186: Line 1,208:
 
|}
 
|}
  
−
HTTP Codes
 
−
 
−
{| class="wikitable"
 
−
! Code
 
−
! Condition
 
−
|-
 
−
| 200 OK
 
−
| The data was successfully retrieved.
 
−
|-
 
−
| 404 Not Found
 
−
| The domain does not exist, the domain does not have Exchange, or the resource was not found.  Inspect the <tt>itemNotFondFault</tt> for more detail.
 
−
|}
 
  
 
<pre>
 
<pre>
 
Request:
 
Request:
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/bookInPolicy
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/availableBookInPolicyRecipients
−
 
 
  
 
Response:
 
Response:
 +
200 OK
 
{
 
{
 
  "Recipients": [
 
  "Recipients": [
 
    {
 
    {
 
      "Value": "user1"
 
      "Value": "user1"
 +
    },
 +
    {
 +
      "Value": "user10"
 
    },
 
    },
 
    {
 
    {
 
      "Value": "user2"
 
      "Value": "user2"
−
    }
+
    },
−
  ],
+
    {
−
  "AllUsers":false,
+
      "Value": "user3"
 +
    },
 +
    {
 +
      "Value": "user4"
 +
    },
 +
    {
 +
      "Value": "user5"
 +
    },
 +
    {
 +
      "Value": "user6"
 +
    },
 +
    {
 +
      "Value": "user7"
 +
    },
 +
    {
 +
      "Value": "user8"
 +
    },
 +
    {
 +
      "Value": "user9"
 +
    }
 +
  ],
 
  "Limit": 50,
 
  "Limit": 50,
−
  "Total": 2,
+
  "Total": 10,
 
  "Order": "asc"
 
  "Order": "asc"
 
}
 
}
 
</pre>
 
</pre>
  
−
===== Bulk Update =====
+
=== Existing Resource Options ===
 +
 
 +
<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/resource/(common name)/options</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource edit operation.
  
−
Although policies settings can be updated as part of the base Exchange Resource update, a convenience route is also available for just sending the just the policies part of the request.
+
==== Available Delegates Recipients ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Verb
 
! Verb
−
| PUT
+
| GET
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/bookInPolicy
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/AvailableDelegatesRecipients
−
 
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestInPolicy
 
−
 
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestOutOfPolicy
 
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to update an existing resource mailbox's policies data.
+
| Use this route to list recipients that can be delegates for an existing resource
 
|-
 
|-
 
! Model
 
! Model
−
| [[#Recipients|Recipients]]
+
| [[#Recipient|Recipient]] Listing
−
|}
 
−
 
 
−
HTTP Codes
 
−
 
 
−
{| class="wikitable"
 
−
! Code
 
−
! Condition
 
−
|-
 
−
| 200 OK
 
−
| The data was successfully retrieved.
 
−
|-
 
−
| 400 Bad Request
 
−
| The request was invalid.  Inspect the <tt>validationFault</tt> response for more detail.
 
−
|-
 
−
| 404 Not Found
 
−
| The domain does not exist, the domain does not have Exchange, or the resource was not found.  Inspect the <tt>itemNotFondFault</tt> for more detail.
 
 
|}
 
|}
  
 
<pre>
 
<pre>
 
Request:
 
Request:
−
PUT https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/bookInPolicy
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailableDelegatesRecipients
 +
 
 +
Response:
 +
200 OK
 
{
 
{
−
  "Recipients": [
+
  "Recipients": [
 +
    {
 +
      "Value": "user10"
 +
    },
 +
    {
 +
      "Value": "user4"
 +
    },
 +
    {
 +
      "Value": "user5"
 +
    },
 +
    {
 +
      "Value": "user6"
 +
    },
 
    {
 
    {
−
      "Value": "user2",
+
      "Value": "user7"
−
      "Action": "Remove"
+
    },
 +
    {
 +
      "Value": "user8"
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user3",
+
      "Value": "user9"
−
      "Action": "Add"
 
 
    }
 
    }
−
  ],
+
  ],
−
  "AllUsers":false
+
  "Limit": 50,
−
}
+
  "Total": 7,
−
 
+
  "Order": "asc"
−
 
+
}
−
Response:
 
−
204 No Content
 
 
</pre>
 
</pre>
  
−
=== New Resource Options ===
+
==== Available Permissions Recipients ====
−
<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/resourceOptions/</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource add operation.
 
−
 
 
−
==== Available Delegates Recipients ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,291: Line 1,317:
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailableDelegatesRecipients
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/AvailablePermissionsRecipients
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to list recipients that can be delegates for a new resource on a given domain.
+
| Use this route to list recipients that can have permissions for an existing resource
 
|-
 
|-
 
! Model
 
! Model
Line 1,302: Line 1,328:
 
<pre>
 
<pre>
 
Request:
 
Request:
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailableDelegatesRecipients
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailablePermissionsRecipients
−
 
 
  
 
Response:
 
Response:
−
200 OK
 
 
{
 
{
 
  "Recipients": [
 
  "Recipients": [
Line 1,325: Line 1,349:
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user5"
+
      "Value": "user8"
 
    },
 
    },
 
    {
 
    {
−
      "Value": "user6"
+
      "Value": "user9"
−
    },
+
    }
−
    {
 
−
      "Value": "user7"
 
−
    },
 
−
    {
 
−
      "Value": "user8"
 
−
    },
 
−
    {
 
−
      "Value": "user9"
 
−
    }
 
 
  ],
 
  ],
 
  "Limit": 50,
 
  "Limit": 50,
−
  "Total": 10,
+
  "Total": 7,
 
  "Order": "asc"
 
  "Order": "asc"
 
}
 
}
 
</pre>
 
</pre>
  
−
==== Available Permissions Recipients ====
+
==== Available Policy Recipients ====
 +
 
 +
Available BookIn, RequestIn, and RequestOutOf policy recipients for an existing resource can all be accessed via the resource's URL followed by <tt>/availableBookInPolicyRecipients</tt>, <tt>/availableRequestInPolicyRecipients</tt>, and <tt>/availableRequestOutOfRecipients</tt>, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,353: Line 1,370:
 
|-
 
|-
 
! URL Format
 
! URL Format
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailablePermissionsRecipients
+
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 +
 
 +
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 +
 
 +
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 
|-
 
|-
 
! Description
 
! Description
−
| Use this route to list recipients that can have permissions for a new resource on a given domain.
+
| Use this route to list recipients that can be in policies for an existing resource
 
|-
 
|-
 
! Model
 
! Model
Line 1,364: Line 1,385:
 
<pre>
 
<pre>
 
Request:
 
Request:
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailablePermissionsRecipients
+
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/availableBookInPolicyRecipients
  
 
Response:
 
Response:
 +
200 OK
 
{
 
{
 
  "Recipients": [
 
  "Recipients": [
−
    {
 
−
      "Value": "user1"
 
−
    },
 
 
    {
 
    {
 
      "Value": "user10"
 
      "Value": "user10"
−
    },
 
−
    {
 
−
      "Value": "user2"
 
 
    },
 
    },
 
    {
 
    {
Line 1,401: Line 1,417:
 
  ],
 
  ],
 
  "Limit": 50,
 
  "Limit": 50,
−
  "Total": 10,
+
  "Total": 8,
 
  "Order": "asc"
 
  "Order": "asc"
 
}
 
}
 
</pre>
 
</pre>
−
 
−
==== Available Policy Recipients ====
 
−
 
−
Available BookIn, RequestIn, and RequestOutOf policy recipients can all be accessed via the resourceOptions URL followed by <tt>/availableBookInPolicyRecipients</tt>, <tt>/availableRequestInPolicyRecipients</tt>, and <tt>/availableRequestOutOfRecipients</tt>, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.
 
−
 
−
{| class="wikitable"
 
−
! Verb
 
−
| GET
 
−
|-
 
−
! URL Format
 
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableBookInPolicyRecipients
 
−
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestInPolicyRecipients
 
−
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestOutOfRecipients
 
−
|-
 
−
! Description
 
−
| Use this route to list recipients that can be in policies for a new resource on a given domain.
 
−
|-
 
−
! Model
 
−
| [[#Recipient|Recipient]] Listing
 
−
|}
 
−
 
−
 
−
<pre>
 
−
Request:
 
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/availableBookInPolicyRecipients
 
−
 
−
Response:
 
−
200 OK
 
−
{
 
−
  "Recipients": [
 
−
    {
 
−
      "Value": "user1"
 
−
    },
 
−
    {
 
−
      "Value": "user10"
 
−
    },
 
−
    {
 
−
      "Value": "user2"
 
−
    },
 
−
    {
 
−
      "Value": "user3"
 
−
    },
 
−
    {
 
−
      "Value": "user4"
 
−
    },
 
−
    {
 
−
      "Value": "user5"
 
−
    },
 
−
    {
 
−
      "Value": "user6"
 
−
    },
 
−
    {
 
−
      "Value": "user7"
 
−
    },
 
−
    {
 
−
      "Value": "user8"
 
−
    },
 
−
    {
 
−
      "Value": "user9"
 
−
    }
 
−
  ],
 
−
  "Limit": 50,
 
−
  "Total": 10,
 
−
  "Order": "asc"
 
−
}
 
−
</pre>
 
−
 
−
=== Existing Resource Options ===
 
−
 
−
<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/resource/(common name)/options</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource edit operation.
 
−
 
−
==== Available Delegates Recipients ====
 
−
 
−
{| class="wikitable"
 
−
! Verb
 
−
| GET
 
−
|-
 
−
! URL Format
 
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/AvailableDelegatesRecipients
 
−
|-
 
−
! Description
 
−
| Use this route to list recipients that can be delegates for an existing resource
 
−
|-
 
−
! Model
 
−
| [[#Recipient|Recipient]] Listing
 
−
|}
 
−
 
−
<pre>
 
−
Request:
 
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailableDelegatesRecipients
 
−
 
−
Response:
 
−
200 OK
 
−
{
 
−
  "Recipients": [
 
−
    {
 
−
      "Value": "user10"
 
−
    },
 
−
    {
 
−
      "Value": "user4"
 
−
    },
 
−
    {
 
−
      "Value": "user5"
 
−
    },
 
−
    {
 
−
      "Value": "user6"
 
−
    },
 
−
    {
 
−
      "Value": "user7"
 
−
    },
 
−
    {
 
−
      "Value": "user8"
 
−
    },
 
−
    {
 
−
      "Value": "user9"
 
−
    }
 
−
  ],
 
−
  "Limit": 50,
 
−
  "Total": 7,
 
−
  "Order": "asc"
 
−
}
 
−
</pre>
 
−
 
−
==== Available Permissions Recipients ====
 
−
 
−
{| class="wikitable"
 
−
! Verb
 
−
| GET
 
−
|-
 
−
! URL Format
 
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/AvailablePermissionsRecipients
 
−
|-
 
−
! Description
 
−
| Use this route to list recipients that can have permissions for an existing resource
 
−
|-
 
−
! Model
 
−
| [[#Recipient|Recipient]] Listing
 
−
|}
 
−
 
−
<pre>
 
−
Request:
 
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailablePermissionsRecipients
 
−
 
−
Response:
 
−
{
 
−
  "Recipients": [
 
−
    {
 
−
      "Value": "user1"
 
−
    },
 
−
    {
 
−
      "Value": "user10"
 
−
    },
 
−
    {
 
−
      "Value": "user2"
 
−
    },
 
−
    {
 
−
      "Value": "user3"
 
−
    },
 
−
    {
 
−
      "Value": "user4"
 
−
    },
 
−
    {
 
−
      "Value": "user8"
 
−
    },
 
−
    {
 
−
      "Value": "user9"
 
−
    }
 
−
  ],
 
−
  "Limit": 50,
 
−
  "Total": 7,
 
−
  "Order": "asc"
 
−
}
 
−
</pre>
 
−
 
−
==== Available Policy Recipients ====
 
−
 
−
Available BookIn, RequestIn, and RequestOutOf policy recipients for an existing resource can all be accessed via the resource's URL followed by <tt>/availableBookInPolicyRecipients</tt>, <tt>/availableRequestInPolicyRecipients</tt>, and <tt>/availableRequestOutOfRecipients</tt>, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.
 
−
 
−
{| class="wikitable"
 
−
! Verb
 
−
| GET
 
−
|-
 
−
! URL Format
 
−
| /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 
−
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 
−
 
−
/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients
 
−
|-
 
−
! Description
 
−
| Use this route to list recipients that can be in policies for an existing resource
 
−
|-
 
−
! Model
 
−
| [[#Recipient|Recipient]] Listing
 
−
|}
 
−
 
−
<pre>
 
−
Request:
 
−
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/availableBookInPolicyRecipients
 
−
 
−
Response:
 
−
200 OK
 
−
{
 
−
  "Recipients": [
 
−
    {
 
−
      "Value": "user10"
 
−
    },
 
−
    {
 
−
      "Value": "user3"
 
−
    },
 
−
    {
 
−
      "Value": "user4"
 
−
    },
 
−
    {
 
−
      "Value": "user5"
 
−
    },
 
−
    {
 
−
      "Value": "user6"
 
−
    },
 
−
    {
 
−
      "Value": "user7"
 
−
    },
 
−
    {
 
−
      "Value": "user8"
 
−
    },
 
−
    {
 
−
      "Value": "user9"
 
−
    }
 
−
  ],
 
−
  "Limit": 50,
 
−
  "Total": 8,
 
−
  "Order": "asc"
 
−
}
 
−
</pre>
 
−
 
−
== v0 ==
 
−
 
−
=== Index ===
 
−
 
−
''URL'':
 
−
<nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
        /ex/resources</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
This operation returns a list of resource mailboxes associated with the domain.
 
−
 
−
 
−
 
−
''Remarks'':
 
−
 
−
The Index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/ResourceList.xsd ResourceList.xsd]
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
get '/customers/12345678/domains/example.com/ex/resources?size=100&offset=10&contains=conference', 'text/xml'
 
−
</pre>
 
−
 
−
 
−
''XML Result Example'':
 
−
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<resourceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resourceList">
 
−
  <offset>0</offset>
 
−
  <size>50</size>
 
−
  <total>3</total>
 
−
  <resources>
 
−
    <resource>
 
−
      <name>apiexresource43</name>
 
−
      <displayName>API Test</displayName>
 
−
      <type>room</type>
 
−
    </resource>
 
−
    <resource>
 
−
      <name>apiexresource5</name>
 
−
      <displayName>API Test</displayName>
 
−
      <type>equipment</type>
 
−
    </resource>
 
−
    <resource>
 
−
      <name>apiexresource85</name>
 
−
      <displayName>API Test</displayName>
 
−
      <type>room</type>
 
−
    </resource>
 
−
  </resources>
 
−
</resourceList>
 
−
</pre>
 
−
 
−
 
−
''Json Result Example'':
 
−
 
−
{"offset":0,"size":50,"total":3,"resources":[{"name":"apiexresource43","displayName":"API Test","type":"room"},{"name":"apiexresource5","displayName":"API Test","type":"equipment"},{"name":"apiexresource85","displayName":"API Test","type":"room"}]}
 
−
 
−
=== Show ===
 
−
 
−
''URL'':
 
−
[<nowiki>GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
        /ex/resources/(resource name)</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Returns the resource's details.
 
−
 
−
 
−
''Remarks'':
 
−
 
−
The show operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Resource.xsd Resource.xsd]
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
get '/customers/12345678/domains/example.com/ex/resource/conference.room', 'text/xml'
 
−
</pre>
 
−
 
−
 
−
''XML Result Example''
 
−
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resource">
 
−
  <name>apiexresource43</name>
 
−
  <displayName>API Test</displayName>
 
−
  <type>room</type>
 
−
</resource>
 
−
</pre>
 
−
 
−
 
−
''Json Result Example'':
 
−
 
−
{"name":"apiexresource43","displayName":"API Test","type":"room"}
 
−
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource is not found
 
−
| 404
 
−
| Resource not found
 
−
|-
 
−
| Entity is found but it's not a resource mailbox
 
−
| 404
 
−
| Mailbox is not a resource.
 
−
|}
 
−
 
−
=== Add/Edit ===
 
−
 
−
''URL'':
 
−
<nowiki>Add: [POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
                /ex/resources/(resource name)
 
−
Edit: [PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
                /ex/resources/(resource name)</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Adds/edits the resource with the specified information.  Required fields must be supplied when adding. Others are optional.
 
−
 
−
 
−
{| class="wikitable"
 
−
!''Field Name''
 
−
!''Data Type''
 
−
!''Description''
 
−
|-
 
−
| displayName
 
−
| string
 
−
| Resource display name (Required for add)
 
−
|-
 
−
| type
 
−
| string
 
−
| The resource type, 'room' or 'equipment' (Required for add)
 
−
|-
 
−
| password
 
−
| string
 
−
| The password to change the settings of the mailbox or add/remove admins (Required for add)
 
−
|}
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
post '/customers/12345678/domains/example.com/ex/resources/conference.room',
 
−
{
 
−
  'displayName' => 'Conference Room'
 
−
  'type' => 'room'
 
−
  'password' => 'abcDEF123'
 
−
},
 
−
'text/xml'
 
−
</pre>
 
−
 
−
<pre>
 
−
put '/customers/12345678/domains/example.com/ex/resources/all.employees',
 
−
{
 
−
  'displayName' => 'Conference Room A'
 
−
  'password' => 'ABCd4321'
 
−
},
 
−
'text/xml',
 
−
</pre>
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| New resource mailbox already exists
 
−
| 400
 
−
| The email address conference.room@abc.com is already in use
 
−
|-
 
−
| New resource mailbox name doesn't meet the naming requirements
 
−
| 400
 
−
| Invalid resource name
 
−
|-
 
−
| New display name doesn't meet the naming requirements
 
−
| 400
 
−
| Invalid display name
 
−
|-
 
−
| Invalid resource mailbox type
 
−
| 400
 
−
| Invalid Resource Type. The input must be: room/equipment.
 
−
|}
 
−
 
−
 
−
=== Delete ===
 
−
 
−
''URL'':
 
−
<nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
            /ex/resources/(resource name)</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Deletes the resource.
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
delete '/customers/12345678/domains/example.com/ex/resources/all.employees', 'text/xml'
 
−
</pre>
 
−
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource is not found
 
−
| 404
 
−
| Resource not found
 
−
|-
 
−
| Entity is found but it's not a resource mailbox
 
−
| 404
 
−
| Mailbox is not a resource.
 
−
|}
 
−
 
−
 
−
=== Admins ===
 
−
 
−
This refers to the admins that can manage the resource.
 
−
 
−
==== Index Admin ====
 
−
 
−
''URL'':
 
−
<nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
        /ex/resources/(resource name)/admins</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Gets the list of resource admins.
 
−
 
−
 
−
''Remarks'':
 
−
 
−
The Index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/ResourceAdminList.xsd ResourceAdminList.xsd]
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
get '/customers/12345678/domains/example.com/ex/resources/conference.room/admins', 'text/xml'
 
−
</pre>
 
−
 
−
 
−
''XML Result Example'':
 
−
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<resourceAdminList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resourceAdminList">
 
−
  <offset>0</offset>
 
−
  <size>50</size>
 
−
  <total>3</total>
 
−
  <admins>
 
−
    <admin>apiexmailbox70@apidomain90.com</admin>
 
−
    <admin>apiexmailbox87@apidomain90.com</admin>
 
−
    <admin>apiexmailbox89@apidomain90.com</admin>
 
−
  </admins>
 
−
</resourceAdminList>
 
−
</pre>
 
−
 
−
 
−
''Json Result Example'':
 
−
 
−
{"offset":0,"size":50,"total":3,"admins":["apiexmailbox70@apidomain90.com","apiexmailbox87@apidomain90.com","apiexmailbox89@apidomain90.com"]}
 
−
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource is not found
 
−
| 404
 
−
| Resource not found
 
−
|-
 
−
| Entity is found but it's not a resource mailbox
 
−
| 404
 
−
| Mailbox is not a resource.
 
−
|}
 
−
 
−
==== Add Admin ====
 
−
 
−
''URL'':
 
−
<nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
        /ex/resources/(resource name)/admins/(admin name)</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Adds an admin to the resource.
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
post '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', {}, 'text/xml'
 
−
</pre>
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource not found
 
−
| 404
 
−
| Resource not found
 
−
|}
 
−
 
−
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource is not found
 
−
| 404
 
−
| Resource not found
 
−
|-
 
−
| Entity is found but it's not a resource mailbox
 
−
| 404
 
−
| Mailbox is not a resource.
 
−
|-
 
−
| Admin is already on the resource admin list.
 
−
| 400
 
−
| User is already on the resource admin list.
 
−
|}
 
−
 
−
==== Delete Admin ====
 
−
 
−
''URL'':
 
−
<nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
 
−
        /ex/resources/(resource name)/admins/(admin name)</nowiki>
 
−
 
−
 
−
''Description'':
 
−
 
−
Removes the admin from the resource.
 
−
 
−
 
−
''Example'':
 
−
<pre>
 
−
delete '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', 'text/xml'
 
−
</pre>
 
−
 
−
 
−
''Errors'':
 
−
 
−
{| class="wikitable"
 
−
!''Description''
 
−
!''HTTP Response Code''
 
−
!''Sample Message''
 
−
|-
 
−
| Resource is not found
 
−
| 404
 
−
| Resource not found
 
−
|-
 
−
| Entity is found but it's not a resource mailbox
 
−
| 404
 
−
| Mailbox is not a resource.
 
−
|-
 
−
| Admin is not found on the resource admin list.
 
−
| 400
 
−
| User is not on the resource admin list.
 
−
|}
 

Latest revision as of 11:27, 23 September 2014

v1 - Current

This resource supports submitting and responding with both XML and JSON. (The v0 method of submitting data via form URL-encoded variables is NOT supported in v1.)

Data Model

(See Serialization)

Exchange Resource

Required for Create*

Operations:

This model extends Mailbox.

Field Name Data Type Verbs Description
Type* String GET, POST, PUT Room or Equipment
Upn String GET User Principal Name
ResourceCapacity Integer GET, POST, PUT e.g. The number of seats in a room.
CustomProperties Custom Properties array GET, POST, PUT User-defined properties (see below).
ResourceCalendarProcessing Calendar Processing GET, POST, PUT See examples below.
ResourceDelegates Delegate Array GET, POST, PUT See examples below.
ResourcePermissions Resource Permission Array GET, POST, PUT See examples below.
BookInPolicy Recipients GET, POST, PUT See examples below.
RequestInPolicy Recipients GET, POST, PUT See examples below.
RequestOutOfPolicy Recipients GET, POST, PUT See examples below.

Calendar Processing

Operations:

Field Name Data Type Description
AutoBooking String Must be "None", "AutoAccept", or "AutoUpdate"
BookingWindowInDays Integer >= 0
EnforceSchedulingHorizon Boolean
AllowRecurringMeetings Boolean
ScheduleOnlyDuringWorkHours Boolean
MaximumDurationInMinutes Integer >= 0
MaximumConflictInstances Integer >= 0
ConflictPercentageAllowed Integer Must be between 0 and 100.
AdditionalResponse Calendar Processing Additional Response Object See next object definition below.
Calendar Processing Additional Response
Field Name Data Type Description
Enable Boolean
Value String
Delegate

Operations:

Field Name Data Type Description
Value String Email Address
Action String Must be "Add" or "Remove". Only valid for PUT requests.
Permission

Operations:

Field Name Data Type Description
Recipient String Email Address
Permissions Permission Type Array Array of Permission Type (see below)
Permission Type
Field Name Data Type Description
Permission String Must be "FullAccess" or "SendAs".
Recipients

Operations:

Field Name Data Type Description
All Boolean
Recipients Recipient Array Array of Recipient (see below).
Recipient

Operations:

Field Name Data Type Description
Value String Email Address
Action String Must be "Add" or "Remove". Only valid for PUT requests.

List

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/
Description Use this to list resource mailboxes, supports exporting, supports exporting. (see Listings)
Model Exchange Resource Listing

HTTP Codes

Code Condition
200 OK The listing was successfully retrieved.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFondFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources

Response:
200 OK
{
  "ResourceMailboxes": [
    {
      "Type": "Room",
      "PhoneNumber": "1234567890",
      "Upn": "room.101@example.com",
      "ResourceCapacity": 25,
      "CustomProperties": [
        {
          "Value": "Videoconferencing",
          "ExchangeAction": 0
        },
        {
          "Value": "Whiteboard",
          "ExchangeAction": 0
        }
      ],
      "CommonName": "room.101",
      "DisplayName": "Room 101",
      "Alias": "room.101.example.com",
      "IsHiddenFromAddressList": false,
      "PrimarySmtpAddress": null,
      "EmailAddresses": null,
      "Status": "Ready",
      "LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=room.101b5c"
    },
    {
      "Type": "Room",
      "PhoneNumber": "1234567890",
      "Upn": "room.102@example.com",
      "ResourceCapacity": 25,
      "CustomProperties": [
        {
          "Value": "Videoconferencing",
          "ExchangeAction": 0
        },
        {
          "Value": "Whiteboard",
          "ExchangeAction": 0
        }
      ],
      "CommonName": "room.102",
      "DisplayName": "Room 101",
      "Alias": "room.102.example.com",
      "IsHiddenFromAddressList": false,
      "PrimarySmtpAddress": null,
      "EmailAddresses": null,
      "Status": "Ready",
      "LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=room.1029fd"
    },
    {
      "Type": "Room",
      "PhoneNumber": "1234567890",
      "Upn": "room.103@example.com",
      "ResourceCapacity": 25,
      "CustomProperties": [
        {
          "Value": "Videoconferencing",
          "ExchangeAction": 0
        },
        {
          "Value": "Whiteboard",
          "ExchangeAction": 0
        }
      ],
      "CommonName": "room.103",
      "DisplayName": "Room 103",
      "Alias": "room.103.example.com",
      "IsHiddenFromAddressList": false,
      "PrimarySmtpAddress": null,
      "EmailAddresses": null,
      "Status": "Ready",
      "LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=room.10370c"
    }
  ],
  "Sort": "cn",
  "Limit": 50,
  "Total": 3,
  "Order": "asc"
}

Resource

POSTS, PUTS, and DELETES support Asynchronous Statuses and Asynchronous Errors.

Create

Verb POST
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/
Description Use this route to add a new resource mailbox.
Model Exchange Resource

HTTP Codes

Code Condition
204 No Content The request has been accepted and will be processed.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFondFault for more detail. 
Request:
POST https://api.emailsrvr.com/v1/domains/example.com/ex/resources
{
  "CommonName": "room.101",
  "Type": "Room",
  "DisplayName": "Room 101",
  "PhoneNumber": "1234567890",
  "ResourceCapacity": 25,
  "CustomProperties": [
    {
      "Value": "Videoconferencing"
    },
    {
      "Value": "Whiteboard"
    }
  ],
  "CalendarProcessing": {
    "AutoBooking": "AutoUpdate",
    "BookingWindowInDays": 90,
    "EnforceSchedulingHorizon": false,
    "AllowConflicts": true,
    "AllowRecurringMeetings": false,
    "ScheduleOnlyDuringWorkHours": true,
    "MaximumDurationInMinutes": 720,
    "MaximumConflictInstances": 1,
    "ConflictPercentageAllowed": 50,
    "AdditionalResponse": {
      "Enable": true,
      "Value": "This is an additional response"
    }
  },
  "Delegates": [
    {
      "Value": "user1"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    }
  ],
  "Permissions": [
    {
      "Recipient": "user5",
      "Types": [
        "FullAccess"
      ]
    },
    {
      "Recipient": "user6",
      "Types": [
        "SendAs"
      ]
    },
    {
      "Recipient": "user7",
      "Types": [
        "FullAccess",
        "SendAs"
      ]
    }
  ],
  "BookInPolicy": {
    "Recipients": [
      {
        "Value": "user1"
      },
      {
        "Value": "user2"
      }
    ]
  },
  "RequestInPolicy": {
    "Recipients": [
      {
        "Value": "user4"
      },
      {
        "Value": "user5"
      }
    ]
  },
  "RequestOutOfPolicy": {
    "AllUsers": true
  }
}

Response:
204 No Content

Read

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)
Description Use this route to read an existing resource mailbox.
Model Exchange Resource *

* Note: The Exchange Resource resource contains some paged data that must be accessed via separate GET requests. Properties directly on the object and CustomProperties, can be accessed via a GET on the base resource.

HTTP Codes

Code Condition
200 OK The resource was successfully retrieved.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFondFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.1


Response:
200 OK
{
  "Type": "Room",
  "PhoneNumber": "1234567890",
  "Upn": "room.101@example.com",
  "ResourceCapacity": 25,
  "CustomProperties": [
    {
      "Value": "Videoconferencing",
      "ExchangeAction": 0
    },
    {
      "Value": "Whiteboard",
      "ExchangeAction": 0
    }
  ],
  "CommonName": "room.101",
  "DisplayName": "Room 101",
  "Alias": "room.101.example.com",
  "IsHiddenFromAddressList": false,
  "PrimarySmtpAddress": null,
  "EmailAddresses": null,
  "Status": "Ready",
  "LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=room.1019d4"
}

Update

Verb PUT
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)
Description Use this route to update an existing resource mailbox.
Model Exchange Resource

HTTP Codes

Code Condition
204 No Content The request has been accepted and will be processed.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFondFault for more detail.

All data that is part of the Exchange Resource resource can be updated in a single PUT request. CustomProperties, Delegates, and policies must specify an Action, set to either Add or Remove, to specify the operation for that value. Permissions must be specified in whole. For example, resource1@example.com has user5/tt>'s permission types set to <tt>FullAccess. To add SendAs, the request must contain both FullAccess and SendAs for that user. To remove all permissions from user7, the request must contain an empty Type array for that user. 

Request:
PUT https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101
{
  "Type": "Room",
  "DisplayName": "Conference Room 101",
  "PhoneNumber": "try shouting",
  "ResourceCapacity": "30",
  "CustomProperties": [
    {
      "Value": "Whiteboard",
      "Action": "Remove"
    }
  ],
  "CalendarProcessing": {
    "AutoBooking": "AutoUpdate",
    "BookingWindowInDays": 180,
    "EnforceSchedulingHorizon": true,
    "AllowConflicts": false,
    "AllowRecurringMeetings": true,
    "ScheduleOnlyDuringWorkHours": false,
    "MaximumDurationInMinutes": 1440,
    "MaximumConflictInstances": 0,
    "ConflictPercentageAllowed": 0,
    "AdditionalResponse": {
      "Enable": false
    }
  },
  "Delegates": [
    {
      "Value": "user3",
      "Action": "Remove"
    },
    {
      "Value": "user4",
      "Action": "Add"
    }
  ],
  "Permissions": [
    {
      "Recipient": "user5",
      "Types": [
        "FullAccess",
        "SendAs"
      ]
    },
    {
      "Recipient": "user7",
      "Types": []
    },
    {
      "Recipient": "user8",
      "Types": [
        "FullAccess"
      ]
    }
  ],
  "BookInPolicy": {
    "Recipients": [
      {
        "Value": "user2",
        "Action": "Remove"
      },
      {
        "Value": "user3",
        "Action": "Add"
      }
    ]
  },
  "RequestInPolicy": {
    "AllUsers": true
  },
  "RequestOutOfPolicy": {
    "AllUsers": false,
    "Recipients": [
      {
        "Value": "user7",
        "Action": "Add"
      },
      {
        "Value": "user8",
        "Action": "Add"
      }
    ]
  }
}


Response:
204 No Content

Delete

Verb DELETE
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)
Description Use this route to delete a resource mailbox.
Model None

HTTP Codes

Code Condition
204 No Content The request has been accepted and will be processed.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFondFault for more detail. 
Request:
DELETE https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101


Response:
204 No Content

Export

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources?exportTo={your email address}
Description Use this route to export a file of resource mailboxes.
Model Exchange Resource Listing

HTTP Codes

Code Condition
202 Accepted The request has been accepted and will be processed.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFoundFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources?exportTo=myAdminEmail@example.com

Response:
202 Accepted

Import

Verb POST
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources?emailAddress={your email address}
Description Use this route to import a file of resource mailboxes.
Model FileUrl (string), OverrideExisting (boolean)

HTTP Codes

Code Condition
202 Accepted The request has been accepted and will be processed.
400 Bad Request The request was invalid. Inspect the validationFault response for more detail.
404 Not Found The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the itemNotFoundFault for more detail.

Instructions:

1. Create a CSV (comma-separated values) file containing the resource mailboxes you'd like to import. You can get a valid CSV file format by bulk-exporting your current resource mailboxes.

2. Upload the file to a public accessible URL (e.g. cloud-files, CDN, etc.)

3. Call this endpoint with the url of the file in the body.

4. The OverrideExisting field is optional and defaults to false. When true, any existing resource mailboxes will be modified to match the CSV file, including the removal of assets, permissions and delegates.

  • NOTE: The Capacity and PhoneNumber fields will be cleared out if left blank when OverrideExisting is true or false.

5. You will receive a confirmation email to the address specified in the URL when the import is complete. Any rows that were not able to be imported are available via a link provided in the confirmation email. 

Request:
POST https://api.emailsrvr.com/v1/domains/example.com/ex/resources?emailAddress=myAdminEmail@example.com
{
    "FileUrl": "http://asdfasdfzxcvzxcvasdfasdf.cf1.rackcdn.com/MyResourceMailboxes.csv",
    "OverrideExisting": false
}
Response:
202 Accepted

Calendar Processing

Read
Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/calendarProcessing
Description Use this route to read an existing resource mailbox's calendar processing data.
Model Calendar Processing

HTTP Codes

Code Condition
200 OK The data was successfully retrieved.
404 Not Found The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the itemNotFondFault for more detail. 


Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/calendarProcessing


Response:
200 OK
{
  "AutoBooking": "AutoUpdate",
  "BookingWindowInDays": 90,
  "EnforceSchedulingHorizon": false,
  "AllowConflicts": true,
  "AllowRecurringMeetings": false,
  "ScheduleOnlyDuringWorkHours": true,
  "MaximumDurationInMinutes": 720,
  "MaximumConflictInstances": 1,
  "ConflictPercentageAllowed": 50,
  "AdditionalResponse": {
    "Enable": true,
    "Value": "This is an additional response"
  }
}

Delegates

List
Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/delegates
Description Use this route to list an existing resource mailbox's delegates data. (see Listings)
Model Delegates Listing

HTTP Codes

Code Condition
200 OK The data was successfully retrieved.
404 Not Found The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the itemNotFondFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/delegates

Response:
200 OK
{
  "Delegates": [
    {
      "Value": "user1"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    }
  ],
  "Limit": 50,
  "Total": 3,
  "Order": "asc"
}

Permissions

List
Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/permissions
Description Use this route to list an existing resource mailbox's permissions data. (see Listings)
Model Permission Listing

HTTP Codes

Code Condition
200 OK The data was successfully retrieved.
404 Not Found The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the itemNotFondFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/permissions


Response:
200 OK
{
  "Permissions": [
    {
      "Recipient": "user5",
      "Types": [
        "FullAccess"
      ]
    },
    {
      "Recipient": "user6",
      "Types": [
        "SendAs"
      ]
    },
    {
      "Recipient": "user7",
      "Types": [
        "FullAccess",
        "SendAs"
      ]
    }
  ],
  "Limit": 50,
  "Total": 3,
  "Order": "asc"
}

Policies

BookIn, RequestIn, and RequestOutOf policies can all be accessed via the resource's URL followed by /bookInPolicy, /requestInPolicy, and /requestOutOfPolicy, respectively. Examples in this section will use BookInPolicy, but the interface for the three is all the same.

List
Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/bookInPolicy

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestInPolicy

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/requestOutOfPolicy

Description Use this route to list an existing resource mailbox's policies data. (see Listings)
Model Recipient Listing

HTTP Codes

Code Condition
200 OK The data was successfully retrieved.
404 Not Found The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the itemNotFondFault for more detail. 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/bookInPolicy


Response:
{
  "Recipients": [
    {
      "Value": "user1"
    },
    {
      "Value": "user2"
    }
  ],
  "AllUsers":false,
  "Limit": 50,
  "Total": 2,
  "Order": "asc"
}

New Resource Options

https://api.emailsrvr.com/v1/domains/(domain)/ex/resourceOptions/ is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource add operation.

Available Delegates Recipients

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailableDelegatesRecipients
Description Use this route to list recipients that can be delegates for a new resource on a given domain.
Model Recipient Listing 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailableDelegatesRecipients


Response:
200 OK
{
  "Recipients": [
    {
      "Value": "user1"
    },
    {
      "Value": "user10"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user5"
    },
    {
      "Value": "user6"
    },
    {
      "Value": "user7"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 10,
  "Order": "asc"
}

Available Permissions Recipients

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/AvailablePermissionsRecipients
Description Use this route to list recipients that can have permissions for a new resource on a given domain.
Model Recipient Listing 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/AvailablePermissionsRecipients

Response:
{
  "Recipients": [
    {
      "Value": "user1"
    },
    {
      "Value": "user10"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user5"
    },
    {
      "Value": "user6"
    },
    {
      "Value": "user7"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 10,
  "Order": "asc"
}

Available Policy Recipients

Available BookIn, RequestIn, and RequestOutOf policy recipients can all be accessed via the resourceOptions URL followed by /availableBookInPolicyRecipients, /availableRequestInPolicyRecipients, and /availableRequestOutOfRecipients, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableBookInPolicyRecipients

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestInPolicyRecipients

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resourceOptions/availableRequestOutOfRecipients

Description Use this route to list recipients that can be in policies for a new resource on a given domain.
Model Recipient Listing 


Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resourceOptions/availableBookInPolicyRecipients

Response:
200 OK
{
  "Recipients": [
    {
      "Value": "user1"
    },
    {
      "Value": "user10"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user5"
    },
    {
      "Value": "user6"
    },
    {
      "Value": "user7"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 10,
  "Order": "asc"
}

Existing Resource Options

https://api.emailsrvr.com/v1/domains/(domain)/ex/resource/(common name)/options is the base URL for getting complete sets of valid data that can be submitted as part of an Exchange Resource edit operation.

Available Delegates Recipients

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/AvailableDelegatesRecipients
Description Use this route to list recipients that can be delegates for an existing resource
Model Recipient Listing 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailableDelegatesRecipients

Response:
200 OK
{
  "Recipients": [
    {
      "Value": "user10"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user5"
    },
    {
      "Value": "user6"
    },
    {
      "Value": "user7"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 7,
  "Order": "asc"
}

Available Permissions Recipients

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/(common name)/AvailablePermissionsRecipients
Description Use this route to list recipients that can have permissions for an existing resource
Model Recipient Listing 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/AvailablePermissionsRecipients

Response:
{
  "Recipients": [
    {
      "Value": "user1"
    },
    {
      "Value": "user10"
    },
    {
      "Value": "user2"
    },
    {
      "Value": "user3"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 7,
  "Order": "asc"
}

Available Policy Recipients

Available BookIn, RequestIn, and RequestOutOf policy recipients for an existing resource can all be accessed via the resource's URL followed by /availableBookInPolicyRecipients, /availableRequestInPolicyRecipients, and /availableRequestOutOfRecipients, respectively. The example in this section will use BookInPolicy, but the interface for the three is all the same.

Verb GET
URL Format /v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients

/v1/customers/{customer account number}/domains/{domain name}/ex/resources/resources/(common name)/availableBookInPolicyRecipients

Description Use this route to list recipients that can be in policies for an existing resource
Model Recipient Listing 
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/resources/room.101/options/availableBookInPolicyRecipients

Response:
200 OK
{
  "Recipients": [
    {
      "Value": "user10"
    },
    {
      "Value": "user3"
    },
    {
      "Value": "user4"
    },
    {
      "Value": "user5"
    },
    {
      "Value": "user6"
    },
    {
      "Value": "user7"
    },
    {
      "Value": "user8"
    },
    {
      "Value": "user9"
    }
  ],
  "Limit": 50,
  "Total": 8,
  "Order": "asc"
}
Retrieved from "http://api-wiki.apps.rackspace.com/api-wiki/index.php?title=Exchange_Resource_Mailbox_(Rest_API)&oldid=575"