POST api/match/recherche

Request Information

Header Description

Key	Value	Information
Authorization	Bearer access_token	L'access_token se récupére via la métode d'authentification.

Body Parameters

sat.Match.Webservice.Moteur.Match.RechercheRequest

Name	Description	Type	Additional information
Contact	Contact à rechercher	sat.Match.Webservice.Moteur.Match.Contact	Required
Cnt	Nombre de résultat retourné souhaité	integer	Required
ChampsSpecifiques	Champs spécifiques (valeurs fournies par votre service client)	Dictionary of string [key] and string [value]	Required
InclureSupprimes	Inclure les suivantes de groupe (0/1)	string	Required
Parametrage	Paramétrage souhaité (valeurs fournies par votre service client)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Contact": {
    "CodeDossier": "",
    "IdAdresseSuggest": "",
    "Rsoc": "sample string 1",
    "Civ": "sample string 2",
    "Nom": "sample string 3",
    "Prenom": "sample string 4",
    "Cnom": "sample string 5",
    "Cadrs": "sample string 6",
    "Adresse": "sample string 7",
    "Lieudit": "sample string 8",
    "CpVille": "sample string 9",
    "Telephones": [
      "sample string 1",
      "sample string 2"
    ],
    "Emails": [
      "sample string 1",
      "sample string 2"
    ],
    "Pays": "sample string 10"
  },
  "Cnt": 1,
  "ChampsSpecifiques": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "InclureSupprimes": "sample string 2",
  "Parametrage": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

sat.Match.Webservice.Moteur.Match.RechercheResponse

Name	Description	Type	Additional information
Doublons	Liste de doublons potentiels du contact recherché	Collection of sat.Match.Webservice.Moteur.Match.Doublon	None.
CodeRetour	Code retour (0 = OK)	sat.Match.Webservice.Moteur.CodeRetour	None.
Success	"true" si Code retour = 0, "false" sinon	boolean	None.
Error	Erreur détectée si CodeRetour!=0	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Doublons": [
    {
      "Id": "sample string 1",
      "Poids": 2
    },
    {
      "Id": "sample string 1",
      "Poids": 2
    }
  ],
  "CodeRetour": 0,
  "Success": true,
  "Error": "sample string 1"
}

application/xml, text/xml

Sample:

<RechercheResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CodeRetour>Ok</CodeRetour>
  <Error>sample string 1</Error>
  <Doublons>
    <Doublon>
      <Type>Foyer</Type>
      <Id>sample string 1</Id>
      <NumIndiv />
      <NumFoyer />
      <Poids>2</Poids>
    </Doublon>
    <Doublon>
      <Type>Foyer</Type>
      <Id>sample string 1</Id>
      <NumIndiv />
      <NumFoyer />
      <Poids>2</Poids>
    </Doublon>
  </Doublons>
</RechercheResponse>