WsOne
  1. Consultation / Recherche
WsOne
  • 🏠 Accueil
  • 👋 Introduction
  • ⚙️ Workflows / Use Cases
  • 📚 Dictionnaire de données
  • ❌ Codes erreurs
  • WS Person
    • Clients
      • Création
        • createPersonAndIdentifier
        • createPerson
        • createIdentifier
        • associateNewIdentifier
        • associateIdentifier
        • replaceIdentifier
      • Consultation / Recherche
        • getPerson
          POST
        • searchPerson
          POST
        • getAccounts
          POST
        • getFullPerson
          POST
        • searchPersonLite
          POST
        • getBadge
          POST
      • Update
        • updatePerson
    • Offres
      • getAvailableOffers
      • getEnableOffers
      • editOffer
    • Formulaires
      • getForm
      • updateForm
    • Magasins
      • getEntities
      • getEntityParents
  • WS Transaction
    • sendTransaction
    • validTransaction
    • sendAndValidTransaction
    • sendAndValidFullTransaction
    • verifyTransaction
    • cancelTransactionsNotValidated
    • sendSimpleTransaction
    • refundTransaction
    • getLastTransaction
  • Schemas
    • Response
      • AccountResponse
      • NewIdentifierResponse
      • PersonResponse
      • IdentifierResponse
      • SegmentationResponse
      • SubscriptionResponse
      • EntityResponse
      • EmailResponse
      • CellPhoneResponse
      • ContactsReponse
      • InfoPersonResponse
      • GetPersonReponse
      • AccountResponse
      • classifications
      • OfferReponse
      • AddressResponse
    • Request
      • IdentifierRequest
      • EntityRequest
      • ContactRequest
      • PersonRequest
      • PersonProfilRequest
      • NewIdentifierRequest
      • AdressRequest
      • EmailRequest
      • CellPhoneRequest
      • FullPersonRequest
      • SubscriptionRequest
      • FormAnsweredRequest
      • AssociatedIdentifierRequest
      • AccountAdvantageRequest
      • ReceiptRequest
      • DetailsRequest
  1. Consultation / Recherche

searchPerson

POST
/rest/2.0/personWebService/searchPerson
Maintainer:Martin DA COSTA NETO
Permet de rechercher des clients sur la base de leurs informations personnelles, et retourne tous les comptes clients répondants aux critères.
Pour optimiser les résultats, la recherche gère les noms et prénoms comme suit :
Majusculiser les valeurs
Suppression des marques diacritiques
Remplacement de l’apostrophe par un espace.
Pour des raisons de performance, une limite du nombre de réponses affichées dans le retour de l'appel est configuré lors du déploiement / de la configuration du WS.
Il est donc nécessaire d'utiliser ce Web-Service avec des critères permettant de cibler au maximum la recherche client.
Par exemple, ne pas rechercher tous les "DUPOND" de France, mais plutôt les "Jean DUPOND", ayant un code postal spécifique, avec comme date de naissance le "01/01/2000", ayant comme magasin de rattachement "666666", etc...)
Tous les paramètres de l'appel sont optionnels, mais ceux-ci doivent être renseignés s'ils sont présents.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params

Body Params application/json

Example
{
    "firstName": "JEAN",
    "lastName": "DUPOND",
   
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/rest/2.0/personWebService/searchPerson' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "JEAN",
    "lastName": "DUPOND",
   
}'

Responses

🟢200
application/json
Body

Example
{
    "responseCode": "100",
    "infos": "3 person(s) found\nserver.instance.name=API-DOG preprod serveur 1 instance 1\n",
    "GetPersonResponse": [
        {
            "PersonResponse": {
                "firstName": "JEAN",
                "lastName": "DUPOND",
                "birthDate": "01/01/2000",
                "title": 1,
                "personId": "A31"
            },
            "IdentifierResponse": [
                {
                    "activationDate": "2025-09-26 15:04:38.382",
                    "identifierValue": "9200008784167",
                    "identifierType": 1
                },
                {
                    "activationDate": "2025-09-26 15:04:38.375",
                    "identifierValue": "email-test@email.fr",
                    "identifierType": 10
                },
                {
                    "activationDate": "2025-09-26 15:17:16.136",
                    "identifierValue": "9876543212345",
                    "identifierType": 30
                }
            ],
            "EntityResponse": {
                "entityIdentifier": "666666"
            },
            "SegmentationResponse": {
                "id": "4",
                "label": "4-Multi-secteurs occasionnels"
            },
            "SubscriptionResponse": [
                {
                    "id": "30",
                    "label": "WALLET",
                    "activate": true,
                    "updatedAt": null
                }
            ],
            "ContactsResponse": {
                "AddressResponse": {
                    "status": 1,
                    "country": "FRANCE",
                    "address3Num": "13",
                    "address3Name": "DE LA LIBERTE",
                    "address3Type": 5,
                    "city": "LILLE",
                    "zipCode": "59000",
                    "address1": "ETAGE 2",
                    "address2": "APPT 17",
                    "address4": "",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "EmailResponse": {
                    "status": 1,
                    "emailValue": "email-test@email.fr",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "CellPhoneResponse": {
                    "status": 1,
                    "model": "S24",
                    "brand": "SAMSUNG",
                    "number": "0612345678",
                    "dialingCode": "33",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                }
            },
            "InfoPersonResponse": []
        },
        {
            "PersonResponse": {
                "firstName": "JEAN",
                "lastName": "DUPOND",
                "birthDate": "01/01/2000",
                "title": 1,
                "personId": "A32"
            },
            "IdentifierResponse": [
                {
                    "activationDate": "2025-09-26 15:05:48.673",
                    "identifierValue": "9200008618899",
                    "identifierType": 1
                }
            ],
            "EntityResponse": {
                "entityIdentifier": "666666"
            },
            "SegmentationResponse": {
                "id": "4",
                "label": "4-Multi-secteurs occasionnels"
            },
            "SubscriptionResponse": [],
            "ContactsResponse": {
                "AddressResponse": {
                    "status": 1,
                    "country": "FRANCE",
                    "address3Num": "13",
                    "address3Name": "DE LA LIBERTE",
                    "address3Type": 5,
                    "city": "LILLE",
                    "zipCode": "59000",
                    "address1": "ETAGE 2",
                    "address2": "APPT 17",
                    "address4": "",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "EmailResponse": {
                    "status": 1,
                    "emailValue": "email-test@email.fr",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "CellPhoneResponse": {
                    "status": 1,
                    "model": "S24",
                    "brand": "SAMSUNG",
                    "number": "0612345678",
                    "dialingCode": "33",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                }
            },
            "InfoPersonResponse": []
        },
        {
            "PersonResponse": {
                "firstName": "JEAN",
                "lastName": "DUPOND",
                "birthDate": "01/01/2000",
                "title": 1,
                "personId": "A34"
            },
            "IdentifierResponse": [
                {
                    "activationDate": "2025-09-26 15:14:52.429",
                    "desactivationDate": "2025-09-26 15:21:29.146",
                    "identifierValue": "1110987654321",
                    "identifierType": 1
                },
                {
                    "activationDate": "2025-09-26 15:21:29.146",
                    "identifierValue": "1234567891011",
                    "identifierType": 1
                },
                {
                    "activationDate": "2025-09-26 15:19:14.038",
                    "identifierValue": "email-test2@email.fr",
                    "identifierType": 10
                }
            ],
            "EntityResponse": {
                "entityIdentifier": "666666"
            },
            "SegmentationResponse": {
                "id": "4",
                "label": "4-Multi-secteurs occasionnels"
            },
            "SubscriptionResponse": [],
            "ContactsResponse": {
                "AddressResponse": {
                    "status": 1,
                    "country": "FRANCE",
                    "address3Num": "13",
                    "address3Name": "DE LA LIBERTE",
                    "address3Type": 5,
                    "city": "LILLE",
                    "zipCode": "59000",
                    "address1": "ADDR 2",
                    "address2": "ADDR 3",
                    "address4": "ADDR 4",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "EmailResponse": {
                    "status": 1,
                    "emailValue": "email-test@email.fr",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                },
                "CellPhoneResponse": {
                    "status": 1,
                    "model": "S24",
                    "brand": "SAMSUNG",
                    "number": "0612345678",
                    "dialingCode": "33",
                    "allowCompanySolicitation": 1,
                    "allowTrustedSolicitation": 0
                }
            },
            "InfoPersonResponse": []
        }
    ]
}
Modified at 2025-09-29 10:06:17
Previous
getPerson
Next
getAccounts
Built with