Get subject data

Request

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
subjectProgId	Subject identifier (progressive ID for the subjects)	Number
subjectCustomerCode	Customer code of the subject to be searched	String
subjectEmail	Email of the subject to be searched	String
subjectCard	Card of the subject to be searched	String
subjectName	Subject name	String	✓ (if subjectSurname is set)
subjectSurname	Subject surname	String	✓ (if subjectName is set)
circuit	Customer circuit	String
returnContacts returnPrivacies returnCards returnDestinations returnMappings returnMakeup returnSources	Each field can be a "T" (retrieve data) or "F" (do NOT retrieve data) string that indicates what section will be returned in the response	String (defaults to "F")

At least one of the above fields must be specified.

The circuit parameter can be used together with subjectEmail or subjectName and subjectSurname to restrict a search to the card circuit.

Response

The default response will only contain data in the subjects section to ensure fast responses.
Additional sections (contacts, cards, privacies etc..) can be retrieved by passing the related parameters (e.g. to obtain a customer contacts, returnContacts parameter must be "T").

In case of homonymous customers it will be returned the complete registry for the first customer only.
The array progIds will contain the identifiers for the other customer, along with an additionalData array containing some distinctive data for the customers.

E.g. for homonymous customers, additionalData will contain the birthday, address, zip code and city, to help identifying a customer.

A response example is:

    {
      "subjects": {
        "progId": 1365,
        "subjectCode": "1365",
        "subjectName": "MARIO",
        "subjectSurname": "ROSSI",
        "address1": "VIA ROMA",
        "zipCode": "20070",
        "city": "DRESANO",
        "sex": "M",
        "birthday": "1963-07-04 00:00:00",
        "mobile": "F",
        "mobileCreation": "F",
        "oldSubjectCode": "2872416",
        "discount": 15,
        "isCompany": "F",
        "validData": "T",
        "macAddress": "18:65:90:92:5B:32",
        "foreignPerson": "F",
        "subjectType": "FIDELITY",
        "subjectSubtype": "4",
        "country": "IT",
        "language": "IT",
        "province": "MI",
        "createDate": "2022-01-22 15:30:00",
        "lastUpdate": "2022-04-17 10:07:00"
      },
      "contacts": [
        {
          "contactType": "EMAIL",
          "value": "mario.rossi@gmail.com"
        },
        {
          "contactType": "CELL",
          "value": "3451234567"
        }
      ],
      "privacy": [
        {
          "privacyType": "MARKETING",
          "privacyConsent": "T",
          "consentDate": null,
          "recessDate": null
        },
        {
          "privacyType": "MERCATO",
          "privacyConsent": "T",
          "consentDate": null,
          "recessDate": null
        },
        {
          "privacyType": "CESSIONE",
          "privacyConsent": "T",
          "consentDate": null,
          "recessDate": null
        }
      ],
      "cards": [
        {
          "cardType": "FIDELITY",
          "cardSubtype": "3",
          "circuit": "BOGGI",
          "card": "9999997298594",
          "cardBarcode": "9999997298594",
          "active": "T",
          "issueDate": "2015-05-12 00:00:00",
          "activationDate": "2015-05-12 00:00:00",
          "expirationDate": null,
          "cardMaster": null,
          "cardFather": null,
          "cardMother": null,
          "entityCode": "1001",
          "earnedPoints": 2203
        }
      ],
      "mappings": [
        {
          "system": "TRADE",
          "externalCode": "2872416"
        },
        {
          "system": "DW",
          "externalField": "CUSTOMER_ID",
          "externalCode": "ab9aAtDaf5TaK6DmV2JNTzZ4Ic"
        },
        {
          "system": "DW",
          "externalField": "CUSTOMER_NO",
          "externalCode": "000050557"
        }
      ],
      "success": true,
      "progIds": [1234],
      "additionalData": [
          {
              progId: 1234, 
              city: "Rome", 
              birthday: "1950-01-12", 
              createDate: "2022-04-12 09:27:00",
              lastUpdate: "2022-06-04 15:40:00"
           }
       ]
    }

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
	"subjectCode": "{{subjectCode}}",
    "subjectName" :"{{subjectName}}",
    "returnContacts": "T",
    "returnPrivacies": "T",
    "returnCards": "T",
    "returnDestinations": "T",
    "returnMappings": "T",
    "returnMakeup": "T",
    "returnSources": "T"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request#

Response#

Request

Request Code Samples

Responses

Request

Response