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

Brand

{
  "title": "Brand",
  "required": ["name", "lastModified", "created", "deleted"],
  "properties": {
    "name": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "available": {
      "type": "boolean"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "hoses": {
      "type": "boolean"
    },
    "adaptors": {
      "type": "boolean"
    },
    "wraps": {
      "type": "boolean"
    },
    "otherItems": {
      "type": "boolean"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "deletedBy": {
      "type": "string"
    },
    "_id": {
      "type": "string"
    }
  }
}

Brand

Properties

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