com.revinate.ship.schemata.common-definitions.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ship-java Show documentation
SHIP Java Bindings
The newest version!
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Definitions for objects used in multiple SHIP message types.",
  "definitions": {
    "timeSpan": {
      "description": "A time period with a start time",
      "type": "object",
      "required": [
        "startTime",
        "timeUnits",
        "timeUnitType"
      ],
      "properties": {
        "startTime": {
          "description": "Start time",
          "type": "string",
          "format": "date-time"
        },
        "timeUnits": {
          "description": "Number of time units",
          "type": "integer"
        },
        "timeUnitType": {
          "description": "Type of the time units",
          "type": "string",
          "enum": ["DAY", "HOUR", "MINUTE"]
        }
      },
      "additionalProperties": false
    },
    "monetaryValue": {
      "description": "A monetary value consisting of a number and a currency",
      "type": "object",
      "required": [
        "value"
      ],
      "properties": {
        "value": {
          "description": "Number of units of the currency",
          "type": "number"
        },
        "currency": {
          "description": "ISO4217 3-character currency code",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "monetaryAmount": {
      "description": "An amount of money with associated tax",
      "type": "object",
      "properties": {
        "amountBeforeTax": {
          "description": "Amount before tax",
          "$ref": "#/definitions/monetaryValue"
        },
        "taxAmount": {
          "description": "Tax amount",
          "$ref": "#/definitions/monetaryValue"
        },
        "value": {
          "description": "Number of units of the currency of the pre-tax amount",
          "type": "number"
        },
        "currency": {
          "description": "ISO4217 3-character currency code of the pre-tax amount",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "companyInfo": {
      "description": "A minimal set of information about a company",
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "description": "Name of the company",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "guestNote": {
      "description": "A note",
      "type": "object",
      "required": [
        "text"
      ],
      "properties": {
        "title": {
          "description": "Note title",
          "type": "string"
        },
        "text": {
          "description": "Note text",
          "type": "string"
        },
        "type": {
          "description": "Note type",
          "type": "string"
        },
        "time": {
          "description": "Time the note was created/updated",
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "userDefinedField": {
      "description": "A name-value pair defined by a specific system or application",
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "description": "Field name. If two fields have the same name, their values form an unordered list.",
          "type": "string"
        },
        "value": {
          "description": "Field value",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "summary": {
      "description": "Summary of the SHIP objects list result",
      "type": "object",
      "required": [
        "successCount",
        "errorCount",
        "totalCount"
      ],
      "properties": {
        "successCount": {
          "description": "Number of SHIP objects successfully processed",
          "type": "integer"
        },
        "errorCount": {
          "description": "Number of SHIP objects that failed to process",
          "type": "integer"
        },
        "totalCount": {
          "description": "Total number of SHIP objects processed",
          "type": "integer"
        }
      },
      "additionalProperties": false
    }
  }
}