poc-reports/es_elt/xsd/common/OrderDetails.xsd
2026-01-27 14:48:39 +01:00

168 lines
7.7 KiB
XML

<?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="http://www.thales.dc/OrderDetails"
targetNamespace="http://www.thales.dc/OrderDetails"
version="1.0.1">
<!-- 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>sprint 186 - 06/09/2023 - Version 1.0.0</xs:documentation>
<xs:documentation>
First version
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation>-----------------------------------------------------------------------------------------------------------------------
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation>24/09/2025 - Version 1.0.1</xs:documentation>
<xs:documentation>
Add new DeliveryOrderStatus (PENDING_RETRY, RETRIED)
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation>-----------------------------------------------------------------------------------------------------------------------
</xs:documentation>
</xs:annotation>
<xs:complexType name="PriceIncludingVAT">
<xs:all>
<xs:element name="AmountET" type="xs:decimal" minOccurs="0"/>
<xs:element name="AmountGST" type="xs:decimal" minOccurs="0"/>
<xs:element name="AmountIT" type="xs:decimal" minOccurs="0"/>
<xs:element name="AmountPST" type="xs:decimal" minOccurs="0"/>
</xs:all>
</xs:complexType>
<xs:simpleType name="CustomerOrderStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="CREATED">
<xs:annotation>
<xs:documentation>Order created</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="PENDING_VALIDATION">
<xs:annotation>
<xs:documentation>Order pending to be validated</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="VALIDATED">
<xs:annotation>
<xs:documentation>Order validated (paid or free)</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="COMPLETED">
<xs:annotation>
<xs:documentation>All items of the order are in a final status i.e. closed or cancelled</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="OrderItemType">
<xs:restriction base="xs:string">
<xs:enumeration value="MEDIA_SALE"/>
<xs:enumeration value="MEDIA_REFUND"/>
<xs:enumeration value="MEDIA_LOSTSTOLEN"/>
<xs:enumeration value="APPLICATION_SALE"/>
<xs:enumeration value="APPLICATION_REFUND"/>
<xs:enumeration value="APPLICATION_UNBLOCKING"/>
<xs:enumeration value="HOLDER_PROFILE_UPDATE"/>
<xs:enumeration value="PURSE_ACTIVATION"/>
<xs:enumeration value="PURSE_RELOAD"/>
<xs:enumeration value="PURSE_REFUND"/>
<xs:enumeration value="PURSE_UNBLOCKING"/>
<xs:enumeration value="PURSE_AUTORELOAD_MODIFICATION"/>
<xs:enumeration value="CONTRACT_SALE"/>
<xs:enumeration value="CONTRACT_REFUND"/>
<xs:enumeration value="CONTRACT_UNBLOCKING"/>
<xs:enumeration value="CONTRACT_AUTORENEW"/>
<xs:enumeration value="CONTRACT_AUTORENEW_MODIFICATION"/>
<xs:enumeration value="CONTRACT_SUSPENSION"/>
<xs:enumeration value="CONTRACT_REACTIVATION"/>
<xs:enumeration value="CONTRACT_INVALIDATION"/>
<xs:enumeration value="CONTRACT_TRANSFER"/>
<xs:enumeration value="APPLICATION_ACTIVATION"/>
<xs:enumeration value="NON_TRANSIT_PRODUCT_SALE"/>
<xs:enumeration value="DEBT_REPAYMENT"/>
<xs:enumeration value="PAY_AS_YOU_GO_MODIFICATION"/>
<xs:enumeration value="CARD_RECONSTRUCTION"/>
<xs:enumeration value="SUPPLEMENT_CONTRACT_SALE"/>
<xs:enumeration value="CENTRALIZED_PURSE_SALE"/>
<xs:enumeration value="CENTRALIZED_PURSE_RELOAD"/>
<xs:enumeration value="CENTRALIZED_PURSE_AUTORELOAD_MODIFICATION"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DeliveryOrderStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="CREATED">
<xs:annotation>
<xs:documentation>Order item is created</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="PENDING">
<xs:annotation>
<xs:documentation>Waiting for order item validation (e.g. operator evidences verification)</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="PENDING_ISSUING">
<xs:annotation>
<xs:documentation>Waiting for the issue of the media (e.g. media personalization before sending it by mail)</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ON_THE_WAY">
<xs:annotation>
<xs:documentation>Delivery of order item is on the way</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="COMPLETED">
<xs:annotation>
<xs:documentation>Order item is delivered</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="PENDING_CANCELLATION">
<xs:annotation>
<xs:documentation>Waiting for order item cancellation (e.g. order item must be refunded)</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="CANCELLED">
<xs:annotation>
<xs:documentation>Order item is cancelled</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="PENDING_RETRY">
<xs:annotation>
<xs:documentation>Waiting for order item retry</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="RETRIED">
<xs:annotation>
<xs:documentation>Order item is retried</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="FAILED">
<xs:annotation>
<xs:documentation>Order item is failed, i.e. an error has been returned and a manual action shall be done to confirm delivery or to cancel
order item
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>