poc-reports/es_elt/xsd/auditData/clr/ApportionmentUsingCappingRatioPluginDetails.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--

    Copyright (C) Revenue Collection Systems France S.A.S. - 2018-2025 ALL RIGHTS RESERVED

-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:head="http://www.thales.dc/Headers"
           xmlns="http://www.thales.dc/ApportionmentUsingCappingRatioPluginDetails"
           xmlns:loc="http://www.thales.dc/Localized"
           targetNamespace="http://www.thales.dc/ApportionmentUsingCappingRatioPluginDetails"
           version="1.1.1">

    <!-- Import of xsd file -->
    <xs:import namespace="http://www.thales.dc/Headers" schemaLocation="../../common/Headers.xsd"/>
    <xs:import namespace="http://www.thales.dc/ClearingItemType" schemaLocation="../../common/ClearingItemType.xsd"/>
    <xs:import namespace="http://www.thales.dc/Localized" schemaLocation="../../common/Localized.xsd"/>


    <!-- Annotate all modification of the xsd file according to version -->
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>Version List</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>22/11/2021 - Version 1.0.0</xs:documentation>
        <xs:documentation>
            Create the audit message
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>29/11/2024 - Version 1.1.0</xs:documentation>
        <xs:documentation>
            Add dailyMediaConsumptionId in the ApportionmentUsingCappingRatioPluginDetailsAuditExchange
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>sprint 218 - 24/07/2025 - Version 1.1.1</xs:documentation>
        <xs:documentation>
            Change the RoleType from LocalizedBusinessEntityRoleType to LocalizedBusinessRole
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>


    <!-- Description of the AuditMessages structure -->
    <xs:element name="AuditMessages" type="AuditMessagesType"/>
    <xs:complexType name="AuditMessagesType">
        <xs:sequence>
            <!-- List of AuditMessage -->
            <xs:element name="AuditMessage" type="AuditMessageType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <!-- version of AuditMessages structure -->
        <xs:attribute name="ApportionmentUsingCappingRatioPluginDetailsXsdVersion" type="xs:string" fixed="1.1"/>
    </xs:complexType>
    <!-- Description of the AuditMessage structure -->
    <xs:complexType name="AuditMessageType">
        <xs:sequence>
            <!-- Headers structure -->
            <xs:element name="Headers" type="head:HeadersType" minOccurs="0"/>
            <!-- Payload is a ApportionmentUsingCappingRatioPluginDetails structure -->
            <xs:element name="Payload" type="ApportionmentUsingCappingRatioPluginDetailsAuditExchange"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="ApportionmentUsingCappingRatioPluginDetailsAuditExchange">
        <xs:annotation>
            <xs:documentation>Details of apportionment using capping ratio plugin for a contractId.</xs:documentation>
        </xs:annotation>
        <xs:all>
            <xs:element name="ContractId" type="xs:string"/>
            <xs:element name="Sequence" type="xs:long">
                <xs:annotation>
                    <xs:documentation>The ordering sequence number of this contract's apportionment.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="DailyMediaConsumptions">
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="DailyMediaConsumption" minOccurs="0" maxOccurs="unbounded">
                            <xs:complexType>
                                <xs:all>
                                    <xs:element name="DailyMediaConsumptionId" type="xs:string"/>
                                    <xs:element name="LegApportionments">
                                        <xs:annotation>
                                            <xs:documentation>Apportionment per leg</xs:documentation>
                                        </xs:annotation>
                                        <xs:complexType>
                                            <xs:sequence>
                                                <xs:element name="LegApportionment" type="LegApportionment" minOccurs="0" maxOccurs="unbounded"/>
                                            </xs:sequence>
                                        </xs:complexType>
                                    </xs:element>
                                </xs:all>
                            </xs:complexType>
                        </xs:element>
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
        </xs:all>
    </xs:complexType>

    <xs:complexType name="LegApportionment">
        <xs:annotation>
            <xs:documentation>Details of apportionment for a leg.</xs:documentation>
        </xs:annotation>
        <xs:all>
            <xs:element name="LegId" type="xs:string"/>
            <xs:element name="ApportionmentItems" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Output from apportionment</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="ApportionmentItem" type="CappingRatioApportionmentItemType" minOccurs="0" maxOccurs="unbounded"/>
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
        </xs:all>
    </xs:complexType>

    <xs:complexType name="CappingRatioApportionmentItemType">
        <xs:annotation>
            <xs:documentation>Details of apportionment for a leg.</xs:documentation>
        </xs:annotation>
        <xs:all>
            <xs:element name="StakeholderId" type="loc:LocalizedBusinessEntity">
                <xs:annotation>
                    <xs:documentation>The stakeholder involved in the apportionment</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="RoleType" type="loc:LocalizedBusinessRole">
                <xs:annotation>
                    <xs:documentation>Retailer, Card Owner, Product Owner, Transporter...</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="Account" type="xs:string">
                <xs:annotation>
                    <xs:documentation>The account to where the money is credited/debited.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="AllocatedAmount" type="xs:decimal">
                <xs:annotation>
                    <xs:documentation>amount (positive or negative) allocated to the Clearing Participant</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="AllocatedAmountWithoutCapping" type="xs:decimal">
                <xs:annotation>
                    <xs:documentation>amount (positive or negative) allocated to the Clearing Participant if the apportionment were performed without capping</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:all>
    </xs:complexType>
</xs:schema>