show¶

Show watermark information.

Parameters¶

watermark_key : string: Key of the watermark which information to show.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <watermark key="WAmK1Nj6">
    <error />
    <link>
      <address>content.bitsontherun.com</address>
      <path>/watermarks/WAmK1Nj6.png</path>
      <protocol>http</protocol>
    </link>
    <md5>45a7a88f5a70e27986dae0b88a591642</md5>
    <name>Watermark #1</name>
    <status>ready</status>
  </watermark>
</response>

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <watermark key="WAmK1Nj6">
    <error />
    <link>
      <address>content.bitsontherun.com</address>
      <path>/watermarks/WAmK1Nj6.png</path>
      <protocol>http</protocol>
    </link>
    <md5>45a7a88f5a70e27986dae0b88a591642</md5>
    <name>Watermark #1</name>
    <status>ready</status>
    <upload_link>
      <protocol>http</protocol>
      <address>upload.bitsontherun.com</address>
      <path>/v1/accounts/watermarks/upload</path>
      <query>
        <key>WAmK1Nj6</key>
        <token>19f18c66315f7c7e78f7aeceb6f1fd19144728b9cd482b87</token>
      </query>
    </upload_link>
  </watermark>
</response>

Response parameters¶

/response/status : string: Call execution status. Set to ok if call executed successfully.

//watermark/@key : string: Watermark key.

//watermark/md5: string: Watermark file MD5 message digest.

//watermark/name: string: Name of the watermark.

//watermark/link : string: Watermark download link is split into 3 parts: protocol, address and path. Included in response only when watermark status is ready or updating.

//watermark/link/protocol : string: Protocol part of the watermark download link.

//watermark/link/address : string: Address part of the watermark download link.

//watermark/link/path : string: Path part of the watermark download link.

//watermark/status: string

Watermark status:

created

A new watermark is created using /accounts/watermarks/create call. Waiting for the watermark file upload.
Processing of the initial watermark file upload has failed and re-upload is initiated using /accounts/watermarks/update call.

processing

Processing watermark file after a new watermark has been created using /accounts/watermarks/create call and the watermark file was successfully uploaded.
Processing of the initial watermark file upload has failed and re-upload was initiated using /accounts/watermarks/update call and the watermark file is successfully uploaded.

updating: Waiting for or processing watermark file after /accounts/watermarks/update call.

ready

Initial watermark file has been successfully processed.
Watermark file re-upload has been successfully processed.
Watermark file re-upload has failed.

failed: Failed to process watermark file after /accounts/watermarks/create call.

//watermark/error : string: Not empty if processing of the initial or re-uploaded watermark has failed.

//watermark/error/message : string

Error message.

When //watermark/status is failed, error message corresponds to the initially uploaded watermark file, or to the last re-uploaded watermark file (if initial upload also has failed).
When //watermark/status is ready, error message corresponds to the last re-uploaded watermark file.

//watermark/upload_link : string

Upload URL split in parts.

Included in response only when watermark status is created or updating.

//watermark/upload_link/protocol : string: Protocol part of the upload URL.

//watermark/upload_link/address : string: Address part of the upload URL.

//watermark/upload_link/path : string: Path part of the upload URL.

//watermark/upload_link/query/key : string: Upload key query parameter.

//watermark/upload_link/query/token : string: Upload token query parameter.

previous page | Reference Overview |next page