.cdm-java.6.0.0-dev.63.source-code.cdm-event-position-AvailableInventory.schema.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation

There is a newer version: 6.0.0-dev.89

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$anchor": "cdm.event.position",
  "type": "object",
  "title": "AvailableInventory",
  "description": "A data type that can be used to describe the inventory of securities that a party holds. The securities are held in the AvailableInventoryRecord, with each item in the array being an individual security and its associated criteria. Criteria can include the quantity available, the rate at which the security is available to borrow at, as well as other details that can affect the decision as to whether a party wants to utilise the securities listed.",
  "properties": {
    "availableInventoryType": {
      "description": "Defines the purpose of this inventory.",
      "$ref": "cdm-event-position-AvailableInventoryTypeEnum.schema.json"
    },
    "messageInformation": {
      "description": "Allows details related to the availability messaging use case to be defined",
      "$ref": "cdm-event-workflow-MessageInformation.schema.json"
    },
    "party": {
      "description": "Defines all parties involved for the list of inventory records in this set of inventory. For example, when used to describe securities lending availability, this could hold the sender of the availability, the intended recipient, the beneficial owner(s), the lender (which may differ from the sender as the lender may have the same piece of availability going through multiple agents), an agent or a venue.",
      "type": "array",
      "items": {
        "$ref": "cdm-base-staticdata-party-Party.schema.json"
      },
      "minItems": 0
    },
    "partyRole": {
      "description": "Defines the role(s) that party(ies) may have in relation to the inventory.",
      "type": "array",
      "items": {
        "$ref": "cdm-base-staticdata-party-PartyRole.schema.json"
      },
      "minItems": 0
    },
    "availableInventoryRecord": {
      "description": "An array holding the list of inventory being described. Each element in the inventoryRecord array represents an individual piece of inventory i.e. a security.",
      "type": "array",
      "items": {
        "$ref": "cdm-event-position-AvailableInventoryRecord.schema.json"
      },
      "minItems": 0
    }
  },
  "required": [
    "availableInventoryType"
  ]
}