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

Hose

{
  "title": "Hose",
  "required": ["partNumber", "brand", "size", "lastModified", "created"],
  "properties": {
    "partNumber": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "size": {
      "type": "string"
    },
    "nominalHoseSize": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "maxPressurePsi": {
      "type": "number"
    },
    "colourHose": {
      "type": "string"
    },
    "colourLayLine": {
      "type": "string"
    },
    "colourLayLineText": {
      "type": "string"
    },
    "imageName": {
      "type": "string"
    },
    "series": {
      "type": "string"
    },
    "outerDiamInch": {
      "type": "number"
    },
    "innerDiamInch": {
      "type": "string"
    },
    "reinforcementDiamInch": {
      "type": "number"
    },
    "minBendRadiusInch": {
      "type": "number"
    },
    "WeightLbs": {
      "type": "number"
    },
    "burstPressurePsi": {
      "type": "number"
    },
    "spec": {
      "type": "string"
    },
    "saeSpec": {
      "type": "string"
    },
    "isoSpec": {
      "type": "string"
    },
    "enSpec": {
      "type": "string"
    },
    "DN": {
      "type": "string"
    },
    "isoClass": {
      "type": "string"
    },
    "isoGrade": {
      "type": "string"
    },
    "isoType": {
      "type": "string"
    },
    "reinforcement": {
      "type": "string"
    },
    "construction": {
      "type": "string"
    },
    "colour": {
      "type": "string"
    },
    "temperatureRange": {
      "type": "string"
    },
    "cover": {
      "type": "string"
    },
    "tube": {
      "type": "string"
    },
    "standardLength": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recommendedCouplingSeries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "generalApplications": {
      "type": "string"
    },
    "impulseCycles": {
      "type": "string"
    },
    "minTemp": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "maxTemp": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "maxTempAir": {
      "type": "string"
    },
    "type": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "material": {
      "type": "string"
    },
    "hoseType": {
      "type": "string"
    },
    "hoseSubType": {
      "type": "string"
    },
    "twin": {
      "type": "boolean"
    },
    "nonConductive": {
      "type": "boolean"
    },
    "crimpSpecs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "couplingSeries": {
            "type": "string"
          },
          "couplingSeriesBrand": {
            "type": "string"
          },
          "ferruleBrand": {
            "type": "string"
          },
          "dieSize": {
            "type": "string"
          },
          "spacerRing": {
            "type": "string"
          },
          "insertLength": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              }
            }
          },
          "crimpDiam": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              },
              "tolerancePlus": {
                "type": "number"
              },
              "toleranceMinus": {
                "type": "number"
              }
            }
          },
          "crimpStretchPerEnd": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              }
            }
          },
          "ferrulePartNumber": {
            "type": "string"
          },
          "skiveExternal": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              }
            }
          },
          "skiveInternal": {
            "type": "object",
            "properties": {
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string"
              },
              "tolerance": {
                "type": "number"
              }
            }
          },
          "interlock": {
            "type": "boolean"
          }
        },
        "required": ["couplingSeries"]
      }
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "_id": {
      "type": "string"
    }
  }
}

Hose

Properties

Name	Type	Required	Restrictions	Description
partNumber	string	true	none	none
brand	string	true	none	none
size	string	true	none	none
nominalHoseSize	string	false	none	none
description	string	false	none	none
maxPressurePsi	number	false	none	none
colourHose	string	false	none	none
colourLayLine	string	false	none	none
colourLayLineText	string	false	none	none
imageName	string	false	none	none
series	string	false	none	none
outerDiamInch	number	false	none	none
innerDiamInch	string	false	none	none
reinforcementDiamInch	number	false	none	none
minBendRadiusInch	number	false	none	none
WeightLbs	number	false	none	none
burstPressurePsi	number	false	none	none
spec	string	false	none	none
saeSpec	string	false	none	none
isoSpec	string	false	none	none
enSpec	string	false	none	none
DN	string	false	none	none
isoClass	string	false	none	none
isoGrade	string	false	none	none
isoType	string	false	none	none
reinforcement	string	false	none	none
construction	string	false	none	none
colour	string	false	none	none
temperatureRange	string	false	none	none
cover	string	false	none	none
tube	string	false	none	none
standardLength	[string]	false	none	none
recommendedCouplingSeries	[string]	false	none	none
generalApplications	string	false	none	none
impulseCycles	string	false	none	none
minTemp	[string]	false	none	none
maxTemp	[string]	false	none	none
maxTempAir	string	false	none	none
type	[string]	false	none	none
material	string	false	none	none
hoseType	string	false	none	none
hoseSubType	string	false	none	none
twin	boolean	false	none	none
nonConductive	boolean	false	none	none
crimpSpecs	[object]	false	none	none
» couplingSeries	string	true	none	none
» couplingSeriesBrand	string	false	none	none
» ferruleBrand	string	false	none	none
» dieSize	string	false	none	none
» spacerRing	string	false	none	none
» insertLength	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
» crimpDiam	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
»» tolerancePlus	number	false	none	none
»» toleranceMinus	number	false	none	none
» crimpStretchPerEnd	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
» ferrulePartNumber	string	false	none	none
» skiveExternal	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
» skiveInternal	object	false	none	none
»» value	number	false	none	none
»» unit	string	false	none	none
»» tolerance	number	false	none	none
» interlock	boolean	false	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
createdBy	string	false	none	none
lastModifiedBy	string	false	none	none
recordSource	string	false	none	none
_id	string	false	none	none