BoxBrownie.com API v2.0 Docs

Overview

Floor Plan jobs allow you to submit images of builder's floor plans, or even rough sketches of floor plans, and have them converted into readable, presentable versions for use in your real estate listings.

Create a Floor Plan Job

POST /api/v2/job/createFloorPlan

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

To create a Floor Plan job, we require you to send us an XML payload that contains a job title and one or more <fileGroup> blocks that describe the file URL of the image to be edited, and any desired options. You will also need to provide either a <standardTemplate> value or an <agencyTemplate> value.

Your job XML should start with a job title.

<jobTitle>	String	Required	Max 1 Occurence	The title for the job. 100 characters max

Then, for each primary image that you want to include for editing, your XML should include an occurence of <fileGroup>. A file group will contain all the information for the edit that is being performed. Your XML may contain any number of <fileGroup> elements.

<fileGroup>		Required	Multiple Allowed	Represents one output. Contains XML for any images (primary and reference images) and any edit options for the output
<fileGroupComment>	String	Optional	Max 1 Occurence	An optional comment containing any special instructions for the file group

Within the <fileGroup> element, you will need to specify the file URL of the image that is going to be edited. You can specify more than one file URL if desired. The first file URL in each <files> block is treated as the primary image (the one that will be edited). Any subsequent <fileURL> elements will be treated as reference images for the edit. You may include any number of <fileURL> elements, just keep in mind that only the first in each file group will be edited.

<files>		Required	Max 1 Occurence	Contains one or more `<fileURL>` elements for the file group
<fileURL>	String	Required	Multiple Allowed	A file URL. The first occurence of `<fileURL>` in each `<files>` block is treated as the primary image for the file group (the one that will be edited). Subsequent `<fileURL>` elements are treated as reference images only and will not be edited

Within the <fileGroup> element, you may optionally provide a <sampleImages> block that contains one or more <sampleImageId> elements. This can be used to attach pre-uploaded sample images from your BoxBrownie.com account as additional reference images in the job. For more information, see the Sample Images documentation.

<sampleImages>		Optional	Max 1 Occurence	Contains one or more `<sampleImageId>` elements for the file group
<sampleImageId>	String	Required	Multiple Allowed	The unique ID of a sample image from your BoxBrownie.com account.

Within the <fileGroup> element, you will need to define a <template> block that contains either a <standardTemplate> value or an <agencyTemplate> value. Each <fileGroup> may only contain one of these. The chosen template will determine what options are required/supported in the <options> block. Please see the section below for more information on which template values are valid.

<template>	String	Required	Max 1 Occurence	Contains either a `<standardTemplate>` or `<agencyTemplate>`
<standardTemplate>	String	Optional	Max 1 Occurence	Contains a template identifier for a standard BoxBrownie.com template
<agencyTemplate>	String	Optional	Max 1 Occurence	Contains a template identifier for an agency-specific template

Within the <fileGroup> element, you will need to specify an <options> block that contains sets of <option> blocks. Each <option> block must contain an <optionName> element and an <optionValue> block defining the floor plan options that are to be applied.

<options>		Required	Max 1 Occurence	Contains one or more `<option>` elements for the file group
<option>		Required	Multiple Allowed	Contains exactly one `<optionName>` and one `<optionValue>`.
<optionName>	String	Required	Max 1 Occurrence	The key of a Floor Plan Option
<optionValue>	String	Required	Max 1 Occurrence	The key of a Floor Plan Option Value

Example XML

Below, you can see an example XML payload. This example defines 2 <fileGroup> elements, one using a standard template and the other using an agency template. If this were a real job, you could expect to receive 2 completed output floor plans when completed.

<job>
    <jobTitle>My Floor Plan</jobTitle>
    <fileGroup>
        <files>
            <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured02.png</fileURL>
            <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured06.png</fileURL>
        </files>
        <sampleImages>
            <sampleImageId>99ccd87633acb90545c7ebcf4f57511df8d50a33</sampleImageId>
            <sampleImageId>d9c2ca823cf01a54df60f190da405151eab3c700</sampleImageId>
        </sampleImages>
        <template>
            <standardTemplate>FLOOR_PLAN_2D_BLACK_WHITE</standardTemplate>
        </template>
        <options>
            <option>
                <optionName>2D_BLACK_WHITE_FLOOR_PLAN</optionName>
                <optionValue>RESIDENTIAL_2D_BLACK_WHITE_TEXTURED</optionValue>
            </option>
            <option>
                <optionName>PAGE_ORIENTATION</optionName>
                <optionValue>ORIENTATION_LANDSCAPE</optionValue>
            </option>
            <option>
                <optionName>PLAN_ORIENTATION</optionName>
                <optionValue>ORIENTATION_PORTRAIT</optionValue>
            </option>
            <option>
                <optionName>FLOOR_PLAN_DIMENSIONS</optionName>
                <optionValue>DIMENSION_SQ_M</optionValue>
            </option>
            <option>
                <optionName>FILE_TYPE</optionName>
                <optionValue>FILE_TYPE_PDF</optionValue>
            </option>
            <option>
                <optionName>INCLUDE_FURNITURE</optionName>
                <optionValue>OPTION_NO</optionValue>
            </option>
            <option>
                <optionName>INCLUDE_AGENCY_LOGO</optionName>
                <optionValue>OPTION_YES</optionValue>
            </option>
            <option>
                <optionName>DISPLAY_NORTH</optionName>
                <optionValue>AS_MARKED_ON_PLAN</optionValue>
            </option>
            <option>
                <optionName>DISCLAIMER_ACCURACY_MEASUREMENT</optionName>
                <optionValue>OPTION_YES</optionValue>
            </option>
            <option>
                <optionName>DISPLAY_ADDRESS</optionName>
                <optionValue>123 Fake St, Mooloolaba QLD 4558</optionValue>
            </option>
        </options>
        <fileGroupComment>Here is a comment on this floor plan</fileGroupComment>
    </fileGroup>
    <fileGroup>
        <files>
            <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured03.png</fileURL>
            <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured04.png</fileURL>
        </files>
        <template>
            <agencyTemplate>e94df43dc9ef755b1a3f6ba50f825fa92ec2cccf</agencyTemplate>
        </template>
        <options>
            <option>
                <optionName>PAGE_ORIENTATION</optionName>
                <optionValue>ORIENTATION_LANDSCAPE</optionValue>
            </option>
            <option>
                <optionName>PLAN_ORIENTATION</optionName>
                <optionValue>ORIENTATION_PORTRAIT</optionValue>
            </option>
            <option>
                <optionName>FLOOR_PLAN_DIMENSIONS</optionName>
                <optionValue>DIMENSION_SQ_M</optionValue>
            </option>
            <option>
                <optionName>FILE_TYPE</optionName>
                <optionValue>FILE_TYPE_PDF</optionValue>
            </option>
            <option>
                <optionName>INCLUDE_FURNITURE</optionName>
                <optionValue>OPTION_NO</optionValue>
            </option>
            <option>
                <optionName>DISPLAY_NORTH</optionName>
                <optionValue>AS_MARKED_ON_PLAN</optionValue>
            </option>
            <option>
                <optionName>DISCLAIMER_ACCURACY_MEASUREMENT</optionName>
                <optionValue>OPTION_YES</optionValue>
            </option>
            <option>
                <optionName>DISPLAY_ADDRESS</optionName>
                <optionValue>123 Fake St, Mooloolaba QLD 4558</optionValue>
            </option>
        </options>
        <fileGroupComment>Here is a comment on this agency templated floor plan</fileGroupComment>
    </fileGroup>
</job>

Example Response

Below, you can see an example response for the above example API Request.

{
  "success": "1",
  "job": {
    "jobId": "130fe17ee35d8e0444d18aeed9265555ede53050",
    "jobTitle": "My Floor Plan",
    "jobReference": "J888492240117",
    "jobStatus": "Pending",
    "jobDateSubmitted": "2024-03-19 15:11:34",
    "jobCost": "60.00",
    "jobCostCurrency": "AUD"
  }
}

<?xml version="1.0"?>
<response>
    <success>1</success>
    <job>
        <jobId>130fe17ee35d8e0444d18aeed9265555ede53050</jobId>
        <jobTitle>My Floor Plan</jobTitle>
        <jobReference>J888492240117</jobReference>
        <jobStatus>Pending</jobStatus>
        <jobDateSubmitted>2024-03-19 15:11:34</jobDateSubmitted>
        <jobCost>60.00</jobCost>
        <jobCostCurrency>AUD</jobCostCurrency>
    </job>
</response>

Simulate a Floor Plan Job

POST /api/v2/job/simulateFloorPlan

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

The BoxBrownie.com API allows you to simulate the creation of a Floor Plan job in order to check for any errors in the XML payload of a job submission by using this endpoint. Additionally, this endpoint will return the expected job credit cost for the XML payload.

This endpoint accepts the same XML that you would use with the Create a Floor Plan Job endpoint.

Note: Using this endpoint will not create any jobs in your account, and will not charge your BoxBrownie.com account.

Note: Estimated credit cost does not take into account any free trials associated with your BoxBrownie.com account.

Example Response

Below, you can see an example response when supplying job XML to this endpoint.

{
  "success": "1",
  "jobCost": "60.00",
  "jobCostCurrency": "AUD",
  "xmlIsValid": "1"
}

<?xml version="1.0"?>
<response>
    <success>1</success>
    <jobCost>60.00</jobCost>
    <jobCostCurrency>AUD</jobCostCurrency>
    <xmlIsValid>1</xmlIsValid>
</response>

Retrieve a Floor Plan Job

GET /api/v2/job/{jobReference}

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

You may retrieve details about any job in your BoxBrownie.com account by supplying the reference number of the job jobReference.

Example Response

{
  "job": {
    "jobId": "130fe17ee35d8e0444d18aeed9265555ede53050",
    "jobTitle": "My Floor Plan",
    "jobReference": "J888492240117",
    "jobStatus": "Complete",
    "jobDateSubmitted": "2024-03-19 15:11:34",
    "jobCost": "40.00",
    "jobCostCurrency": "AUD",
    "jobDateCompleted": "2024-03-20 12:30:24",
    "output": {
      "file": [
        {
          "fileId": "75eebcbab044b3fe3358392b56d92b8c6fd6d208",
          "fileURL": "https://boxbrownie.b-cdn.net/completed/75eebcbab044b3fe3358392b56d92b8c6fd6d208.jpg"
        },
        {
          "fileId": "f157e4f01b39190b03114f22590b5f49269e527b",
          "fileURL": "https://boxbrownie.b-cdn.net/completed/f157e4f01b39190b03114f22590b5f49269e527b.jpg"
        }
      ]
    }
  }
}

<?xml version="1.0"?>
<response>
    <job>
        <jobId>130fe17ee35d8e0444d18aeed9265555ede53050</jobId>
        <jobTitle>My Floor Plan</jobTitle>
        <jobReference>J888492240117</jobReference>
        <jobStatus>Complete</jobStatus>
        <jobDateSubmitted>2024-03-19 15:11:34</jobDateSubmitted>
        <jobCost>40.00</jobCost>
        <jobCostCurrency>AUD</jobCostCurrency>
        <jobDateCompleted>2024-03-20 12:30:24</jobDateCompleted>
        <output>
            <file>
                <fileId>75eebcbab044b3fe3358392b56d92b8c6fd6d208</fileId>
                <fileURL>https://boxbrownie.b-cdn.net/completed/75eebcbab044b3fe3358392b56d92b8c6fd6d208.jpg</fileURL>
            </file>
            <file>
                <fileId>f157e4f01b39190b03114f22590b5f49269e527b</fileId>
                <fileURL>https://boxbrownie.b-cdn.net/completed/f157e4f01b39190b03114f22590b5f49269e527b.jpg</fileURL>
            </file>
        </output>
    </job>
</response>

Rework a Floor Plan Job

POST /api/v2/job/reworkFloorPlan

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

After a Floor Plan job has been completed, you will have the ability to submit rework requests for any number of completed output images. Similarly to creating a new job, you will be required to supply an XML payload describing which images to rework, with instructions about what you want changed.

You must supply either a <jobId> or a <jobReference> and at least one <rework> block that contains both one <fileId> and one <reworkComment>

Images are supplied in the form of a <fileId>, which can be obtained when retrieving a completed job.

Note: Floor Plan jobs can only be reworked if it has been less than 2 months since the jobDateCompleted time, and if there are no existing active reworks for any supplied <fileId> values.

Example XML

Below, you can see an example XML payload. In this example, we are requesting 1 rework for the supplied jobId.

<job>
    <jobId>130fe17ee35d8e0444d18aeed9265555ede53050</jobId>
    <rework>
        <fileId>75eebcbab044b3fe3358392b56d92b8c6fd6d208</fileId>
        <reworkComment>Please add more clouds in the sky</reworkComment>
    </rework>
</job>

Example Response

{
  "success": "1"
}

<?xml version="1.0"?>
<response>
    <success>1</success>
</response>

Standard Templates

GET /api/v2/job/floorPlanStandardTemplate

Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate
Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate/{standardTemplate}
Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate/{standardTemplate}/{optionName}
HTTP Method: GET
Requires Authentication? No
Optional Parameters:
(string) standardTemplate,
(string) optionName,
(string) responseFormat [json|xml]

When creating a new Floor Plan job, you will supply either a <standardTemplate> value or an <agencyTemplate> value, as well as some <option> blocks containing pairs of <optionName> and <optionValue> to tell us how you would like your floor plan to be created.

You can query this endpoint to return a list of all accepted <standardTemplate> values and their accepted floor plan options/values. Alternatively, you can provide the optional standardTemplate parameter to return only information and accepted values for that specific standard template>

Example Response

URLhttps://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate

{
  "standardTemplates": [
    {
      "standardTemplate": "FLOOR_PLAN_2D_BLACK_WHITE",
      "standardTemplateDescription": "Floor Plan Only - 2D Black & White",
      "options": [
        {
          "optionName": "2D_BLACK_WHITE_FLOOR_PLAN",
          "optionDescription": "2D Standard B&W floor plan Option",
          "optionType": "Image Selection",
          "optionRequired": "1",
          "optionValues": [
            {
              "optionValue": "COMMERCIAL_2D_BLACK_WHITE",
              "optionValueDescription": "Commercial - 2D Standard B&W floor plan"
            },
            {
              "optionValue": "COMMERCIAL_2D_BLACK_WHITE_TEXTURED",
              "optionValueDescription": "Commercial - 2D Standard B&W textured floor plan"
            },
            ...
          ]
        },
        ...
      ]
    },
    ...
  ]
}

URLhttps://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate?responseFormat=xml

<?xml version="1.0"?>
<response>
    <standardTemplates>
        <standardTemplate>FLOOR_PLAN_2D_BLACK_WHITE</standardTemplate>
        <standardTemplateDescription>Floor Plan Only - 2D Black &amp; White</standardTemplateDescription>
        <options>
            <optionName>2D_BLACK_WHITE_FLOOR_PLAN</optionName>
            <optionDescription>2D Standard B&amp;W floor plan Option</optionDescription>
            <optionType>Image Selection</optionType>
            <optionRequired>1</optionRequired>
            <optionValues>
                <optionValue>COMMERCIAL_2D_BLACK_WHITE</optionValue>
                <optionValueDescription>Commercial - 2D Standard B&amp;W floor plan</optionValueDescription>
            </optionValues>
            <optionValues>
                <optionValue>COMMERCIAL_2D_BLACK_WHITE_TEXTURED</optionValue>
                <optionValueDescription>Commercial - 2D Standard B&amp;W textured floor plan</optionValueDescription>
            </optionValues>
            ...
        </options>
        ...
    </standardTemplates>
    ...
</response>

URLhttps://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate/FLOOR_PLAN_2D_BLACK_WHITE

{
  "standardTemplate": "FLOOR_PLAN_2D_BLACK_WHITE",
  "standardTemplateDescription": "Floor Plan Only - 2D Black & White",
  "options": [
    {
      "optionName": "2D_BLACK_WHITE_FLOOR_PLAN",
      "optionDescription": "2D Standard B&W floor plan Option",
      "optionType": "Image Selection",
      "optionRequired": "1",
      "optionValues": [
        {
          "optionValue": "COMMERCIAL_2D_BLACK_WHITE",
          "optionValueDescription": "Commercial - 2D Standard B&W floor plan"
        },
        {
          "optionValue": "COMMERCIAL_2D_BLACK_WHITE_TEXTURED",
          "optionValueDescription": "Commercial - 2D Standard B&W textured floor plan"
        },
        ...
      ]
    },
    ...
  ]
}

URLhttps://www.boxbrownie.com/api/v2/job/floorPlanStandardTemplate/FLOOR_PLAN_2D_BLACK_WHITE?responseFormat=xml

<?xml version="1.0"?>
<response>
    <standardTemplate>FLOOR_PLAN_2D_BLACK_WHITE</standardTemplate>
    <standardTemplateDescription>Floor Plan Only - 2D Black &amp; White</standardTemplateDescription>
    <options>
        <optionName>2D_BLACK_WHITE_FLOOR_PLAN</optionName>
        <optionDescription>2D Standard B&amp;W floor plan Option</optionDescription>
        <optionType>Image Selection</optionType>
        <optionRequired>1</optionRequired>
        <optionValues>
            <optionValue>COMMERCIAL_2D_BLACK_WHITE</optionValue>
            <optionValueDescription>Commercial - 2D Standard B&amp;W floor plan</optionValueDescription>
        </optionValues>
        <optionValues>
            <optionValue>COMMERCIAL_2D_BLACK_WHITE_TEXTURED</optionValue>
            <optionValueDescription>Commercial - 2D Standard B&amp;W textured floor plan</optionValueDescription>
        </optionValues>
        ...
    </options>
    ...
</response>

Accepted Standard Templates

Below is a table of accepted <standardTemplate> keys. Click on a <standardTemplate> to see a table of accepted <optionName> keys for that item.

Note: If an edit type is not clickable in the below table, then it does not have any child options, so an <options> block is not required for that edit type.

Template Key	Template Description
FLOOR_PLAN_2D_BLACK_WHITE	Floor Plan Only - 2D Black & White
FLOOR_PLAN_2D_COLOUR	Floor Plan Only - 2D Full Colour
FLOOR_PLAN_2D_COLOUR_TEXTURED	Floor Plan Only - 2D Colour Textured
FLOOR_PLAN_3D_COLOUR_ONE_STOREY	Floor Plan Only - 3D Full Colour - Single Storey
FLOOR_PLAN_3D_COLOUR_TWO_STOREY	Floor Plan Only - 3D Full Colour - Two Storeys
FLOOR_PLAN_3D_COLOUR_THREE_STOREY	Floor Plan Only - 3D Full Colour - Three Storeys
COMBO_2D_BLACK_WHITE	Floor & Site Plan Combo - 2D Black & White
COMBO_2D_COLOUR	Floor & Site Plan Combo - 2D Full Colour
COMBO_2D_COLOUR_TEXTURED	Site & Floor Plan Combo - 2D Textured
FLOOR_PLAN_3D_TAILORED_ONE_STOREY	Floor Plan Only - 3D Tailored - Single Storey
FLOOR_PLAN_3D_TAILORED_TWO_STOREY	Floor Plan Only - 3D Tailored - Two Storeys

Agency Templates

GET /api/v2/job/floorPlanAgencyTemplate/{agencyId}

Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/{agencyId}
Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/{agencyId}/{agencyTemplate}
Endpoint: https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/{agencyId}/{agencyTemplate}/{optionName}
HTTP Method: GET
Requires Authentication? No
Required Parameters:(string) agencyId
Optional Parameters:
(string) agencyTemplate,
(string) optionName,
(string) responseFormat [json|xml]

When creating a new Floor Plan job, you will supply either a <standardTemplate> value or an <agencyTemplate> value, as well as some <option> blocks containing pairs of <optionName> and <optionValue> to tell us how you would like your floor plan to be created.

You can query this endpoint to return a list of all accepted <agencyTemplate> values and their accepted floor plan options/values, for a given <agencyId>.

Note: View the Agency Documentation for information on how to obtain <agencyId> values.

Example Response

URLhttps://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/1a5009d8b07d82c1228d12f6aaf3c296e5816f58

{
  "agencyId": "1a5009d8b07d82c1228d12f6aaf3c296e5816f58",
  "agencyTitle": "Example Agency",
  "agencyTemplates": [
    {
      "agencyTemplate": "e94df43dc9ef755b1a3f6ba50f825fa92ec2cccf",
      "agencyTemplateDescription": "Floor Plan Only - 2D Black & White",
      "options": [
        {
          "optionName": "FILE_TYPE",
          "optionDescription": "Output File Type",
          "optionType": "Multiple Choice",
          "optionRequired": "1",
          "optionValues": [
            {
              "optionValue": "FILE_TYPE_JPG",
              "optionValueDescription": ".jpg - Best all round file if unsure what to pick"
            },
            {
              "optionValue": "FILE_TYPE_PDF",
              "optionValueDescription": ".pdf"
            },
            ...
          ]
        },
        ...
      ]
    },
    ...
  ]
}

URL

https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/1a5009d8b07d82c1228d12f6aaf3c296e5816f58?responseFormat=xml

<?xml version="1.0"?>
<response>
    <agencyId>1a5009d8b07d82c1228d12f6aaf3c296e5816f58</agencyId>
    <agencyTitle>Example Agency</agencyTitle>
    <agencyTemplates>
        <agencyTemplate>e94df43dc9ef755b1a3f6ba50f825fa92ec2cccf</agencyTemplate>
        <agencyTemplateDescription>Floor Plan Only - 2D Black &amp;amp; White</agencyTemplateDescription>
        <options>
            <optionName>FILE_TYPE</optionName>
            <optionDescription>Output File Type</optionDescription>
            <optionType>Multiple Choice</optionType>
            <optionRequired>1</optionRequired>
            <optionValues>
                <optionValue>FILE_TYPE_JPG</optionValue>
                <optionValueDescription>.jpg - Best all round file if unsure what to pick</optionValueDescription>
            </optionValues>
            <optionValues>
                <optionValue>FILE_TYPE_PDF</optionValue>
                <optionValueDescription>.pdf</optionValueDescription>
            </optionValues>
            ...
        </options>
        ...
    </agencyTemplates>
    ...
</response>

URL

https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/1a5009d8b07d82c1228d12f6aaf3c296e5816f58/f391ff916340076fb4405663b8086be1310cf562

{
  "agencyId": "3a5009d8b07d82c1228d12f6aaf3c296e5816f58",
  "agencyTitle": "@Realty",
  "agencyTemplate": "f391ff916340076fb4405663b8086be1310cf562",
  "agencyTemplateDescription": "Floor Plan Only - 2D Full Colour",
  "options": [
    {
      "optionName": "FILE_TYPE",
      "optionDescription": "Output File Type",
      "optionType": "Multiple Choice",
      "optionRequired": "1",
      "optionValues": [
        {
          "optionValue": "FILE_TYPE_JPG",
          "optionValueDescription": ".jpg - Best all round file if unsure what to pick"
        },
        {
          "optionValue": "FILE_TYPE_PDF",
          "optionValueDescription": ".pdf"
        },
        ...
      ]
    },
    ...
  ]
}

URL

https://www.boxbrownie.com/api/v2/job/floorPlanAgencyTemplate/1a5009d8b07d82c1228d12f6aaf3c296e5816f58/f391ff916340076fb4405663b8086be1310cf562?responseFormat=xml

<?xml version="1.0"?>
<response>
    <agencyId>3a5009d8b07d82c1228d12f6aaf3c296e5816f58</agencyId>
    <agencyTitle>@Realty</agencyTitle>
    <agencyTemplate>f391ff916340076fb4405663b8086be1310cf562</agencyTemplate>
    <agencyTemplateDescription>Floor Plan Only - 2D Full Colour</agencyTemplateDescription>
    <options>
        <optionName>FILE_TYPE</optionName>
        <optionDescription>Output File Type</optionDescription>
        <optionType>Multiple Choice</optionType>
        <optionRequired>1</optionRequired>
        <optionValues>
            <optionValue>FILE_TYPE_JPG</optionValue>
            <optionValueDescription>.jpg - Best all round file if unsure what to pick</optionValueDescription>
        </optionValues>
        <optionValues>
            <optionValue>FILE_TYPE_PDF</optionValue>
            <optionValueDescription>.pdf</optionValueDescription>
        </optionValues>
        ...
    </options>
    ...
</response>

Topics

Floor Plans

Overview

Create a Floor Plan Job

Example XML

Example Response

Simulate a Floor Plan Job

Example Response

Retrieve a Floor Plan Job

Example Response

Rework a Floor Plan Job

Example XML

Example Response

Standard Templates

Example Response

Accepted Standard Templates

Agency Templates

Example Response