RESTAPI Mailbox

Manage computer mailboxes and the files they contain.

GET
mailbox/{computer id}
Fetches a list of files in a given computer's mailbox.

Request: URL is all that is required

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.
  • HTTP 404 - Returns empty response if action is not found.

Response Schema: BESAPI.xsd

POST
mailbox/{computer id}
Creates a new mailbox file.

Request: The file(s) to be uploaded in multipart form encoding. For uploading a single file you can specify the filename in the content-disposition header and send the file as the body.

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.

Response Schema: BESAPI.xsd

GET
mailbox/{computer id}/{file id}
Fetches the details of the specified file in the specified computer's mailbox.

Request: URL is all that is required

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.
  • HTTP 404 - Returns empty response if action is not found.

Response Schema: BESAPI.xsd

PUT
mailbox/{computer id}/{file id}
Updates the specified mailbox file.

Request: The file(s) to be uploaded in multipart form encoding.

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.

Response Schema: BESAPI.xsd

POST
mailbox/{computer id}/{file id}
Updates the specified new mailbox file.

Request: The file(s) to be uploaded in multipart form encoding.

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.

Response Schema: BESAPI.xsd

DELETE
mailbox/{computer id}/{file id}
Deletes the specified files from the specified computer's mailbox.

Request: The file(s) to be uploaded in multipart form encoding.

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.

Response Schema: BESAPI.xsd

POST
mailbox/
Creates a new mailbox file.

Request: The file(s) to be uploaded in multipart form encoding.

Response: List of files in the mailbox.

  • HTTP 200 - Returns XML in body of response.

Response Schema: BESAPI.xsd