/* 
   This is the schema for the BrainML exchange admin functions. The admin
   interface provides for open-ended, application-specific communications.
 */
targetNamespace "urn:bml/brainml.org:internal/Protocols/5"
namespace "urn:bml/brainml.org:internal/Protocols/5"

/* Admin request, to be sent by client. */
element admin { admin-type }
complexType admin-type {
    ( { any }, )?
    
    /* User ID (account name) of the user account. */
    required attribute userID { xs:token }
    
    /*  Authorization code.  This is an opaque value that should be passed back
      to the server, together with userID, for subsequent operations. */
    required attribute authKey { xs:token }
    
    /* Token specifying requested admin action. */
    attribute action { xs:token }
    
    /* Token specifying identifier to operate on.  Leave out if not needed. */
    attribute opID { xs:token }
}

/* Server response to admin request. */
element admin_result { admin_response-type }
complexType admin_response-type {
    ( { any }, )?
    
    /* 
      Result status.
 */
    attribute status { xs:token { /success|failure/  } }
}

/*  Element for reporting an error in admin request - optional content beneath
   admin_response.  Includes a numeric error code.  The contents of the
   element include a description of the type as well as any particular
   information about what went wrong. */
element admin_error { admin_error-type }
complexType admin_error-type {
    xs:string
    
    /*  Code is a positive integer code for the type of error.
      Codes below 100 are reserved for BrainML use. */
    attribute code { xs:positiveInteger }
}