Get By Query String

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to retrieve the user's information based on the provided Query String parameters.

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.

Note

• MG2 control flow setting: Flow.UserProvider value should be set to "Auth0," "Gigya," "SSOR", or "Firefly", depending on the third-party system or integration service being used.

• MG2 control flow setting, "Flow.Users.RedirectToOrchestrator", value has to be set to 1 for the ProxyAPI redirection to the UsersOrchestratorAPI instead of the UserAPI.

Comparison

Parameters

• The following parameters have been deprecated.

  1. Type

  2. OnlyActive

  3. SortBy

  4. SortOrder

  5. UsersPerPage

  6. LookupInUserProvider

  7. AuthSystemId

• A set of new parameters has been added.

  1. PageSize

  2. OrderBy

  3. OrderByType

  4. IgnoreProvider

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

	User API	Users Orchestrator API
URL	/User/{queryString}	/v4/Users/{queryString}
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 User by Query String

GET /v4/Users/{queryString}

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

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

Path Parameters

Name	Type	Description
CustomerRegistrationId*	String	Unique identifier for the user in the authentication provider.

Query Parameters

Name	Type	Description
IgnoreProvider	Boolean	Indicates whether to retrieve the user details from the integration service.
EncryptedEmail	String	Encrypted email of the user
Email	String	Email or partial email address of the user
PageSize	Integer	Maximum number of items returned per request. Default value 10.
PageNumber	Integer	Requested page number of pagination. Default value 1.
OrderByType	Integer	Sort the records in ascending (0) or descending (1) order.
OrderBy	Integer	Sort the records based on the column number.
FirstName	String	User’s first name.
LastName	String	User’s last name.
Metadata	Dictionary <String, String>	Since it is a dictionary query parameter, each "Key-Value" pair must be sent individually with the prefix "metadata.". For example, if the purpose is to filter users based on their first and last names, the query string will be: https://UrlBase/Users?metadata.firstName=FirstName&metadata.lastName=LastName”

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 Error Message: Bad Request

2. Error Code: UsersOrchestrator_E400_02

   Error Message: Invalid InputModel

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
-	SUBSCRIBE_USER_GET (4000)	New event created to get User from Subscribe