Business Object XML Schema Definitions (XSD)

Business Object XML Schema Definitions (XSD)

Release 25.3 (Ticket #10139) - XSD (XML Schema Definition) files are now available for all Business Objects.

  • Response Schemas: Located at
    C:/Program Files (x86)/DATASCOPE/DATASCOPE WMS WebAPI/Postman/Schema/BusinessObject.Response

  • Request Schemas: Each Business Object has its own Request Schema, stored in a dedicated folder under:
    C:/Program Files (x86)/DATASCOPE/DATASCOPE WMS WebAPI/Postman/Schema/

What is an XSD file?

An XSD (XML Schema Definition) file defines the structure, content, and data types of an XML document.
It acts as a blueprint that tells both developers and systems:

  • What XML elements are allowed.

  • In what order they must appear.

  • Which elements are mandatory vs optional.

  • What data type each element must have (e.g., string, integer, boolean, date).

  • How many times can an element repeat (cardinality)?

An XSD is the technical contract that guarantees your XML requests and responses are valid, predictable, and processable by DATASCOPE Business Objects or APIs.

Purpose of an XSD in Business Object / REST API documentation

An XSD provides:

  1. Validation

    • Ensures the XML request you send to a Business Object (or REST API) matches the exact format the service expects.

    • Prevents malformed or incomplete XML from being processed.

  2. Clarity

    • Acts as a contract between your application and the Business Object.

    • You know up front what fields are required, their valid values, and their hierarchy.

  3. Automation

    • Many IDEs and tools (e.g., Visual Studio, Postman, SoapUI) can use an XSD to auto-generate XML templates, validate responses, or even create strongly-typed classes for integration.

  4. Consistency

    • Ensures every request and response follows the same structure across environments (development, test, production).

Response Schemas

The Response Schemas are standardized across all Business Objects.

Request Schemas

Each Business Object has its own Request Schema, which you can view in the specific method documentation listed in the DATASCOPE Business Objects Reference Library