Fonctions

Permet de récupérer les ID des sites associés à la clé API utilisée.
Ce sera l’information qu’il faudra ensuite utiliser dans certaines méthodes dans le paramètre “RepairSiteId”

Ex réponse

{
    "ResponseData": [
        {
            "SiteId": "02c867c0-0000-0000-000-3cf8de2dc1c8",
            "Name": "Test Reparateur",
            "CommercialName": "ECO REPARE",
            "Zip": "78280",
            "City": "GUYANCOURT"
        }
    ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Réponse avec plusieurs sites

{
    "ResponseData": [
        {
            "SiteId": "9cc23555-0000-0000-0000-3279c2f57261",
            "Name": "Test Reparateur 1",
            "CommercialName": "ECO REPARE",
            "Zip": "12100",
            "City": "MILLAU"
        },
        {
            "SiteId": "0590e586-0000-0000-0000-f94f4e1cb199",
            "Name": "Test Reparateur 1",
            "CommercialName": "ECO REPARE",
            "Zip": "12850",
            "City": "ONET-LE-CHATEAU"
        },
        {
            "SiteId": "b14ca037-0000-0000-0000-54a3391ee624",
            "Name": "Test Reparateur 1",
            "CommercialName": "ECO REPARE",
            "Zip": "12200",
            "City": "VILLEFRANCHE-DE-ROUERGUE"
        }
    ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de récupérer la liste des marques supportées par Ecologic.
Appeler cette API vous permettra de disposer d'un code marque unique et de l'associer à votre référentiel.

Usage

entrée = pas de paramètre spécifique

Exemple de réponse

{
    "ResponseData": [
        {
            "BrandName": "Acer",
            "BrandId": "1689"
        },
        {
            "BrandName": "ADVANCE",
            "BrandId": "1922"
        },
        {
            "BrandName": "AEG",
            "BrandId": "1690"
        },
        ...
  ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de récupérer la liste des types de produits supportés par Ecologic. Appeler cette API vous permettra de disposer d'un code unique pour chaque type de produit afin de l'associer à votre référentiel. Cette API restitue également pour chaque type de produit les symptômes et les codes réparation éligibles au soutien.équipements avec

• code unique de l'équipement

• nom de l'équipement

• date d'éligibilité au soutien

• date de fin du soutien

• Tableau des codes pannes

• Tableau des codes symtomes

Exemple usage

entrée = pas de paramètre spécifique

sortie =

ProductId = Identifiant produit

ProductName  =Désignation du type de produit (ex: Four (hors micro-ondes et mini-four))

EligibilityStartDate = Date de début d'éligibilité

EligibilityEndDate = Date de fin d'éligibilité

RepairCodes = Tableau d’une liste des codes pannes IRIS pouvant être utilisés dans la demande de remboursement (Claim) avec leur libellé

IRISSymptoms[] = Liste Tableau d’une liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic à utiliser dans la demande de soutien (Request) avec leur libellé

Exemple de réponse

{
    "ResponseData": [
        {
            "ProductId": "EEE.M1.010",
            "ProductName": "Cave à vin",
            "EligibilityStartDate": "2022-01-01T00:00:00",
            "EligibilityEndDate": "9999-12-31T00:00:00",
            "RepairCodes": [
                "XXX",{
                "PSP",      "Code": "XXX",
          "G12",          "Label": "Autre"
     "G13",           },
     "C05",           {
     "C01",                "Code": "C10PSP",
                "SFT"    "Label": "Défaut d'alimentation"
       ],         },
   "IRISSymtoms": [            {
    "004",                "Code": "006G12",
                "012",    "Label": "Défaut de carte de commande"
        "013",        },
        "001",        {
        "023"             ]"Code": "G13",
        },         ...   ],
    "ResponseStatus": "S",
    "IsValid": true,"Label": "Défaut de carte de puissance"
                },
                {
                    "ResponseMessageCode": "C05",
                    "ResponseErrorMessageLabel": "Fuite de fluide frigorigène"
  }

Fonctions

Permet de connaître l'éligibilité, l'éco-organisme et le montant du soutien pour un type de produit donné, en fonction du symptôme ou du code section fourni. Cette API n'a pour seul but que de simuler la demande de soutien.

Elle n'effectue aucune demande réelle auprès d'Ecologic.

Données à transmettre

Exemple

{
    "TotalAmountExclVAT": 120.00,
    "TotalAmountExclVAT_Currency": "EUR",
    "BrandId": 8055,
    "ProductId": 3032,
    "IRISSymtom": "001" 
 }

Données en entrée

• TotalAmountExclVAT : Montant total HT de la réparation

• TotalAmountExclVAT_Currency : Devise

• BrandId: Code de la marque (retourné préalablement par l'API /PrintBrandList)

• ProductId : Code du type de produit (retourné préalablement par l'API /PrintProductTypeList) 

• IRISSymptom : Liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic

Données en sortie

• EcoOrganizationId: Identifiant e-Reparateur de l'éco-organisme (44=Ecologic, 45=Ecosystem)

• SupportAmount: Montant TTC du soutien

Exemple de paramètre en entrée

Image Removed

Exemple de réponse

{
    "ResponseData": [              },
                {
                    "Code": "C01",
                    "Label": "Problème compresseur"
                },
                {
                    "Code": "C10",
                    "Label": "Problème de thermostat"
                }
            ],
            "IRISSymtoms": [
                {
                    "Code": "XX4",
               {     "Label": "Devient très buyant"
    "EcoOrganizationId": 44,           },
 "SupportAmount": 10.00         }     ],{
    "ResponseStatus": "S",          "IsValid": true,     "ResponseMessageCode": "XX6",
      "ResponseErrorMessage": ""
}

Fonctions

Permet de soumettre la demande de soutien en vue d'obtenir la vérification du consommateur.

Données à transmettre

Exemple

{
  "Consumer": {
    "Title": 1,
    "LastName": "Test Nom",
    "FirstName": "Test prénom",
    "StreetNumber": "15",
    "Address1": "Avenue du Centre",
    "Address2": "",
    "Address3": "",
    "Zip": "78280",
    "City": "GUYANCOURT",
    "Country": "250",
    "Phone": "0600000000",
    "Email": "test@egmail.com",
    "AutoValidation": true
},
  "Product": {
    "ProductId": "EEE.M5.024",
    "BrandId": "2194   },
                {
                    "Code": "XX13",
                    "Label": "Ne s'allume plus"
                },
                {
                    "Code": "XX1",
                    "Label": "Autre"
                },
                {
                    "Code": "XX23",
                    "Label": "Problème de bouton / connecteur"
                }
            ]
        },
        ...
  ],
    "ResponseStatus": "S",
    "CommercialRefIsValid": "Repasse Plus"true,
    "SerialNumberResponseMessage": "ABCDE",
    "PurchaseDateResponseErrorMessage": "2020-10-06",
    "IRISCondition": "",
    "IRISConditionEX": "",
    "IRISSymptom": "013",
    "IRISSection": "",
    "IRISDefault": "",
    "IRISRepair": "",
    "FailureDescription": "Symptome code IRIS 013",
    "DefectCode": ""  
},
  "Quote": {
    "LaborCost": {
      "Amount": 20.00,
      "Currency": "EUR"
    },
    "SparePartsCost":
}

Fonctions

Permet de récupérer la liste des équipements avec

• code unique de l'équipement

• nom de l'équipement

• date d'éligibilité au soutien

• date de fin du soutien

• Tableau des codes pannes

• Tableau des codes symtomes

.

Exemple usage

entrée = pas de paramètre spécifique

sortie =

ProductId = Identifiant produit

ProductName  =Désignation du type de produit (ex: Four (hors micro-ondes et mini-four))

EligibilityStartDate = Date de début d'éligibilité

EligibilityEndDate = Date de fin d'éligibilité

RepairCodes = Tableau des codes pannes IRIS pouvant être utilisés dans la demande de remboursement (Claim)

IRISSymptoms[] = Liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic à utiliser dans la demande de soutien (Request)

Exemple de réponse

{
    "ResponseData": [
        {
      "Amount": 10.00,       "CurrencyProductId": "EUREEE.M1.010",
    },      "TravelCost  "ProductName": {"Cave à vin",
    "Amount": 0.00,       "CurrencyEligibilityStartDate": "EUR"2022-01-01T00:00:00",
       },     "TotalAmountExclVATEligibilityEndDate": {"9999-12-31T00:00:00",
      "Amount": 100.00,
      "CurrencyRepairCodes": "EUR"[
    },     "TotalAmountInclVAT": {       "AmountXXX": 106.00,
      "Currency": "EUR"     },     "SupportAmountPSP":,
{       "Amount": 10.00,       "Currency": "EURG12",
    }   },   "SpareParts": [      "G13",
         {       "Partref": "C05",
                "C01",
      "Quantity": 0,          "C10",
                "SFT"
            ],
            "StatusIRISSymtoms": [
                "004",
    }    ] }
       "006",
                "012",
                "013",
                "001",
                "023"
            ]
        },
        ...
  ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de connaître l'éligibilité, l'éco-organisme et le montant du soutien pour un type de produit donné, en fonction du symptôme ou du code section fourni. Cette API n'a pour seul but que de simuler la demande de soutien.

Elle n'effectue aucune demande réelle auprès d'Ecologic.

Données à transmettre

Exemple

{
    "TotalAmountExclVAT": 120.00,
    "TotalAmountExclVAT_Currency": "EUR",
    "BrandId": 8055,
    "ProductId": 3032,
    "IRISSymtom": "001" 
 }

Données en entrée

• TotalAmountExclVAT : Montant total HT de la réparation

• TotalAmountExclVAT_Currency : Devise

• BrandId: Code de la marque (retourné préalablement par l'API /PrintBrandList)

• ProductId : Code du type de produit (retourné préalablement par l'API /PrintProductTypeList) 

• IRISSymptom : Liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic

Données en sortie

• EcoOrganizationId: Identifiant e-Reparateur de l'éco-organisme (44=Ecologic, 45=Ecosystem)

• SupportAmount: Montant TTC du soutien

Exemple de paramètre en entrée

Image Added

Exemple de réponse

{
    "ResponseData": [
        {
            "EcoOrganizationId": 44,
            "SupportAmount": 10.00
        }
    ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de soumettre la demande de soutien en vue d'obtenir la vérification du consommateur.

Données à transmettre

Exemple

{
  "Consumer": {
    "Title": 1,
    "LastName": "Test Nom",
    "FirstName": "Test prénom",
    "StreetNumber": "15",
    "Address1": "Avenue du Centre",
    "Address2": "",
    "Address3": "",
    "Zip": "78280",
    "City": "GUYANCOURT",
    "Country": "250",
    "Phone": "0600000000",
    "Email": "test@egmail.com",
    "AutoValidation": true
},
  "Product": {
    "ProductId": "EEE.M5.024",
    "BrandId": "2194",
    "CommercialRef": "Repasse Plus",
    "SerialNumber": "ABCDE",
    "PurchaseDate": "2020-10-06",
    "IRISCondition": "",
    "IRISConditionEX": "",
    "IRISSymptom": "XX13",
    "IRISSection": "",
    "IRISDefault": "",
    "IRISRepair": "",
    "FailureDescription": "Symptome code IRIS XX13",
    "DefectCode": ""  
},
  "Quote": {
    "LaborCost": {
      "Amount": 20.00,
      "Currency": "EUR"
    },
    "SparePartsCost": {
      "Amount": 10.00,
      "Currency": "EUR"
    },
    "TravelCost": {
      "Amount": 0.00,
      "Currency": "EUR"
    },
    "TotalAmountExclVAT": {
      "Amount": 100.00,
      "Currency": "EUR"
    },
    "TotalAmountInclVAT": {
      "Amount": 106.00,
      "Currency": "EUR"
    },
    "SupportAmount": {
      "Amount": 10.00,
      "Currency": "EUR"
    }
  },
  "SpareParts": [
    {
      "Partref": "",
      "Quantity": 0,
      "Status": ""
    }
  ]
}

Données en entrée

Dans les paramètres

• CallDate= date de référence de l’appel à l’API

• RepairSiteId= ID de votre compte e-reparateur.eco

• QuoteNumber= numéro du devis

Dans le body

il y a 3 sections importantes:

• Consumer : fourni

  • identité

    • Title -> 1 : Mrs. ; 2 : Ms. ; 3 : Mr. ; 4 : Société

  • adresse

    • Country: 250 pour la France (List of ISO 3166 country codes - Wikipedia )

  • téléphone = très important en cas de mode de vérification par SMS

  • email

• Product : définit tous les paramètres du produit en réparation

  • ProductID = code du produit du référentiel

  • BrandID = code de la marque

  • SerialNumber = numéro de série

  • IRISSymptom = code IRIS de symptôme retenu associé au produit (doit correspondre à une entrée du référentiel retourné par PrintProductTypeList

  • FailureDescription = description des symptômes de la panne (ou de la panne)

• Quote : définit les montants du devis associé à la demande

Données en sortie

• RequestId: Identifiant de la demande de soutien,
  Cet ID unique sera à fournir pour toute référence à la demande de soutien qui vient d'être créée.

Exemple de réponse

{
    "ResponseData": {
        "EcoOrganizationId": 44,
        "RequestId": 5310857,
        "IsValid": true
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

En cas d’erreur un message vous oriente vers la cause

{
    "ResponseData": {
        "EcoOrganizationId": 44,
        "RequestId": 5312273,
        "IsValid": false,
        "ValidationErrors": [
            {
                "Field": "Montant de remboursement / Soutien",
                "ErrorMessage": "Code symptôme non valide, demande de remboursement / soutien non valide",
                "MessageType": "E"
            }
        ]
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": null,
    "ResponseErrorMessage": null
}

Fonctions

Permet de savoir si le consommateur a donné sa validation pour une demande de soutien donnée.

Données en entrée

Dans les paramètres

• RequestId = Id de votre dossier issu de la réponse à CreateSupportRequest
  Ex : /GetSupportRequestStatus?RequestId=1564

Données en sortie

• ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa conversion en demande de remboursement (Claim)

• LastStatus: Dernier statut de la demande de soutien

  • mode SMS non validé par le consommateur = "En attente de validation consommateur"

  • mode SMS validé par le consommateur ou mode offline : "Validé par le consommateur"

  • refusé

Exemple de réponse

{
    "ResponseData": [
        {
            "RequestId": 5310857,
            "LastStatus": "Validé par le consommateur",
            "Comment": "Symptome code IRIS 013",
            "CreateDate": "2023-03-01T15:49:50.4"
        }
    ],
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de mettre à jour, compléter une demande de soutien (Request) avec un jeu de données.

Données en entrée

Dans les paramètres

• CallDate= date de référence de l’appel à l’API

• RepairSiteId= ID de votre compte e-reparateur.eco

• QuoteNumber= numéro du devis

Dans le body

il y a 3 sections importantes:

• Consumer : fourni

  • identité

    • Title -> 1 : Mrs. ; 2 : Ms. ; 3 : Mr. ; 4 : Société

  • adresse

    • Country: 250 pour la France (List of ISO 3166 country codes - Wikipedia )

  • téléphone = très important en cas de mode de vérification par SMS

  • email

• Product : définit tous les paramètres du produit en réparation

  • ProductID = code du produit du référentiel

  • BrandID = code de la marque

  • SerialNumber = numéro de série

  • IRISSymptom = code IRIS de symptôme retenu associé au produit (doit correspondre à une entrée du référentiel retourné par PrintProductTypeList

  • FailureDescription = description des symptômes de la panne (ou de la panne)

• Quote : définit les montants du devis associé à la demande

Données en sortie

• RequestId: Identifiant de la demande de soutien,
  Cet ID unique sera à fournir pour toute référence à la demande de soutien qui vient d'être créée.

• RequestId = Id de votre dossier issu de la réponse à CreateSupportRequest
  Ex : /GetSupportRequestStatus?RequestId=1564

Données en sortie

• RequestId : numéro du dossier de soutien (request)

• IsValid : true si le dossier est prêt à être soumis

Exemple de réponse

{
    "ResponseData": {
        "EcoOrganizationId": 44,
        "RequestId": 5310864,
        "IsValid": true
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet d'effectuer la demande de remboursement (Claim) en convertissant une demande de soutien (Request)

En retour de cet appel, vous obtiendrez l'ID de votre demande de remboursement (ClaimId), qu'il vous faudra utiliser pour corriger les erreurs de validation, pour ajouter les pièces jointes requises et finalement soumettre votre demande. 

Données à transmettre

exemple

{

   "ResponseDataConsumer": {
        "EcoOrganizationId": 44,
    {
    "RequestIdTitle": 53108571,
    "LastName": "Test Nom",
    "IsValidFirstName": true"Test prénom",
    }"StreetNumber": "15",
    "ResponseStatusAddress1": "SAvenue du Centre",
    "IsValidAddress2": true"",
    "ResponseMessageAddress3": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de savoir si le consommateur a donné sa validation pour une demande de soutien donnée.

Données en entrée

Dans les paramètres

• RequestId = Id de votre dossier issu de la réponse à CreateSupportRequest
  Ex : /GetSupportRequestStatus?RequestId=1564

Données en sortie

• ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa conversion en demande de remboursement (Claim)

• LastStatus: Dernier statut de la demande de soutien

  • mode SMS non validé par le consommateur = "En attente de validation consommateur"

  • mode SMS validé par le consommateur ou mode offline : "Validé par le consommateur"

  • refusé

Exemple de réponse

{
    "ResponseData": [
           "LaborCost": {
      "Amount": 20.00,
      "Currency": "EUR"
    },
    "SparePartsCost": {
      "Amount": 10.00,
      "Currency": "EUR"
    },
    "TravelCost": {
      "Amount": 0.00,
      "Currency": "EUR"
    },
    "TotalAmountExclVAT": {
      "Amount": 100.00,
      "RequestIdCurrency": 5310857"EUR"
    },
    "TotalAmountInclVAT": {
      "LastStatusAmount": "Validé par le consommateur",106.00,
      "Currency": "EUR"
    },
    "CommentSupportAmount": "Symptome{
code IRIS 013",    "Amount": 10.00,
       "CreateDateCurrency": "2023-03-01T15:49:50.4EUR"
    }
   }},
  "SpareParts": [
    {
],      "ResponseStatusPartref": "S",
      "IsValidQuantity": true0,
      "ResponseMessageStatus": "",
    }
 "ResponseErrorMessage": "" ]
}

Données en entrée

Dans les paramètres
ex : /CreateClaim?RequestId=1564&RepairEndDate=2022-06-27T11:50:37.913Z&RepairSiteId=54654&ConsumerInvoiceNumber=132564

• RequestId = date de référence du dossier de demande de soutien, issue de la réponse à CreateSupportRequest

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber

  État
  colour

• Blue title

• optionnel

Fonctions

Permet de mettre à jour, compléter une demande de soutien (Request) avec un jeu de données.

Données en entrée

Dans les paramètres

• RequestId = Id de votre dossier issu de la réponse à CreateSupportRequest
  Ex : /GetSupportRequestStatus?RequestId=1564

Données en sortie

• RequestId : numéro du dossier de soutien (request)

• IsValid : true si le dossier est prêt à être soumis

Exemple de réponse

• = numéro de référence interne chez le réparateur

Dans le body

• IRISSection = il faut intégrer le code panne IRIS parmi ceux associés au produit dans le référentiel

Données en sortie

• ClaimId : Identifiant du dossier de remboursement

• IsValid : indique si le dossier de remboursement est valide (true ou false)

• ValidationErrors : tableau des erreurs détectées si IsValid = false

Exemple de réponse

{
    "ResponseData": {
        "ClaimId": 5312276,
        "IsValid": false,
        "ValidationErrors": [
            {
                "Field": "Plaque signalétique",
                "ErrorMessage": "Des pièces jointes sont requises : Plaque signalétique",
                "MessageType": "E"
           "EcoOrganizationId": 44},
        "RequestId": 5310864,   {
     "IsValid": true     },     "ResponseStatusField": "SFacture",
    "IsValid": true,            "ResponseMessageErrorMessage": "",Des pièces jointes sont requises "ResponseErrorMessage": Facture""
}

Fonctions

Permet d'effectuer la demande de remboursement (Claim) en convertissant une demande de soutien (Request)

En retour de cet appel, vous obtiendrez l'ID de votre demande de remboursement (ClaimId), qu'il vous faudra utiliser pour corriger les erreurs de validation, pour ajouter les pièces jointes requises et finalement soumettre votre demande. 

Données à transmettre

exemple

{
  "Consumer": {
    "Title": 1,
    "LastName": "Test Nom",
    "FirstName": "Test prénom",
    "StreetNumber": "15",
    "Address1": "Avenue du Centre,
                "MessageType": "E"
            },
            {
                "Field": "Panne ou code IRIS",
                "ErrorMessage": "Cette valeur est obligatoire",
                "MessageType": "E"
            },
            {
                "Field": "Validation manuelle du consommateur",
    "Address2": "",     "Address3": "",     "ZipErrorMessage": "78280",Des pièces jointes sont requises "City": Validation manuscrite"GUYANCOURT",
    "Country": "250",     "Phone": "0600000000",       "EmailMessageType": "test@egmail.com",E"
        "AutoValidation": false   },
    "Product": {     "ProductId": "EEE.M5.024",
 {
   "BrandId": "2194",     "CommercialRef": "Repasse Plus",     "SerialNumberField": "ABCDEMontant de remboursement / Soutien",
    "PurchaseDate": "2020-10-06",     "IRISCondition": "",     "IRISConditionEXErrorMessage": ""Code panne non valide, demande de remboursement  "IRISSymptom": ""/ soutien non valide",
    "IRISSection": "G18",     "IRISDefault": "",     "IRISRepairMessageType": "E",
        "FailureDescription": "Code IRIS Symptome 013"},
    "DefectCode": ""   },   "Quote": {
    "LaborCost": {            "AmountField": 20.00 "Numéro de série",
      "Currency": "EUR"     },
    "SparePartsCostErrorMessage": {
      "Amount": 10.00,
      "Currency": "EUR""Une réparation a déjà été effectuée il y a moins de 6 mois sur cet appareil. Cette réparation est donc couverte par votre garantie.",
    },     "TravelCost": {
      "AmountMessageType": 0.00,"E"
      "Currency": "EUR"     },
    "TotalAmountExclVAT": {   ]
   "Amount": 100.00 },
      "CurrencyResponseStatus": "EURS",
    "IsValid": }true,
    "TotalAmountInclVATResponseMessage": {null,
        "Amount": 106.00,
      "Currency": "EUR"
    },
    "SupportAmount": {
      "Amount": 10.00,
      "Currency": "EUR"
    }
  },
  "SpareParts": [
    {
      "Partref": "",
      "Quantity": 0,
      "Status": ""
    }
  ]
}

Données en entrée

Dans les paramètres
ex : /CreateClaim?RequestId=1564&RepairEndDate=2022-06-27T11:50:37.913Z&RepairSiteId=54654&ConsumerInvoiceNumber=132564

• RequestId = date de référence du dossier de demande de soutien, issue de la réponse à CreateSupportRequest

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber

  État
  colour Blue title optionnel

  = numéro de référence interne chez le réparateur

Dans le body

• IRISSection = il faut intégrer le code panne IRIS parmi ceux associés au produit dans le référentiel

Données en sortie

• ClaimId : Identifiant du dossier de remboursement

• IsValid : indique si le dossier de remboursement est valide (true ou false)

• ValidationErrors : tableau des erreurs détectées si IsValid = false

Exemple de réponse

{
    "ResponseData": {
        "ClaimId": 5310865,
        "IsValid": false,
        "ValidationErrors": [
            {
                "Field": "Plaque signalétique",
                "ErrorMessage": "Des pièces jointes sont requises : Plaque signalétique",
                "MessageType": "E"
            },
            {
                "Field": "Facture",
                "ErrorMessage": "Des pièces jointes sont requises : Facture",
                "MessageType": "E"
            }
        ],
        "ErrorMessage": "Validation Errors"ResponseErrorMessage": null
}

Fonctions

Permet d'ajouter un document à une demande de remboursement. 

Un dossier de remboursement peut contenir plusieurs types de fichiers

Les types de fichiers qui peuvent être joints à une demande : 

Données à transmettre

exemple

{
  "FileContent": "KJQFKJSQKJDKJQSJDKLFDSGDGDG5F4D65HG46G4D5FSG456FD4G4SG64FSDG5FD5G46DS5G456FD4G56FDSG654FDS56G4F6DG54FDS6G5FD6SG45FS4D6G4F56D4SG654S6G4F5D4G6S45FD4G45SFD4G65FD4SG65DF46S4"
 }

Données en entrée

Dans les paramètres
ex : /AttachFile?ClaimId=16466&FileName=Facture797&FileExtension=pdf&DocumentType=Invoice

• ClaimId = date de référence du dossier de demande de remboursement, issu de la réponse à CreateClaim

• FileName = nom du fichier transmis (sans l’extension)

• FileExtension = extension du fichier (voir ci contre)

  • permet de définir le type

  • extension sans le point “.”

• DocumentType = type de document transmis à intégrer dans la demande (voir les codes identifiants ci contre)

Dans le body

• FileContent = contenu du fichier en Base64

Données en sortie

• "Code 200 -> OK"

Le statut de sortie est géré par le statut de la réponse HTTP

• Code 200 -> OK

• Code 400 -> Bad request

• Code 500 -> Internal Error

Fonctions

Permet de mettre à jour, de corriger et de soumettre la demande de remboursement. La mise à jour n'est plus possible après la soumission de la demande.

Données à transmettre

Exemple (les données ci-dessous de l’exemple sont à mettre à jour; en effet des champs sont obsolètes)

{
  "Consumer": {
    "Title": 1,
    "LastName": "Test Nom",
    "FirstName": "Test prénom",
    "StreetNumber": "15",
    "Address1": "Avenue du Centre",
    "Address2": "",
    "Address3": "",
    "Zip": "78280",
    "City": "GUYANCOURT",
    "Country": "250",
    "Phone": "0600000000",
    "Email": "test@egmail.com",
    "AutoValidation": false  
},
  "Product": {
    "ProductId": "EEE.M5.024",
    "BrandId": "2194",
    "CommercialRef": "Repasse Plus",
    "SerialNumber": "ABCDE",
    "PurchaseDate": "2020-10-06",
    "IRISCondition": "",
    "IRISConditionEX": "",
    "IRISSymptom": "",
    "IRISSection": "G18",
    "IRISDefault": "",
    "IRISRepair": "",
    "FailureDescription": "Code IRIS Symptome 013",
    "DefectCode": ""  
},
  "Quote": {
    "LaborCost": {
      "Amount": 20.00,
      "Currency": "EUR"
    },
    "SparePartsCost": {
      "Amount": 10.00,
      "Currency": "EUR"
    },
    "TravelCost": {
      "Amount": 0.00,
      "Currency": "EUR"
    },
    "TotalAmountExclVAT": {
      "Amount": 100.00,
      "Currency": "EUR"
    },
    "ResponseStatusTotalAmountInclVAT": "S", {
      "IsValidAmount": true106.00,
      "ResponseMessageCurrency": "EUR"
    },
    "ResponseErrorMessageSupportAmount": {
""
}

Fonctions

Permet d'ajouter un document à une demande de remboursement. 

Un dossier de remboursement peut contenir plusieurs types de fichiers

Les types de fichiers qui peuvent être joints à une demande : 

Données à transmettre

exemple

{
  "FileContent": "KJQFKJSQKJDKJQSJDKLFDSGDGDG5F4D65HG46G4D5FSG456FD4G4SG64FSDG5FD5G46DS5G456FD4G56FDSG654FDS56G4F6DG54FDS6G5FD6SG45FS4D6G4F56D4SG654S6G4F5D4G6S45FD4G45SFD4G65FD4SG65DF46S4"
 }      "Amount": 10.00,
      "Currency": "EUR"
    }
  },
  "SpareParts": [
    {
      "Partref": "",
      "Quantity": 0,
      "Status": ""
    }
  ]
}

Données en entrée

Dans les paramètres
ex : /AttachFileUpdateClaim?ClaimId=16466&FileName=Facture797&FileExtension=pdf&DocumentType=Invoice=5310865&repairEndDate=2023-02-24T11:00:00Z&RepairSiteId=02c867c0-3cef-454d-9a04-3cf8de2dc1c8&consumerInvoiceNumber=FACT_20230301-1&quoteNumber=REF_INT_20230301-1&Submit=false

• ClaimId = date de référence du dossier de demande de remboursementsoutien, issu de la réponse à CreateClaim CreateSupportRequest

• FileName = nom du fichier transmis (sans l’extension)

• FileExtension = extension du fichier (voir ci contre)

  • permet de définir le type

  • extension sans le point “.”

• DocumentType = type de document transmis à intégrer dans la demande (voir les codes identifiants ci contre)

Dans le body

• FileContent = contenu du fichier en Base64

Données en sortie

• "Code 200 -> OK"

Le statut de sortie est géré par le statut de la réponse HTTP

• Code 200 -> OK

• Code 400 -> Bad request

• Code 500 -> Internal Error

Fonctions

Permet de mettre à jour, de corriger et de soumettre la demande de remboursement. La mise à jour n'est plus possible après la soumission de la demande.

Données à transmettre

Exemple (les données ci-dessous de l’exemple sont à mettre à jour; en effet des champs sont obsolètes)

{
  "Consumer": {
    "Title": 1,
    "LastName": "Test Nom",
    "FirstName": "Test prénom",
    "StreetNumber": "15",
    "Address1": "Avenue du Centre",
    "Address2": "",
    "Address3": "",
    "Zip": "78280",
    "City": "GUYANCOURT",
    "Country": "250",
    "Phone": "0600000000",
    "Email": "test@egmail.com",
    "AutoValidation": false  
},
  "Product": {
    "ProductId": "EEE.M5.024",
    "BrandId": "2194",
    "CommercialRef": "Repasse Plus",
    "SerialNumber": "ABCDE",
    "PurchaseDate": "2020-10-06",
    "IRISCondition": "",
    "IRISConditionEX": "",
    "IRISSymptom": "",
    "IRISSection": "G18",
    "IRISDefault": "",
    "IRISRepair": "",
    "FailureDescription": "Code IRIS Symptome 013",
    "DefectCode": ""  
},
  "Quote": {
    "LaborCost": {
      "Amount": 20.00,
      "Currency": "EUR"
    },
    "SparePartsCost": {
      "Amount": 10.00,
      "Currency": "EUR"
    },
    "TravelCost": {
      "Amount": 0.00,
      "Currency": "EUR"
    },
    "TotalAmountExclVAT": {
      "Amount": 100.00,
      "Currency": "EUR"
    },
    "TotalAmountInclVAT": {
      "Amount": 106.00,
      "Currency": "EUR"
    },
    "SupportAmount": {
      "Amount": 10.00,
      "Currency": "EUR"
    }
  },
  "SpareParts": [
    {
      "Partref": "",
      "Quantity": 0,
      "Status": ""
    }
  ]
}

Données en entrée

Dans les paramètres
ex : /UpdateClaim?ClaimId=5310865&repairEndDate=2023-02-24T11:00:00Z&RepairSiteId=02c867c0-3cef-454d-9a04-3cf8de2dc1c8&consumerInvoiceNumber=FACT_20230301-1&quoteNumber=REF_INT_20230301-1&Submit=false

• ClaimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber

  État
  colour Blue title optionnel

  = numéro de référence interne chez le réparateur

• Submit = 💡 indique si la mise à jour déclenche ou non la soumission

  • false = la mise à jour n’est pas suivi d’une tentative de soumission

  • true = la mise à jour entraine une tentative de soumission

Dans le body

Données en sortie

Données en sortie

• ClaimId : Identifiant du dossier de remboursement en cours

• IsValid : indique si le dossier de remboursement est valide (true ou false)

• ValidationErrors : tableau des erreurs détectées si IsValid = false

Exemple de réponse

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber

  État
  colour Blue title optionnel

  = numéro de référence interne chez le réparateur

Dans le body

Données en sortie

Données en sortie

• ClaimId : Identifiant du dossier de remboursement en cours

• IsValid : indique si le dossier de remboursement est valide (true ou false)

• ValidationErrors : tableau des erreurs détectées si IsValid = false

Exemple de réponse

{
    "ResponseData": {
        "ClaimId": 5275562,
        "IsValid": false,
        "ValidationErrors": [
            {
                "Field": "Plaque signalétique",
                "ErrorMessage": "Des pièces jointes sont requises : Plaque signalétique",
                "MessageType": "E"
            },
            {
                "Field": "Facture",
                "ErrorMessage": "Des pièces jointes sont requises : Facture",
                "MessageType": "E"
            },
            {
                "Field": "Panne ou code IRIS",
                "ErrorMessage": "Cette valeur est obligatoire",
                "MessageType": "E"
            }
        ],
        "ErrorMessage": "Validation Errors"
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Si la soumission est OK

{
    "ResponseData": {
        "ClaimId": 5310865,
        "IsValid": true
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}

Fonctions

Permet de connaitre le statut d'une demande de remboursement qui a été soumise.

Données à transmettre

Exemple

/GetClaimStatus?ClaimId=5312276

Données en entrée

Dans les paramètres
ex : /GetClaimStatus?ClaimId=5312276

• ClaimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

Données en sortie

• ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa soumission

• LastStatus : Dernier statut de la demande de soutien

  • “Dossier incomplet” : des pièces ou des informations doivent être ajoutées au dossier de demande de remboursement (Claim) avant de tenter de le soumettre

Exemple de réponse

{
    "ResponseData": {
        "MessageTypeValidationErrors": "E"[
            }{
        ],         "ErrorMessageField": "ValidationPlaque Errorssignalétique",
     },     "ResponseStatus": "S",     "IsValidErrorMessage": true,"Des pièces jointes sont requises "ResponseMessage": Plaque "signalétique",
      "ResponseErrorMessage": ""
}

Si la soumission est OK

{          "ResponseDataMessageType": {"E"
         "ClaimId": 5310865,  },
      "IsValid": true     },{
    "ResponseStatus": "S",     "IsValid": true,     "ResponseMessageField": "Facture",
     "ResponseErrorMessage": "" }

Fonctions

Permet de connaitre le statut d'une demande de remboursement qui a été soumise.

Données à transmettre

Exemple

/GetClaimStatus?ClaimId=16466

Données en entrée

Dans les paramètres
ex : /GetClaimStatus?ClaimId=16466

• ClaimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

Données en sortie

• ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa soumission

• LastStatus : Dernier statut de la demande de soutien

  • “Dossier incomplet” : des pièces ou des informations doivent être ajoutées au dossier de demande de remboursement (Claim) avant de tenter de le soumettre

Exemple de réponse

{
    "ResponseData": {         "Field": "Montant de remboursement / Soutien",
                "ErrorMessage": "Le seuil n'est pas dépassé, demande de remboursement / soutien non valide",
                "MessageType": "E"
            },
            {
                "Field": "Numéro de série",
                "ErrorMessage": "Une réparation a déjà été effectuée il y a moins de 6 mois sur cet appareil. Cette réparation est donc couverte par votre garantie.",
                "ValidationErrorsMessageType": ["E"
            {}
        ],
        "FieldClaimId": "Plaque signalétique",
   5312276,
            "ErrorMessageLastStatus": "DesDossier piècesincomplet",
jointes sont requises : Plaque signalétique",   "Comment": "Code IRIS Symptome  013",
        "MessageTypeCreateDate": "E"
       2023-05-05T15:15:50.953"
    },
    "ResponseStatus": "S",
    "IsValid": true,
{         "ResponseMessage": "",
    "ResponseErrorMessage":   "Field": "Facture",
                "ErrorMessage": "Des pièces jointes sont requises : Facture",
                "MessageType": "E"
            },
            {
                "Field": "Validation manuelle du consommateur",
       ""
}

Fonctions

Permet de soumettre simplement un dossier

Données à transmettre

Exemple

/submitclaim?claimId=5275562

Données en entrée

Dans les paramètres
ex : /submitclaim?claimId=5275562

• claimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

Données en sortie

• ResponseData : détails sur le traitement

  • IsValid : indique si la soumission a été validée

  • ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa soumission

Exemple de réponse

si la soumission contient des erreurs :

{
    "ResponseData": {
        "ErrorMessageClaimId": "Des pièces jointes sont requises : Validation manuscrite",
       5312276,
        "MessageTypeLastStatus": "EDossier incomplet",
        "Comment": "Code IRIS Symptome 013",
}         ],"CreateDate": "2023-05-05T15:15:50.953"
    },
    "ClaimIdResponseStatus": 5310972"S",
    "IsValid": true,
    "LastStatusResponseMessage": "Dossier incomplet",
    "ResponseErrorMessage": ""
}

Si la soumission est OK

{
    "CommentResponseData": "Code IRIS Symptome 013" {
        "ClaimId": 5310865,
        "CreateDateIsValid": "2023-03-08T17:40:45.103"true
    },
    "ResponseStatus": "S",
    "IsValid": true,
    "ResponseMessage": "",
    "ResponseErrorMessage": ""
}