Express Optout
Purpose
Participant opt-out from services - functionality exposed as an externally accessible synchronous RESTful endpoint.
Overview
Input Parameters
Required Parameters
The following parameters are mandatory for successful opt-out:
- Client Id: Your organization identifier
- Participant ID: Participant identifier
- FirstName: Participant first name
- LastName: Participant last name
- Optout info: Opt-out information object
| Parameter | Required | Description |
|---|---|---|
| Client Id | required | Your organization identifier |
| Participant ID | required | Participant identifier |
| FirstName | required | Participant first name |
| LastName | required | Participant last name |
| Optout info | required | Opt-out information |
| Reason | optional | Reason for opt-out |
| Transaction HTTP Endpoint | optional | Transaction endpoint |
Output (Success)
| Field | Description |
|---|---|
| Optout Result | Details about the opt-out operation |
Output (Error)
| Field | Description |
|---|---|
| Error Object | Error details and messages |
API Endpoint
Invoke Optout
UAT
POST https://api-uat.morningstar.com/rm/v1/express/optout
Production
POST https://api.morningstar.com/rm/v1/express/optout
Request Headers
Required Headers
Content-Type: application/json
Authorization: Bearer {access_token}
Sample Requests & Responses
Request Payload
{
"ClientId": "ABCD",
"FirstName": "First Name",
"LastName": "Last Name",
"OptoutInfo": [
{
"PlanId": "planId",
"PlanType": "Plan Type"
}
],
"ParticipantId": "articipant Id (UserID)",
"TransactionHTTPEndpoint":
{
"TransURL": "https://www.test.com/gettransaction",
"SID": "sdhgjkjhgfdgujytrfrthwfwdfter",
"Cookie": "wesrtdfgyuhjkftdtyg"
}
}
Success Response
{
"OptOutResult": {
"Success": true,
"ErrorMessage": "",
"TransactionId": "123",
"ClientTransactionId": "456",
"RKTransactionId": "789",
"RKTransactionMessage": "",
"TransactionState": "",
"TransactionReturnCode": "",
"TransactionData": "",
"HtmlTransactionConfirmation": true,
"ClientId": "ABCD"
},
"Transaction": "ENCODED TRANSACTION XML"
}
Data Tables
Input Data Points
Total: 0Required: 0Optional: 0Showing: 0
Parameter | Type | Required | Description | Example |
|---|
No parameters found
No parameters found
Output Data Points
Total: 0Showing: 0
Parameter | Type | Description | Example |
|---|
No parameters found
No parameters found