ENencircleapp
Equipment

Create an organization Dehumidifier

Changed on
post/v1/dehumidifiers

Request

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

organization_idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

supported_dehumidifier_idinteger required

'SupportedDehumidifier' ID

serial_numberstring nullable

'Dehumidifier''s manufacturer unique serial number.

This value would be formatted to remove leading and trailing whitespace. Empty strings or strings containing only whitespace would be treated as 'null'.

is_rentalboolean required

Whether or not the 'Dehumidifier' is a rental

asset_identifierstring required

'Dehumidifier' asset identifier

Example request

{
  "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}

Response

The 'Dehumidifier' was created successfully.

idinteger required

The 'id' of the 'Dehumidifier'

id_v2string uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

organization_idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

supported_dehumidifier_idinteger required

'SupportedDehumidifier' ID

manufacturerstring required

'Dehumidifier' manufacturer

modelstring required

'Dehumidifier' model

serial_numberstring nullable required

'Dehumidifier''s manufacturer unique serial number.

This value would be formatted to remove leading and trailing whitespace. Empty strings or strings containing only whitespace would be treated as 'null'.

is_rentalboolean required

Whether or not the 'Dehumidifier' is a rental

asset_identifierstring required

'Dehumidifier' asset identifier

status'available' | 'active' | 'retired' required

Dehumidifier status

property_claim_idinteger nullable required

Id of the claim the dehumidifier is currently working on (if applicable.)

Example response

{
  "id_v2": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}

Changes

  • 2ed23bd529dcRevision changes
    • warning

      added the new outpostsyncerror enum value to the response property for the response status

    • warning

      added the new outpostsyncerror enum value to the response property for the response status

    • warning

      added the new outpostsyncerror enum value to the response property for the response status