Was this page helpful?

GET:site/bans

    Overview

    public. Get a list of all IP and user bans

    Uri Parameters

    None

    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    Return Codes
    NameValueDescription
    Forbidden403ADMIN access is required
    Ok200Request completed successfully

    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>
    <ban id="{id}" href="{uri}">
    ...
    </ban>
    ...

    Implementation Notes

    This feature is very similar to GET:site/bans/{banid} except it lists all existing bans.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by