Create an Order

Overview

The request payload should include all necessary details about the order, such as the location, assessment types, responsible party information, metadata, and any attachments related to the order. The order may contain multiple assessments and attachments based on the assessment type.

Key Details

Assessments: Each order can have one or more assessments. An assessment must include key information such as the location, asset type, assessment type, and responsible party.
Required Attachment: If the assessment_type is Draw, a SCOPE_OF_WORK attachment is required. This attachment should contain details like budgets, funding, and requested amounts for the work.
Attachments: Attachments are optional but may be included depending on the assessment_type.
- The allowed attachment types are:
  - JSON: Structured data (e.g., scope of work details like budget, funding, and requested amounts).
  - URL: A link to an external resource (such as an image or document related to the assessment).
  - Base64: Encoded binary data, suitable for including files or images directly in the request.
Webhook: Optionally, a webhook URL can be specified to receive real-time notifications for events related to this order. This URL will be triggered when the status of the order changes or updates are available.
Metadata: The metadata field allows for external metadata to be added to the order in the form of key-value pairs. This can be useful for tracking additional information or enabling filtering of orders based on the metadata provided. For example, metadata could include custom identifiers or details that help the customer categorize or track orders.

Allowed Content Types for Attachments:

JSON: Used for structured data (e.g., scope of work details, including budget and requested amounts). Example:

[
    {
        "description": "Plumbing rough-in",
        "budget": 5000,
        "funded": 4000,
        "requested": 1000
    },
    {
        "description": "Roof",
        "budget": 4000,
        "funded": 4000,
        "requested": 0
    }
]

URL: A link to an external resource, such as an image or document related to the assessment.
Base64: Encoded binary data, typically used for including files or images directly within the request.

Please Note: If the assessment_type is Draw, a SCOPE_OF_WORK attachment is required.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

assessments

object[]

required

List of assessments for the order

Hide child attributes

location

string

required

Location of the assessment

Example:

"123 Main St, City, State, 12345"

asset_type_id

string

required

UUID of the asset type

Example:

"dcd4a1f2-cb8d-4bc6-946d-bae706fb1f35"

assessment_type_id

string

required

UUID of the assessment type

Example:

"1d28a3e1-31fa-4e76-bb84-11094bca21a4"

responsible_party

object

required

Responsible party details

Hide child attributes

responsible_party.name

string

required

Name of the responsible party

Example:

"John Doe"

responsible_party.phone

string

required

Phone number of the responsible party

Example:

"+1-234-567-8900"

responsible_party.email

string<email>

Email of the responsible party

Example:

"johndoe@example.com"

camera_holder

object

Camera holder details

Hide child attributes

camera_holder.name

string

required

Name of the camera holder

Example:

"Jane Smith"

camera_holder.phone

string

required

Phone number of the camera holder

Example:

"+1-234-567-8900"

camera_holder.email

string<email>

Email of the camera holder

Example:

"janesmith@example.com"

attachment

object[]

Attachments related to the assessment

Hide child attributes

type

string

required

Type of the attachment, currently only "SCOPE_OF_WORK" is supported

Example:

"SCOPE_OF_WORK"

value

string

required

Base64-encoded attachment value (for images, files), or URL or JSON content based on content_type

Example:

"data:image/png;base64,..."

content_type

string

required

Content type of the attachment . It can be "Base64", "URL", or "JSON"

Example:

"Base64"

filename

string

Filename of the attachment

Example:

"scope_of_work.pdf"

external_id

string

External ID for tracking

Example:

"loan123"

notes

string

Additional notes for the assessment

Example:

"Access information or specific instructions"

noOfUnits

number

Number of units being assessed. Required if the asset type is MFR.

Example:

5

webhook

object

Webhook details

Hide child attributes

webhook.url

string<uri>

required

URL to send the webhook notification

Example:

"https://example.com/webhook"

webhook.trigger

enum<string>

default:any_state_change

Event trigger for the webhook

Available options:

any_state_change,

any_status_change,

in_progress,

done,

canceled

metadata

object

External metadata related to the assessment in key-value pairs, used for tracking additional information or categorizing orders. For example, custom identifiers or details to help filter and categorize orders.

name

string

Name of the order

Example:

"Property inspection"

description

string

Description of the order

Example:

"Description of the property inspection order"

external_id

string

External ID of the order

Example:

"project123"

Response

201 - application/json

Create new order

_links

object

required

Links related to the order

Hide child attributes

_links._assessments

string[]

required

List of links related to the order

Example:

[
  "/v1/orders/IOM-12086",
  "/v1/orders/IOM-12088"
]

Getting Started

Authentication

Orders

Reports

Types

Overview

Key Details

Allowed Content Types for Attachments:

Authorizations

Body

Response

Getting Started

Authentication

Orders

Reports

Types

​Overview

​Key Details

​Allowed Content Types for Attachments:

Authorizations

Body

Response

Overview

Key Details

Allowed Content Types for Attachments: