Get By Email

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API.

With the input parameter Email (Subscriber’s email), the API gets the user's information from both the integration service and the subscribe registration. The response displays the combined information.

Based on the value of Flow.UserProvider and the IgnoreProvider input parameter, the API gives user information in the following way:

1. If no valid value is provided in Flow.UserProvider, the API retrieves user information from the Subscribe Registration API.

2. If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to True, the API retrieves user information from the Subscribe Registration API.

3. If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to False, the user's details are retrieved from both the integration service and the subscribe registration. The combined information is displayed in the response.

Comparison

Parameters

• The parameter, Type, has been deprecated.

• A new parameter, IgnoreProvider, has been added.

Note: The old model is in PascalCase, while the new model is in CamelCase.

	User API	Users Orchestrator API
URL	/User/{type}?email={email}	/v4/Users?email={email}&ignoreProvider={boolean}
Method	GET	GET
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "User": { "RegistrationId": 0, "LoginName": "string", "LoginPassword": "string", "CustomerRegistrationId": "string", "EncryptedCustomerRegistrationId": "string", "FirstName": "string", "LastName": "string", "Email": "string", "Gender": "string", "Phone": "string", "MobilePhone": "string", "OptInEVantageSubscriberRewards": true, "OptInSpecialOffers": true, "OptInContestAndPromotions": true, "OptInPaperlessBilling": true, "OptInEEdition": true, "OptInEEditionEmailNotification": true, "OptInSubscriberDiscounts": true, "OptInAdvertiserEmails": true, "MemberEvent": true, "ContentEngagement": true, "SUBCOM": true, "Survey": true, "AccountUpdates": true, "DateOfBirth": "string", "BirthYear": "string", "AcceptsEmailOffers": 0, "AcceptsEmailAds": 0, "AcceptsEmailPromotions": 0, "IsOkToEmail": 0, "IsOkToPhone": 0, "IsOkToMail": 0, "AcceptsEENotification": 0, "ChangeDate": "2023-06-05T18:43:26.752Z", "DateRegistered": "2023-06-05T18:43:26.752Z", "AddDate": "2023-06-05T18:43:26.752Z", "Photos": [ { "Id": "string", "Value": "string", "Type": "string" } ], "IsSocial": true, "DisplayName": "string", "AgreeToTerms": true, "OptOutMarketing": true, "Photo": "string", "VerificationCode": "string", "Verified": true, "AuthSystem": { "AuthSystemId": 0, "AuthSystemCode": "string", "AuthSystemName": "string" }, "UserState": { "UserStateId": 0, "UserStateCode": "string" }, "BounceType": "string", "LastLogoutDate": "2023-06-05T18:43:26.752Z", "UrlPasswordChangeTicket": "string", "Metadata": {} } }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": object, "data": [ { "customerRegistrationId": "string", "encryptedCustomerRegistrationId": "string", "email": "string", "verified": true, "firstName": "string", "lastName": "string", "state": UserState, "metadata": { "title": "", "phoneNumber": "", "gender": "", "age": "", "dob": "", "dobYYYY": "", "acceptsEmailOffers": "", "acceptsEmailAds": "", "acceptsEmailPromotions": "", "address": "", "city": "", "country": "", "position": "", "isOkToEmail": "", "isOkToPhone": "", "isOkToMail": "", "workPhone": "", "timeZone": "", "scoreMember": "", "companyName": "", "postalCode": "", "cellPhone": "", "acceptsEENotification": "", "ebill_flag": "", "eadvan_flag": "", "eedition_flag": "", "ee_email_flag": "", "promo_flag": "", "feat_flag": "", "dealdigger_flag": "", "ads_flag": "", "member_event_flag": "", "contentEngagement_flag": "", "subcom_flag": "", "survey_flag": "", "accountUpdates_flag": "", "photo": "", "displayName": "", "optOutMarketing": "", "agreeToTerms": "", "bounceType": "", } } ] }

---

Get By Email

GET /v4/Users?email={email}&ignoreProvider={boolean}

This endpoint is used to gets the user's information from both the integration service and the subscribe registration based on the Email.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Query Parameters

Name	Type	Description
IgnoreProvider	Boolean	Indicates whether to retrieve the user details from the integration service.
Email*	String	Subscriber’s email.

Headers

Name	Type	Description
Authorization*	String	JSON Web Token used for security purposes
X-SourceSystem*	String	To identify the consumer or the Source System
X-ClientCode*	String	Client Code of the Tenant
X-PaperCode*	String	Paper Code of the Tenant
X-ClientGroupCode*	String	Client Group Code of the Tenant

200

{
    "message": {
        "code": "UsersOrchestrator_S200_02",
        "text": "Get completed.",
        "type": "Success"
    },
    "data": [
        {
            "customerRegistrationId": "string",
            "encryptedCustomerRegistrationId": "string",
            "email": "string",
            "firstName": "string",
            "lastName": "string",
            "state": "UserStates",
            "metadata": {
                "title": "",
                "phoneNumber": "",
                "gender": "",
                "age": "",
                "dob": "",
                "dobYYYY": "",
                "acceptsEmailOffers": "",
                "acceptsEmailAds": "",
                "acceptsEmailPromotions": "",
                "address": "",
                "city": "",
                "country": "",
                "position": "",
                "isOkToEmail": "",
                "isOkToPhone": "",
                "isOkToMail": "",
                "workPhone": "",
                "timeZone": "",
                "scoreMember": "",
                "companyName": "",
                "postalCode": "",
                "cellPhone": "",
                "acceptsEENotification": "",
                "ebill_flag": "",
                "eadvan_flag": "",
                "eedition_flag": "",
                "ee_email_flag": "",
                "promo_flag": "",
                "feat_flag": "",
                "dealdigger_flag": "",
                "ads_flag": "",
                "member_event_flag": "",
                "contentEngagement_flag": "",
                "subcom_flag": "",
                "survey_flag": "",
                "accountUpdates_flag": "",
                "photo": "",
                "displayName": "",
                "optOutMarketing": "",
                "agreeToTerms": "",
                "bounceType": "",
            },
            "verified": true
        }
    ],
    "meta": {
        "totalRecords": 0
    }
}

400

1. Error Code: UsersOrchestrator_E400_02 Error Message: Invalid InputModel

2. Error Code: UsersOrchestrator_E400 Error Message: Bad Request

500

1. Error Code: UsersOrchestrator_E500 Error Message: Internal Server Error

2. Error Code: UsersOrchestrator_E500_02

   Error Message: There was a problem during the Get workflow.

Events

Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.

Current	New	Note
GETUSER (73)	AUTHSYSTEM_USER_GET (4601)	Renamed. This event retrieves a User by Id from AuthSystem.
CREATELOGIN (68)	-	No user will be created but synchronized in our database
-	SUBSCRIBE_USER_UPDATE (4004)	New event to update User in Subscribe
-	SUBSCRIBE_USER_GET (4000)	New event to retrieve User from Subscribe