Topics

Sample Images

Overview

Sample images are pre-uploaded reference images that are stored in your BoxBrownie.com account. These images can be attached alongside most job submissions. This is useful if you re-use the same reference images across multiple jobs. Using the API, you can retrieve data about the sample images attached to your BoxBrownie account.

Retrieve Sample Images

GET /api/v2/account/getSampleImages

Endpoint: https://www.boxbrownie.com/api/v2/account/getSampleImages
HTTP Method: GET
Requires Authentication? Yes
Required Parameters:
Optional Parameters:(string) responseFormat [json|xml]

You may retrieve a list of the sample images attached to your BoxBrownie.com account using this endpoint. Each sample image has a unique sampleImageId identifier which can be used when creating new jobs via the API in order to attach it as a reference image.

Example Response

URLhttps://www.boxbrownie.com/api/v2/account/getSampleImages

{
  "sampleImages": [
    {
      "sampleImageId": "99ccd87633acb90545c7ebcf4f57511df8d50a33",
      "sampleImageFileName": "agencyLogo.jpg",
      "sampleImageURL": "https://boxbrownie-media.b-cdn.net/customer-samples/99ccd87633acb90545c7ebcf4f57511df8d50a33.jpg",
      "sampleImageDescription": "Our agency logo"
    },
    {
      "sampleImageId": "d9c2ca823cf01a54df60f190da405151eab3c700",
      "sampleImageFileName": "site-plan-style-example.png",
      "sampleImageURL": "https://boxbrownie-media.b-cdn.net/customer-samples/d9c2ca823cf01a54df60f190da405151eab3c700.png",
      "sampleImageDescription": "Styling example for site plans"
    },
    ...
  ]
}

URLhttps://www.boxbrownie.com/api/v2/account/getSampleImages?responseFormat=xml

<?xml version="1.0"?>
<response>
    <sampleImages>
        <sampleImageId>99ccd87633acb90545c7ebcf4f57511df8d50a33</sampleImageId>
        <sampleImageFileName>agencyLogo.jpg</sampleImageFileName>
        <sampleImageURL>https://boxbrownie-media.b-cdn.net/customer-samples/99ccd87633acb90545c7ebcf4f57511df8d50a33.jpg</sampleImageURL>
        <sampleImageDescription>Our agency logo</sampleImageDescription>
    </sampleImages>
    <sampleImages>
        <sampleImageId>d9c2ca823cf01a54df60f190da405151eab3c700</sampleImageId>
        <sampleImageFileName>site-plan-style-example.png</sampleImageFileName>
        <sampleImageURL>https://boxbrownie-media.b-cdn.net/customer-samples/d9c2ca823cf01a54df60f190da405151eab3c700.png</sampleImageURL>
        <sampleImageDescription>Styling example for site plans</sampleImageDescription>
    </sampleImages>
    ...
</response>