Accounts-accountNumber-dedicatedServers-serverId-ipAddresses-ipAddr-monitoring-notificationGroups-groupId-contacts-contactId:GET
From Hostway API Documentation
Revision as of 13:36, 30 May 2016 by Corinne.chui (Talk | contribs)
GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}
This API call is deprecated!
List contact details
Contents |
Request
GET /accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}
Request Parameters
- accountNumber - string
- serverId - string
- ipAddr - string
- groupId - string
- Id of the notification group
- contactId - string
- Id of the contact in this notification group
URI Parameters
None
Request Headers
- Authorization
- Specify the Authorization header when requesting details for an order that was already submitted. Follow the instructions for API Authentication.
Response
Status Code
- 200 OK
- Success
- 401 Unauthorized
- This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required
- 404 Not Found
- The resource requested is not found
Response Body
{
"contacts": [
{
"name": "{contact_name}",
"onTime": {contact_ontime},
"links": [
{
"href": "{{APIBaseURL}}/accounts/{accountNumber}/dedicatedServers/{serverId}/ipAddresses/{ipAddr}/monitoring/notificationGroups/{groupId}/contacts/{contactId}/",
"rel": "self"
}
],
"address": "{contact_address}",
"offTime": {contact_offtime},
"type": "{contact_type}",
"id": {contact_id}
}
]
}
Parameters
- id - string
- Unique identifier for this contact.
- name - string
- Descriptive name for this contact.
- type - EMAIL/PAGER
- address - string
- Email or pager number
- onTime - int
- offTime - int
- links - list
- Hypermedia for this resource.
Examples
Successful retrieval
Request
GET https://api.hostway.com/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556
Response
- OK (200):
{
"contact": {
"onTime": 10400,
"name": "test_contact_updated",
"address": "updated_abc@abc.com",
"offTime": 11600,
"type": "EMAIL",
"id": 1556
},
"links": [{
"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556",
"rel": "self"
}]
}
Resource not found
Request
GET https://api.hostway.com/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/9999
Response
- Item Not Found (404):
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
See also
