1. Getting Started REST APIREST API for Oracle Loyalty Cloud
  2. Use Cases
  3. Enroll a Member to a Loyalty Program

Enroll a Member to a Loyalty Program

If you want to enroll a member to a particular loyalty program in Oracle Loyalty Cloud using the REST API , then review this example use case which shows you how to do exactly that. You can view the membership details by performing a membership inquiry after enrolling the member.

See the following examples:

Enroll a Member to a Loyalty Program

You can enroll a member to a specified loyalty program, for example, to a loyalty program called A2Z Bank.

Example URL

The following is an example of the resource URL.

POST

https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers

Example Request Body

The following is an example of the request body.

{
   "LoyProgramName": "A2Z Bank", 
   "PassEmailAddress": "john.doh@fakesite.com", 
   "ContactFirstName": "John", 
   "ContactLastName": "Doh", 
   "MobileNumber": "6769866986" 
}

Example Response

The following is an example of the response body.

{
    "LoyMemberId": 300100129329080,
    "MemberClassCode": null,
    "MemberGrpCode": null,
    "MemberNumber": "300100129329081",
    "MemberPhaseCode": null,
    "MemberTypeCode": "ORA_MEM_TYPE_INDIVIDUAL",
    "MemberName": "John Doh",
    "PrConId": 300100129329082,
    "StatusCode": "ORA_MEM_STATUS_ACTIVE",
    "ValLifeScore": null,
    "StartDate": "2018-08-21T16:41:23.890+00:00",
    "SysEffectiveDate": null,
    "PersonName": null,
    "ContactDateOfBirth": null,
    "ReferredByName": null,
    "ReferredByNam": null,
    "PointTypeAVal": 0,
    "RelationshipId": null,
    "CorpCurrencyCode": "USD",
    "CurcyConvRateType": "Corporate",
    "CurrencyCode": "USD",
    "RelationshipType": null,
    "RelationshipRecId": null,
    "reltype": null,
    "ReferConId": null,
    "EmailAddress": null,
    "FormattedPhoneNumber": null,
    "TierName": "Bronze",
    "Points": "0",
    "AccrualTypeCode": null,
    "AccntId": null,
    "ContactName": "John Doh",
    "AccrualToMemId": null,
    "AccrualToHouseholdFlag": null,
    "OrgGroupId": null,
    "AccrualStartDate": null,
    "ApprovalDate": null,
    "ApprByEmployeeId": null,
    "CreationSource": null,
    "ContactId": null,
    "CurrencyDate": null,
    "CorpMemberNumber": null,
    "ChildNumber": null,
    "DateOfBirth": null,
    "DescriptionText": null,
    "DisplaySequence": null,
    "ExpiryDate": null,
    "HomeAirport": null,
    "IncompleteFlights": null,
    "LftmPointTypeBVal": null,
    "LftmPointTypeCVal": null,
    "LftmPointTypeDVal": null,
    "LftmPointTypeEVal": null,
    "LftmPointTypeFVal": null,
    "LftmPointTypeGVal": null,
    "LftmPointTypeHVal": null,
    "LoungeStartDt": null,
    "LoungeBuyEndDt": null,
    "LoungeCode": null,
    "LoungeBuyCode": null,
    "LastAccrTransactionDt": null,
    "LastRdmTransactionDt": null,
    "LoungeEndDate": null,
    "LoungeBuyStartDt": null,
    "LoyLstStmtDt": null,
    "LstStmtId": null,
    "LstTierChangeDt": null,
    "LoungeNumber": null,
    "LastTransactionProcedDt": null,
    "LftmPointTypeAVal": null,
    "MaximumPointStatCode": null,
    "MembershipSchemeId": null,
    "MaximumPointLoan": null,
    "MaximumPointTypeId": null,
    "MemberClassMeaning": null,
    "MemberPhaseMeaning": null,
    "ParMemberId": null,
    "ParentMember": "N",
    "PINNumber": null,
    "PnrName": null,
    "PointTypeBVal": 0,
    "PointTypeCVal": 0,
    "PointTypeDVal": 0,
    "PointTypeEVal": 0,
    "PointTypeFVal": 0,
    "PointTypeGVal": 0,
    "PointTypeHVal": 0,
    "PassContactFirstName": null,
    "PassContactLastName": null,
    "PassContactName": null,
    "PassEmailAddress": "john.doh@fakesite.com",
    "PassMobileNumber": null,
    "PassWorkPhoneNumber": null,
    "PrAddrId": null,
    "PrDomTierId": null,
    "PrPostnId": null,
    "PreferCommMethCode": null,
    "ReceivePromotion": "N",
    "RecPtnrPromotion": "N",
    "RegChannelCode": null,
    "RootMemId": null,
    "ReferredByNumber": null,
    "StmtMthdCode": null,
    "StmtTypeCode": null,
    "SubmitDate": null,
    "SubmitToEmployeeId": null,
    "SuppressCall": "N",
    "SuppressEmail": "N",
    "SuppressFax": "N",
    "SuppressMail": "N",
    "SuppressSMS": "N",
    "ValScore": null,
    "GroupLookupType": null,
    "GroupLookupCode": null,
    "AccrualMeaning": null,
    "AccrualLookupType": null,
    "AccrualLookupCode": null,
    "PreviousTierName": null,
    "WorkPhoneNumber": null,
    "PhoneNumber": null,
    "PersonLastName": null,
    "PersonFirstName": null,
    "PartyName": null,
    "MemberEmailAddress": null,
    "MobileNumber": "6769866986",
    "LoyProgramName": "A2Z Bank",
    "LoyHouseholdName": null,
    "LoyAccountName": null,
    "AddressLineOne": null,
    "AddressLineTwo": null,
    "AddressLineThree": null,
    "City": null,
    "Country": null,
    "County": null,
    "PostalCode": null,
    "Province": null,
    "State": null,
    "JobTitle": null,
    "URL": null,
    "AccrualToHousehold": null,
    "HouseholdMemberNumber": null,
    "ContactFirstName": "John",
    "ContactLastName": "Doh",
    "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "CreationDate": "2018-08-21T16:41:23+00:00",
    "LastUpdateDate": "2018-08-21T16:41:23.760+00:00",
    "LastUpdateLogin": "73E1D726179B0058E05334C4F00A2219",
    "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "AccountTypeCode": "ZCA_PROSPECT",
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
            "name": "loyMembers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000778"
            }
        },
        {
            "rel": "canonical",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
            "name": "loyMembers",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/PersonLOV",
            "name": "PersonLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberPhase",
            "name": "MemberPhase",
            "kind": "collection"
        },
.
.
.
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTransactions",
            "name": "MemberTransactions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTier",
            "name": "MemberTier",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/cards",
            "name": "cards",
            "kind": "collection"
        }
    ]
}

Get the Membership Details for a Particular Member

You can retrieve the membership details for a specific member, for example, for the member you enrolled to the loyalty program, member number 300100129329081.

Example URL

The following is an example of the resource URL.

GET

https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081

Example Response

The following is an example of the response body.

{
    "LoyMemberId": 300100129329080,
    "MemberClassCode": null,
    "MemberGrpCode": null,
    "MemberNumber": "300100129329081",
    "MemberPhaseCode": null,
    "MemberTypeCode": "ORA_MEM_TYPE_INDIVIDUAL",
    "MemberName": "John Doh",
    "PrConId": 300100129329082,
    "StatusCode": "ORA_MEM_STATUS_ACTIVE",
    "ValLifeScore": null,
    "StartDate": "2018-08-21T16:41:23.890+00:00",
    "SysEffectiveDate": null,
    "PersonName": null,
    "ContactDateOfBirth": null,
    "ReferredByName": null,
    "ReferredByNam": null,
    "PointTypeAVal": 0,
    "RelationshipId": null,
    "CorpCurrencyCode": "USD",
    "CurcyConvRateType": "Corporate",
    "CurrencyCode": "USD",
    "RelationshipType": null,
    "RelationshipRecId": null,
    "reltype": null,
    "ReferConId": null,
    "EmailAddress": null,
    "FormattedPhoneNumber": null,
    "TierName": "Bronze",
    "Points": "0",
    "AccrualTypeCode": null,
    "AccntId": null,
    "ContactName": "John Doh",
    "AccrualToMemId": null,
    "AccrualToHouseholdFlag": null,
    "OrgGroupId": null,
    "AccrualStartDate": null,
    "ApprovalDate": null,
    "ApprByEmployeeId": null,
    "CreationSource": null,
    "ContactId": null,
    "CurrencyDate": null,
    "CorpMemberNumber": null,
    "ChildNumber": null,
    "DateOfBirth": null,
    "DescriptionText": null,
    "DisplaySequence": null,
    "ExpiryDate": null,
    "HomeAirport": null,
    "IncompleteFlights": null,
    "LftmPointTypeBVal": null,
    "LftmPointTypeCVal": null,
    "LftmPointTypeDVal": null,
    "LftmPointTypeEVal": null,
    "LftmPointTypeFVal": null,
    "LftmPointTypeGVal": null,
    "LftmPointTypeHVal": null,
    "LoungeStartDt": null,
    "LoungeBuyEndDt": null,
    "LoungeCode": null,
    "LoungeBuyCode": null,
    "LastAccrTransactionDt": null,
    "LastRdmTransactionDt": null,
    "LoungeEndDate": null,
    "LoungeBuyStartDt": null,
    "LoyLstStmtDt": null,
    "LstStmtId": null,
    "LstTierChangeDt": null,
    "LoungeNumber": null,
    "LastTransactionProcedDt": null,
    "LftmPointTypeAVal": null,
    "MaximumPointStatCode": null,
    "MembershipSchemeId": null,
    "MaximumPointLoan": null,
    "MaximumPointTypeId": null,
    "MemberClassMeaning": null,
    "MemberPhaseMeaning": null,
    "ParMemberId": null,
    "ParentMember": "N",
    "PINNumber": null,
    "PnrName": null,
    "PointTypeBVal": 0,
    "PointTypeCVal": 0,
    "PointTypeDVal": 0,
    "PointTypeEVal": 0,
    "PointTypeFVal": 0,
    "PointTypeGVal": 0,
    "PointTypeHVal": 0,
    "PassContactFirstName": null,
    "PassContactLastName": null,
    "PassContactName": null,
    "PassEmailAddress": "john.doh@fakesite.com",
    "PassMobileNumber": null,
    "PassWorkPhoneNumber": null,
    "PrAddrId": null,
    "PrDomTierId": null,
    "PrPostnId": null,
    "PreferCommMethCode": null,
    "ReceivePromotion": "N",
    "RecPtnrPromotion": "N",
    "RegChannelCode": null,
    "RootMemId": null,
    "ReferredByNumber": null,
    "StmtMthdCode": null,
    "StmtTypeCode": null,
    "SubmitDate": null,
    "SubmitToEmployeeId": null,
    "SuppressCall": "N",
    "SuppressEmail": "N",
    "SuppressFax": "N",
    "SuppressMail": "N",
    "SuppressSMS": "N",
    "ValScore": null,
    "GroupLookupType": null,
    "GroupLookupCode": null,
    "AccrualMeaning": null,
    "AccrualLookupType": null,
    "AccrualLookupCode": null,
    "PreviousTierName": null,
    "WorkPhoneNumber": null,
    "PhoneNumber": null,
    "PersonLastName": null,
    "PersonFirstName": null,
    "PartyName": null,
    "MemberEmailAddress": null,
    "MobileNumber": "6769866986",
    "LoyProgramName": "A2Z Bank",
    "LoyHouseholdName": null,
    "LoyAccountName": null,
    "AddressLineOne": null,
    "AddressLineTwo": null,
    "AddressLineThree": null,
    "City": null,
    "Country": null,
    "County": null,
    "PostalCode": null,
    "Province": null,
    "State": null,
    "JobTitle": null,
    "URL": null,
    "AccrualToHousehold": null,
    "HouseholdMemberNumber": null,
    "ContactFirstName": "John",
    "ContactLastName": "Doh",
    "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "CreationDate": "2018-08-21T16:41:23+00:00",
    "LastUpdateDate": "2018-08-21T16:41:23.760+00:00",
    "LastUpdateLogin": "73E1D726179B0058E05334C4F00A2219",
    "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
    "AccountTypeCode": "ZCA_PROSPECT",
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
            "name": "loyMembers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000778"
            }
        },
        {
            "rel": "canonical",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
            "name": "loyMembers",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/PersonLOV",
            "name": "PersonLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberPhase",
            "name": "MemberPhase",
            "kind": "collection"
        },
.
.
.
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTransactions",
            "name": "MemberTransactions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTier",
            "name": "MemberTier",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/cards",
            "name": "cards",
            "kind": "collection"
        }
    ]
}