Cette API permet l’échange d’informations sur les réclamations de garantie et de réparation entre ServiceNow les opérations commerciales de fabrication (MCO) et un système de gestion des concessionnaires (DMS). Plus précisément, il permet aux utilisateurs de :

• Créez et validez les demandes de garantie dans le DMS directement auprès de ServiceNow MCO.
• Interrogez l’état des réclamations soumises, y compris les résultats de l’adjudication et de l’approbation, et récupérez ces résultats dans ServiceNow.
• Gérez les données de réclamation de réparation dans trois tables MCO principales :
  • Ticket de réclamation de réparation [sn_repair_claim_mgmt_case]
  • Ligne de ticket de réclamation de réparation [sn_repair_claim_mgmt_case_line]
  • Frais de ligne de ticket de réclamation de réparation [sn_repair_claim_mgmt_case_line_charge]
• Prenez en charge les formats de message XML STAR via des adaptateurs basés sur la configuration, permettant des intégrations basées sur des normes sans code personnalisé.

• Authentification de base (nom d’utilisateur/mot de passe)
• Configurable par point de terminaison pour chaque DMS

Cette opération :

• Valide la demande par rapport au schéma STAR.
• Valide que les valeurs de XML sont valides dans MCO.
• Détermine si la réclamation de réparation (ID de document) existe déjà.
• Crée un nouvel enregistrement si aucune correspondance n’est trouvée.
• Met à jour un enregistrement existant si une correspondance est trouvée.
• Renvoie un identificateur de référence et d’état du traitement.

Le corps de la demande contient un message ProcessRepairOrder conforme à STAR enveloppé dans une enveloppe SOAP. Les éléments logiques clés sont les suivants :

• Métadonnées de l’application (expéditeur, heure de création, destination).
• Verbe de processus indiquant l’action demandée.
• Informations sur l’en-tête de l’ordre de réparation.
• Détails du véhicule.
• Détails de la tâche, de la main-d’œuvre, des pièces et des prix.
• Informations sur la demande de garantie.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:oagis="http://www.openapplications.org/oagis/9"
    xmlns:star="http://www.starstandard.org/STAR/5"
    xmlns:tran="http://www.starstandards.org/webservices/2009/transport"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <soap:Header>
        <!-- Optional header -->
        <tran:payloadManifest>
            <tran:manifest
                contentID="A0"
                element="ProcessRepairOrder"
                namespaceURI="http://www.starstandard.org/STAR/5"
                version="5.13.4.0.0" />
        </tran:payloadManifest>
    </soap:Header>

    <soap:Body>
        <ProcessRepairOrder xmlns="http://www.service-now.com/ProcessRepairOrder">
            <payload>
                <![CDATA[
<star:ProcessRepairOrder
    xmlns:star="http://www.starstandard.org/STAR/5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    releaseID="5.13.4.0.0"
    systemEnvironmentCode="Production">

    <!-- APPLICATION AREA -->
    <star:ApplicationArea>
        <star:Sender>
            <star:CreatorNameCode>DealerManagementSystem</star:CreatorNameCode>
            <star:SenderNameCode>DEALER001</star:SenderNameCode>
            <star:URI>https://dealer-system.example.com</star:URI>
            <star:DealerNumberID>98765</star:DealerNumberID>
            <star:StoreNumber>ST-001</star:StoreNumber>
            <star:AreaNumber>REGION-01</star:AreaNumber>
            <star:DealerCountryCode>US</star:DealerCountryCode>
            <star:LanguageCode>en-US</star:LanguageCode>
            <star:SystemVersion>DMS_v6.1.0</star:SystemVersion>
        </star:Sender>

        <star:CreationDateTime>2026-01-09T14:30:45</star:CreationDateTime>
        <star:BODID>a1b2c3d4-e5f6-7890-abcd-ef1234567890</star:BODID>

        <star:Destination>
            <star:DestinationNameCode>OEM_MANUFACTURER</star:DestinationNameCode>
        </star:Destination>
    </star:ApplicationArea>

    <!-- DATA AREA -->
    <star:ProcessRepairOrderDataArea>
        <star:Process>
            <star:ActionCode>ADD</star:ActionCode>
        </star:Process>

        <star:RepairOrder>
            <star:RepairOrderHeader>
                <star:DocumentIdentificationGroup>
                    <star:DocumentIdentification>
                        <star:DocumentID>RO-2026-987654qwert</star:DocumentID>
                    </star:DocumentIdentification>
                </star:DocumentIdentificationGroup>

Exemple de réponse SOAP (réussite)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Body>
    <ProcessRepairOrderResponse>
      <status>success</status>
      <message>Repair order processed successfully</message>
      <data>{"reference":"RPC0001005"}</data>
    </ProcessRepairOrderResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Exemple de réponse SOAP (erreur de validation)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Body>
    <ProcessRepairOrderResponse>
      <status>error</status>
      <message>
        VALIDATION ERRORS
        payload="[{\"field\":\"asset\",\"message\":\"Reference value not found\"}]"
      </message>
    </ProcessRepairOrderResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Les erreurs SOAP sont renvoyées lorsque la demande ne peut pas être analysée ou traitée au niveau du protocole, par exemple lorsque :

• XML est malformé
• L’espace de noms est incorrect
• Structure d’enveloppe SOAP requise manquante
• Échec de l’authentification
• Erreur de traitement au niveau du système

Exemple d’erreur SOAP :

<soap:Fault>
  <faultcode>soap:Client</faultcode>
  <faultstring>Invalid SOAP message</faultstring>
</soap:Fault>

Des erreurs de validation d’entreprise se produisent après une analyse SOAP réussie et indiquent des problèmes avec les données de la demande, tels que :

• Références manquantes ou non valides
• Commandes de réparation en double
• Valeurs de code non valides
• Incohérences de schéma ou de version

Celles-ci se produisent après une analyse SOAP réussie, mais pendant la validation de l’activité. Les erreurs sont renvoyées dans la réponse de l’opération avec un état d’erreur et un message descriptif. Erreurs possibles :

• MANDATORY_FIELD_MISSING
• MIN_VALUE MAX_VALUE INVALID_REFERENCE
• UNSUPPORTED_VALIDATION_TYPE
• SOAP_ENVELOPE_EMPTY
• IN_WARRANTY_TRANSFORM_FAILED
• VALIDATION_ERRORS
• INVOKE_PROCESSOR_FAILED
• INVALID_DATE_FORMAT
• INVALID_DATE_VALUE
• INVALID_DATETIME_FORMAT
• XML_TO_JSON_FAILED
• INVALID_DATETIME_VALUE
• PAYLOAD_PARSING_FAILED
• EMPTY_PARSED_PAYLOAD
• INVALID_TRANSLATED_HTML_TYPE
• MAX_LENGTH_EXCEEDED
• MAIN_PART_MISSING
• MULTIPLE_MAIN_PARTS

Exemple de code d’erreur :

<ProcessRepairOrderResponse> 
<status>error</status> 
<message>VALIDATION ERRORS | payload="[{\"field\":\"asset\",\"message\":\"Reference value not found\"}]"</message> 
</ProcessRepairOrderResponse> 
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

L’intégration est déclenchée par une ServiceNow règle métier sur la table Ticket de réclamation de réparation (sn_repair_claim_mgmt_case) lorsque :

• La source de la réclamation est DMS
• L’état de la réclamation est l’un des suivants :
  • Approuvés
  • Partiellement approuvé
  • Rejeté
  • En attente d'informations

Lorsque ces conditions sont remplies, ServiceNow génère et envoie un message STAR ProcessServiceProcessingAdvisory au DMS. Le message STAR sortant communique les résultats de l’évaluation des réclamations, et non les données de soumission des réclamations. Le message comprend :

• Référence à l’ordre de réparation ou à la réclamation
• État global de la réclamation
• Montants totaux à payer ou approuvés
• Montants approuvés au niveau de la tâche ou de l’opération individuelle

Exemple de charge utile sortante :

<ns:ProcessServiceProcessingAdvisory
    xmlns:ns="http://www.starstandard.org/STAR/5"
    xmlns:ns1="http://www.openapplications.org/oagis/9"
    languageCode="en-US"
    releaseID="1.0"
    systemEnvironmentCode="Production"
    versionID="1.0">
    <ns:ApplicationArea>
        <ns:Sender>
            <ns:CreatorNameCode>Beta Consulting Group Orlando</ns:CreatorNameCode>
            <ns:SenderNameCode>DLR0001001</ns:SenderNameCode>
        </ns:Sender>
        <ns:CreationDateTime>2026-02-26T11:54:25</ns:CreationDateTime>
        <ns:Destination />
    </ns:ApplicationArea>
    <ns:ProcessServiceProcessingAdvisoryDataArea>
        <ns:Process />
        <ns:ServiceProcessingAdvisory>
            <ns:ServiceProcessingAdvisoryHeader>
                <ns:DocumentIdentificationGroup>
                    <ns:DocumentIdentification>
                        <ns:DocumentID>RO-2026-987654qwe1111</ns:DocumentID>
                    </ns:DocumentIdentification>
                </ns:DocumentIdentificationGroup>
                <ns:Payments>
                    <ns:RepairOrderReconciliation>
                        <ns:WarrantyClaimReconciliation>
                            <ns:ToBePaidAmount currencyID="INR">342744.29</ns:ToBePaidAmount>
                            <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                            <ns:WarrantyNotes />
                            <ns:DispositionReason>
                                <ns:DispositionReasonCode />
                            </ns:DispositionReason>
                        </ns:WarrantyClaimReconciliation>
                        <ns:JobReconciliation>
                            <ns:ApprovedAmount currencyID="INR">342744.29</ns:ApprovedAmount>
                            <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                            <ns:OperationID>DIAG-ENG-01A1A1</ns:OperationID>
                        </ns:JobReconciliation>
                        <ns:JobReconciliation>
                            <ns:ApprovedAmount currencyID="INR">0.00</ns:ApprovedAmount>
                            <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                            <ns:OperationID>DIAG-ENG-011</ns:OperationID>
                        </ns:JobReconciliation>
                    </ns:RepairOrderReconciliation>
                </ns:Payments>
            </ns:ServiceProcessingAdvisoryHeader>
        </ns:ServiceProcessingAdvisory>
    </ns:ProcessServiceProcessingAdvisoryDataArea>
</ns:ProcessServiceProcessingAdvisory>

• Spécifications STAR XML
• Spécification SOAP 1.1
• Spécification WSDL 1.1