Mike.robski: 1 revision: Release 109

2015-07-24T18:14:09Z

1 revision: Release 109

Angel.dinev: /* Sorted request */

2015-04-16T12:27:18Z

Sorted request

Mike.robski: 1 revision: Release 103

2015-02-06T17:23:39Z

1 revision: Release 103

Mike.robski at 16:06, 6 February 2015

2015-02-06T16:06:48Z

New page

= GET /accounts/{account}/email/{domain}/blackwhitelist =
Retrieves a list of all addresses included in black/white list for a specific domain

__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/blackwhitelist</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

=== Response Body ===
<nowiki>
{
"totalCount": {totalCount},
"list": [
{
"type": "{type}",
"address": "{address}"
}
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; totalCount - ''int''
: The total count of addresses included in black/white list

; type - ''string''
: Type of address included in black/white list. Possible values are "W" or "B". "W" means the mailbox is included in "whitelist", "B" - included in "blacklist".

; address - ''string''
: The address of the black/whitelisted mailbox.

; links - ''list''
:[[Hypermedia]] to the get black/whitelisted addresses

== Examples ==

=== Get all addresses included in black/white list ===
'''Request'''
<nowiki>
GET /accounts/account-number/email/test.com/blackwhitelist
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"totalCount": 3,
"list": [
{
"type": "W",
"address": "mb1-white@somedomain.com"
},
{
"type": "B",
"address": "mb2-black@domain.com"
},
{
"type": "B",
"address": "mb3-black@somedomain.com"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist",
"rel": "self"
}
]
}
</nowiki>

=== Get filtered list by address ===
'''Request'''
<nowiki>
GET /accounts/account-number/email/test.com/blackwhitelist?filterAddress=*somedomain.com*
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"totalCount": 2,
"list": [
{
"type": "W",
"address": "mb1-white@somedomain.com"
},
{
"type": "B",
"address": "mb3-black@somedomain.com"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist?filterAddress=*somedomain.com*",
"rel": "self"
}
]
}
</nowiki>

=== Get filtered list by type ===
'''Request'''
<nowiki>
GET /accounts/account-number/email/test.com/blackwhitelist?filterType=W
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"totalCount": 1,
"list": [
{
"type": "W",
"address": "mb1-white@somedomain.com"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist?filterType=W",
"rel": "self"
}
]
}
</nowiki>

=== Paginated request ===
'''Request'''
<nowiki>
GET /accounts/account-number/email/test.com/blackwhitelist?pageSize=2&page=1
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"totalCount": 2,
"list": [
{
"type": "W",
"address": "mb1-white@somedomain.com"
},
{
"type": "B",
"address": "mb2-white@domain.com"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist?pageSize=2&page=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist?pageSize=2&page=2",
"rel": "last"
}
]
}
</nowiki>

=== Sorted request ===
'''Request'''
<nowiki>
GET /accounts/account-number/email/test.com/blackwhitelist?sortField=address&sortOrder=desc
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"totalCount": 3,
"list": [
{
"type": "B",
"address": "mb3-black@somedomain.com"
},
{
"type": "B",
"address": "mb2-black@domain.com"
},
{
"type": "W",
"address": "mb1-white@somedomain.com"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-number/email/test.com/blackwhitelist?sortField=address&sortOrder=desc",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 59: / Line 59: @@
 ; address - ''string''
-: The address of the black/whitelisted mailbox.
+: The address of the black/whitelisted mailbox or domain.
 ; links - ''list''
@@ Line 77: / Line 77: @@
+{
-    "totalCount": 3,
+    "totalCount": 4,
     "list": [
+       {
@@ Line 90: / Line 90: @@
           "type": "B",
           "address": "mb3-black@somedomain.com"
+       }
     ],
@@ Line 205: / Line 209: @@
+{
-    "totalCount": 3,
+    "totalCount": 4,
     "list": [
+       {
@@ Line 218: / Line 222: @@
           "type": "W",
           "address": "mb1-white@somedomain.com"
+       }
     ],

Accounts-account-email-domain-blackwhitelist:GET - Revision history

Mike.robski: 1 revision: Release 109

Angel.dinev: /* Sorted request */

Mike.robski: 1 revision: Release 103

Mike.robski at 16:06, 6 February 2015