org.oasis-open.ubl.schemas.maindoc.UBL-TransportExecutionPlanRequest-2.1.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tradeshift-ubl-jsonschema
UBL is designed to provide a universally understood and recognized commercial syntax for legally binding business documents and to operate within a standard business framework such as ISO 15000 (ebXML) to provide a complete, standards-based infrastructure that can extend the benefits of existing EDI systems to businesses of all sizes. UBL is freely available to everyone without legal encumbrance or licensing fees.
The newest version!
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "json-schema/maindoc/UBL-TransportExecutionPlanRequest-2.1.json",
  "description": "\n  Library:           OASIS Universal Business Language (UBL) 2.1 OS\n                     http://docs.oasis-open.org/ubl/os-UBL-2.1/\n  Release Date:      04 November 2013\n  Module:            json-schema/maindoc/UBL-TransportExecutionPlanRequest-2.1.json\n  Generated on:      2017-01-06 03:20z\n  Copyright (c) OASIS Open 2016. All Rights Reserved.\n\n\n  OASIS takes no position regarding the validity or scope of any \n  intellectual property or other rights that might be claimed to pertain \n  to the implementation or use of the technology described in this \n  document or the extent to which any license under such rights \n  might or might not be available; neither does it represent that it has \n  made any effort to identify any such rights. Information on OASIS's \n  procedures with respect to rights in OASIS specifications can be \n  found at the OASIS website. Copies of claims of rights made \n  available for publication and any assurances of licenses to be made \n  available, or the result of an attempt made to obtain a general \n  license or permission for the use of such proprietary rights by \n  implementors or users of this specification, can be obtained from \n  the OASIS Executive Director.\n\n  OASIS invites any interested party to bring to its attention any \n  copyrights, patents or patent applications, or other proprietary \n  rights which may cover technology that may be required to \n  implement this specification. Please address the information to the \n  OASIS Executive Director.\n  \n  This document and translations of it may be copied and furnished to \n  others, and derivative works that comment on or otherwise explain \n  it or assist in its implementation may be prepared, copied, \n  published and distributed, in whole or in part, without restriction of \n  any kind, provided that the above copyright notice and this \n  paragraph are included on all such copies and derivative works. \n  However, this document itself may not be modified in any way, \n  such as by removing the copyright notice or references to OASIS, \n  except as needed for the purpose of developing OASIS \n  specifications, in which case the procedures for copyrights defined \n  in the OASIS Intellectual Property Rights document must be \n  followed, or as required to translate it into languages other than \n  English. \n\n  The limited permissions granted above are perpetual and will not be \n  revoked by OASIS or its successors or assigns. \n\n  This document and the information contained herein is provided on \n  an \"AS IS\" basis and OASIS DISCLAIMS ALL WARRANTIES, \n  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY \n  WARRANTY THAT THE USE OF THE INFORMATION HEREIN \n  WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED \n  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A \n  PARTICULAR PURPOSE.    \n",
  "required": [
    "TransportExecutionPlanRequest"
    ],
  "properties": {
    "_D": {
      "description": "Document ABIE XML namespace string",
      "type": "string"
      },
    "_S": {
      "description": "Library ABIE XML namespace string (for ASBIEs)",
      "type": "string"
      },
    "_B": {
      "description": "BBIE XML namespace string",
      "type": "string"
      },
    "_E": {
      "description": "Extension scaffolding XML namespace string",
      "type": "string"
      },
    "TransportExecutionPlanRequest": {
      "description": "A document sent by a transport user to request a transport service from a transport service provider.",
      "items": {
        "$ref": "#/definitions/TransportExecutionPlanRequest"
        },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
      }
    },
  "additionalProperties": false,
  "type": "object",
  "definitions": {
    "TransportExecutionPlanRequest": {
      "title": "Transport Execution Plan Request. Details",
      "description": "A document sent by a transport user to request a transport service from a transport service provider.",
      "required": [
        "ID",
        "TransportUserParty",
        "TransportServiceProviderParty",
        "Consignment"
        ],
      "properties": {

        "UBLExtensions": {
          "title": "UBLExtensions",
          "description": "An optional set of extensions to the committee model",
          "items": { 
            "$ref": "../common/UBL-CommonExtensionComponents-2.1.json#/definitions/UBLExtensions" },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },

        "UBLVersionID": {
          "title": "Transport Execution Plan Request. UBL Version Identifier. Identifier",
          "description": "Identifies the earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/UBLVersionID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CustomizationID": {
          "title": "Transport Execution Plan Request. Customization Identifier. Identifier",
          "description": "Identifies a user-defined customization of UBL for a specific use.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CustomizationID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProfileID": {
          "title": "Transport Execution Plan Request. Profile Identifier. Identifier",
          "description": "Identifies a user-defined profile of the customization of UBL being used.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ProfileID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProfileExecutionID": {
          "title": "Transport Execution Plan Request. Profile Execution Identifier. Identifier",
          "description": "Identifies an instance of executing a profile, to associate all transactions in a collaboration.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ProfileExecutionID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ID": {
          "title": "Transport Execution Plan Request. Identifier",
          "description": "An identifier for this document, assigned by the sender.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "VersionID": {
          "title": "Transport Execution Plan Request. Version. Identifier",
          "description": "An identifier for the current version of the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/VersionID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CopyIndicator": {
          "title": "Transport Execution Plan Request. Copy_ Indicator. Indicator",
          "description": "Indicates whether this document is a copy (true) or not (false).",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CopyIndicator"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "UUID": {
          "title": "Transport Execution Plan Request. UUID. Identifier",
          "description": "A universally unique identifier for an instance of this document.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/UUID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "IssueDate": {
          "title": "Transport Execution Plan Request. Issue Date. Date",
          "description": "The date, assigned by the sender, on which this document was issued.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/IssueDate"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "IssueTime": {
          "title": "Transport Execution Plan Request. Issue Time. Time",
          "description": "The time, assigned by the sender, at which this document was issued.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/IssueTime"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DocumentStatusCode": {
          "title": "Transport Execution Plan Request. Document Status Code. Code",
          "description": "A code signifying the status of the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/DocumentStatusCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DocumentStatusReasonCode": {
          "title": "Transport Execution Plan Request. Document Status Reason Code. Code",
          "description": "A code signifying a reason associated with the status of the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/DocumentStatusReasonCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DocumentStatusReasonDescription": {
          "title": "Transport Execution Plan Request. Document Status Reason Description. Text",
          "description": "A reason associated with the status of the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/DocumentStatusReasonDescription"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Note": {
          "title": "Transport Execution Plan Request. Note. Text",
          "description": "Free-form text pertinent to this document, conveying information that is not contained explicitly in other structures.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/Note"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportUserRemarks": {
          "title": "Transport Execution Plan Request. Transport User_ Remarks. Text",
          "description": "Remarks from the transport user regarding the transport operations referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/TransportUserRemarks"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SenderParty": {
          "title": "Transport Execution Plan Request. Sender_ Party. Party",
          "description": "The party sending the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/SenderParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ReceiverParty": {
          "title": "Transport Execution Plan Request. Receiver_ Party. Party",
          "description": "The party receiving the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ReceiverParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportUserParty": {
          "title": "Transport Execution Plan Request. Transport User_ Party. Party",
          "description": "The party requesting the transport services referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportUserParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportServiceProviderParty": {
          "title": "Transport Execution Plan Request. Transport Service Provider_ Party. Party",
          "description": "The party providing the transport services referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportServiceProviderParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PayeeParty": {
          "title": "Transport Execution Plan Request. Payee_ Party. Party",
          "description": "The party that will pay for the transport service(s) referred to in a Transport Execution Plan.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/PayeeParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Signature": {
          "title": "Transport Execution Plan Request. Signature",
          "description": "A signature applied to this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Signature"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportExecutionPlanDocumentReference": {
          "title": "Transport Execution Plan Request. Transport Execution Plan_ Document Reference. Document Reference",
          "description": "A reference to an original Transport Execution Plan Document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportExecutionPlanDocumentReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportServiceDescriptionDocumentReference": {
          "title": "Transport Execution Plan Request. Transport Service Description_ Document Reference. Document Reference",
          "description": "A reference to the Transport Service Description, which is used by a transport service provider to announce transport services to transport users (buyers).",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportServiceDescriptionDocumentReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AdditionalDocumentReference": {
          "title": "Transport Execution Plan Request. Additional_ Document Reference. Document Reference",
          "description": "A reference to an additional document associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AdditionalDocumentReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportContract": {
          "title": "Transport Execution Plan Request. Transport_ Contract. Contract",
          "description": "A potential contract related to the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportContract"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportServiceProviderResponseDeadlinePeriod": {
          "title": "Transport Execution Plan Request. Transport Service Provider Response Deadline_ Period. Period",
          "description": "A deadline for a response from the Transport Service Provider to this Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportServiceProviderResponseDeadlinePeriod"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "MainTransportationService": {
          "title": "Transport Execution Plan Request. Main_ Transportation Service. Transportation Service",
          "description": "A description of the main transportation service referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/MainTransportationService"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AdditionalTransportationService": {
          "title": "Transport Execution Plan Request. Additional_ Transportation Service. Transportation Service",
          "description": "A description of an additional transportation service referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AdditionalTransportationService"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ServiceStartTimePeriod": {
          "title": "Transport Execution Plan Request. Service Start Time_ Period. Period",
          "description": "The period within which the services referred to in the Transport Execution Plan Request must begin.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ServiceStartTimePeriod"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ServiceEndTimePeriod": {
          "title": "Transport Execution Plan Request. Service End Time_ Period. Period",
          "description": "The period during which the services referred to in the Transport Execution Plan Request must be completed.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ServiceEndTimePeriod"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "FromLocation": {
          "title": "Transport Execution Plan Request. From_ Location. Location",
          "description": "The location of origin of the transport service referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/FromLocation"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ToLocation": {
          "title": "Transport Execution Plan Request. To_ Location. Location",
          "description": "The destination location for the transport service referenced in the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ToLocation"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AtLocation": {
          "title": "Transport Execution Plan Request. At_ Location. Location",
          "description": "The location of a transport service (e.g., terminal handling service) that does not require transport movement.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AtLocation"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransportExecutionTerms": {
          "title": "Transport Execution Plan Request. Transport Execution Terms",
          "description": "A description of terms and conditions related to the Transport Execution Plan Request.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransportExecutionTerms"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Consignment": {
          "title": "Transport Execution Plan Request. Consignment",
          "description": "A description of an identifiable collection of goods items to be transported between the consignor and the consignee. This information may be defined within a transport contract. A consignment may comprise more than one shipment (e.g., when consolidated by a freight forwarder).",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Consignment"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          }
        },
      "additionalProperties": false,
      "type": "object"
      }
    }
  }