Read Assets and Equipment servicing settings

GET

/business-settings

const url = 'https://example.com/business-settings';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/business-settings \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Whether Assets and Equipment servicing are switched on, and where each stands for this business: hidden, locked behind a bigger plan, off or on.

Authorizations

sessionCookie
tenant:read

Responses

200

The settings

application/json

object

settings

required

object

assetsEnabled

required

Whether products can be tracked one cylinder at a time. On unless the business switches it off. Nothing changes on screen until a product is tracked.

boolean

assetScanningEnabled

required

Whether drivers and yard staff can record cylinders with the phone’s camera. Set by Bottle once the business’s cylinders have been tested.

boolean

servicingEnabled

required

Whether the business keeps service dates for the equipment its customers have. Off unless switched on.

boolean

assets

required

Hidden: not available to this business. locked: needs a bigger plan. off: available, and switched off. on: in use.

string

Allowed values: hidden locked off on

servicing

required

Hidden: not available to this business. locked: needs a bigger plan. off: available, and switched off. on: in use.

string

Allowed values: hidden locked off on

trackedProducts

required

Array<object>

object

required

string

name

required

string

Example

{
  "assets": "hidden",
  "servicing": "hidden"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not an owner or admin, or the plan does not open this

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not available to this business

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Assets cannot be switched off while products are tracked

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}