Get By Encrypted Id

Introduction

This endpoint retrieves the user's information from both the integration service and the subscribe registration based on the input parameter Encrypted Customer Registration ID.

With the input parameter Encrypted CRID, the API gets the user's information from both the integration service and the subscribe registration. The response displays the combined information.

Comparison

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

	User API	Users Orchestrator API
URL	/User/Encrypted/{Type}?encryptedCustomerRegistrationId={encryptedCustomerRegistrationId}	/v4/Users?encryptedCustomerRegistrationId={encryptedCustomerRegistrationId}
Method	GET	GET
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "Users": [ { "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.757Z", "DateRegistered": "2023-06-05T18:43:26.757Z", "AddDate": "2023-06-05T18:43:26.757Z", "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.757Z", "UrlPasswordChangeTicket": "string", "Metadata": {} } ], "TotalUsersFound": 0 }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": { "totalRecords": 0 }, "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 Encrypted ID

GET /v4/Users?encryptedCustomerRegistrationId={encryptedCustomerRegistrationId}

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

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

Query Parameters

Name	Type	Description
Encrypted Customer Registration ID*	String	Encrypted unique identifier for the user in authentication system.

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": "string",
        "text": "string",
        "type": 0
    },
    "meta": {
        "totalRecords": 0
    },
    "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": "",
            }
        }
    ]
}

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