Schema Reference API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://goldleaf.app/api/v1

Schemas

BrandProperties

{
  "title": "BrandProperties",
  "required": ["_id", "brand", "name", "lastModified", "created", "deleted"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "deleted": {
      "type": "boolean"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "deletedBy": {
      "type": "string"
    },
    "imageName": {
      "type": "string"
    },
    "available": {
      "type": "boolean"
    },
    "hoses": {
      "type": "boolean"
    },
    "usersCanConfigureHoses": {
      "type": "boolean"
    },
    "customersCanConfigureHoses": {
      "type": "boolean"
    },
    "adaptors": {
      "type": "boolean"
    },
    "wraps": {
      "type": "boolean"
    },
    "otherItems": {
      "type": "boolean"
    }
  }
}

BrandProperties

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
brand	string	true	none	none
name	string	true	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
deleted	boolean	true	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
deletedBy	string	false	none	none
imageName	string	false	none	none
available	boolean	false	none	none
hoses	boolean	false	none	none
usersCanConfigureHoses	boolean	false	none	none
customersCanConfigureHoses	boolean	false	none	none
adaptors	boolean	false	none	none
wraps	boolean	false	none	none
otherItems	boolean	false	none	none