POST:site/bans

Overview

public. Create a ban entry

Message Format

Input:

<ban>
    <description>{text}</description>
    <date.expires>YYYY-MM-DDTHH:MM:SSZ</date.expires>
    <permissions.revoked>
        <operations>
            BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS,CONTROLPANEL,ADMIN
        </operations>
    </permissions.revoked>
    <ban.addresses>???</ban.addresses>
    <ban.users>
        <user id="{id}"/>
    </ban.users>
</ban>

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}">
        BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS,CONTROLPANEL,ADMIN
    </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 input document provides a description of the ban. A user and/or address is specified and also the permissions revoked. Banned users attempting to execute any feature requiring a revoked permission will receive a 403 Forbidden HTTP response.

Code Samples

C# Samples

Curl Samples

PHP Samples

Other Code Samples