GET:site/bans/{banid}

Overview

public. See a specific ban entry

Message Format

Output:

<ban id="{id}" href="{uri}">
  <user.createdby id="{user_id}" href="{user_page_uri}">
    <nick>{text}</nick>
    <username>{text}</username>
    <fullname>{text}</fullname>
    <email>{text}</email>
    <hash.email>{hash}</hash.email>
    <uri.gravatar>{uri}</uri.gravatar>
  </user.createdby>
  <date.modified>{date}</date.modified>
  <description>{text}</description>
  <date.expires>{date}</date.expires>
  <permissions.revoked>
    <operations mask="{mask}">{permissions}</operations>
  </permissions.revoked>
  <ban.addresses>
    <address>{address}</address>
  </ban.addresses>
  <ban.users>
    <user id="{user_id}" href="{user_uri}">
      <nick>{text}</nick>
      <username>{text}</username>
      <fullname>{text}</fullname>
      <email>{text}</email>
      <hash.email>{hash}</hash.email>
      <uri.gravatar>{uri}</uri.gravatar>
    </user>
  </ban.users>
</ban>

Implementation Notes

The output document returns a descriptions of the user/address banned and the user responsible for the banning. Also returned is the description of the ban, most notably when it expires and the permissions revoked. The permissions revoked element lists all permissions (e.g. READ, UPDATE, LOGIN) that a user or address loses. Operations requiring the lost permissions will return a 403 Forbidden HTTP response.

Code Samples

C# Samples

Curl Samples

PHP Samples

Other Code Samples