Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Media Publishing Suite > Interface and Integration Definitions for Campaign Management

Interface and Integration Definitions for Campaign Management

Overview

This document describes the API methods used for Campaign Management when integrating with the Aria Media and Publishing Suite (AMPS). The Campaign Management component of AMPS is a set of generic components that are designed for use within both standard AMPS implementations and customer-specific workflows. This document describes the Campaign Management functionality to manage campaigns that can be applied to products purchased by the end-customer under certain circumstances. It defines the campaign details as well as the sequence in which they are checked for eligibility. 

Campaign Management

This section contains the definition of the APIs provided by the Campaign Management component of AMPS. The following APIs are provided:

Each of the above APIs are described below. 
 

Retrieve Campaign Detail (JSON API)

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/CampaignManagement/CampRetrieveCampDetails
 

CampRetrieveCampDetailRequest

The campRetrieveCampDetailRequest is a JSON formatted request structure used by the caller to retrieve details on a single campaign or all campaigns currently registered. 

Sample 1
A sample request used to retrieve a single campaign.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "campRetrieveCampDetailSearch": {
        “specificSearch”: “SPECIFIC”
        "campID": "CAMP-1"
    }
}

The individual data elements of msgAuthDetails are defined with another Request. The individual data elements of campRetrieveCampDetailSearch are defined as follows:

  • specificSearch – contains a code indicating whether all campaigns or only a single campaign is to be returned. The following codes apply:
    • ALL” – all campaigns are returned.
    • SPECIFIC” – only the specified campaign is returned.
  • campID – contains the identification of the campaign to be returned. Used only when specificSearch contains “SPECIFIC”. Otherwise it is empty. 



CampRetrieveCampDetailResponse

The campRetrieveCampDetailResponse is a JSON formatted response structure used to return details on the requested campaigns. Multiple entries may exist depending on the search performed. 

Sample 1
A sample response showing a single campaign with multiple titles and with restrictions. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "campRetrieveCampDetailList": [
        {
            "campRetrieveCampDetailInfo": {
                "campID": "CAMP-1",
                "campName": "CAMPAIGN-1",
                "campDesc": "Description of Campaign-1",
                "campStatus": "ACTIVE",
                "campEligibility": "ANY",
                "campDurUnit": "WEEKS",
                "campDurLength": 5,
                "campDurEndDate": "",
                "campBillingCode": "IMMEDIATE",
                "campBillingSKU": "CAMP-1",
                "campBillingPrice": 9.99
            },
            "campRetrieveCampDetailAddInfo": {
                "campNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Name"}
                    ]
                },
                "campDescTranslations": {
                    "solmRefTransNo": 1235,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Description"}
                    ]
                ]
            },
            "campRetrieveCampDetailListTitles": [
                {
                    "campRetrieveCampDetailInfoTitles": {
                        "titleCode": "XX",
                        "campPlanID": "XX-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campRetrieveCampDetailAddInfoTitles": {
                        "titleName": "XX Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX Title Name"}
                            ]
                        },
                        "campPlanName": "XX-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": "a",
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX-FULL-DIGITAL"}
                            ]
                        }
                    }
                },
                {
                    "campRetrieveCampDetailInfoTitles": {
                        "titleCode": "YY",
                        "campPlanID": "YY-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campRetrieveCampDetailAddInfoTitles": {
                        "titleName": "YY Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY Title Name"}
                            ]
                        },
                        "campPlanName": "YY-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": 112244,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY-FULL-DIGITAL"}
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 

The campRetrieveCampDetailList contains an array of the campaign entries returned. The structures are described below:

  • campRetrieveCampDetailInfo – a structure holding the general information on the campaign. 
    • campID – contains the identification of the campaign returned 
    • campName – contains the name of the campaign
    • campDesc – contains the brief description of the campaign
    • campStatus – contains the status of the campaign. The following codes apply
      • DEFINITION” – the campaign is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the campaign is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the campaign is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the campaign is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the campaign is deprecated and cannot be selected for sales on the web sites. Status can only be set when no more customers are actively using the campaign.  
    • campEligibility - contains a code indicating what kind of restrictions that apply to the campaign. The following codes apply: 
      • "ANY" – no restrictions apply
      • "INVITATION" – customer can select the campaign only if invited
      • "RESTRICTION" – customer can select the campaign only if certain restrictions are fulfilled. 
    • campDurUnit – contains a code indicating the unit used to represent the length of the campaign. The following codes apply:
      • "DAYS" – the duration is expressed in days.
      • "WEEKS" – the duration is expressed in weeks.
      • "MONTHS" – the duration is expressed in months.
    • campDurLength – contains the number of units (days, weeks or months) the campaign runs. 
    • campDurEndDate – contains the end-date of the campaign, irrespective of the start date. If used, then the campaign duration unit and length is not used. 
    • campBillingCode – contains a code indicating when the charge for the campaign is billed to the end-customer. The following codes apply:
      • "IMMEDIATE" – the charge is billed immediate and a separate notice is sent to the customer. 
      • "ANNIVERSARY" – the charge is billed at the next anniversary date of the end-customer. 
    • campBillingSKU – contains the SKU used to make the initial charge when this campaign is selected. 
    • campBillingPrice – contains the price to charge the end-customer for this campaign. 
  • campRetrieveCampDetailAddInfo – a structure holding additional information on the campaign. 
    • campNameTranslations – contains the translations related to the campaign name.
      • solmRefTransNo – contains the identification of the translation for this campaign name. 
      • solmTranslationEntry – an array containing an element for each locale the campaign name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign name is returned.
        • solmRefTransText– contains the name of the campaign name in the locale (language) described by solmLocaleID
    • campDescTranslations – contains the translations related to the campaign description. 
      • solmRefTransNo – contains the identification of the translation for this campaign description. 
      • solmTranslationEntry – an array containing an element for each locale the campaign description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign description is returned
        • solmRefTransText– contains the name of the campaign description in the locale (language) described by solmLocaleID
  • campRetrieveCampDetailListTitles – a structure holding the array of titles for which the campaign is applicable. Multiple entries may exist. 
    • campRetrieveCampDetailInfoTitles – a structure that holds general information on the titles associated with the campaign.
      • titleCode – contains the identification of the title for which the campaign is applicable. 
      • campPlanID – contains the identification of the Aria Core product that is used when the title is purchased
      • campRecurringRSID – contains the identification of the Aria Core recurring rate schedule to be used with this title. If blank, the default is used. 
    • campRetrieveCampDetailAddInfoTitles – a structure holding additional information on the title. 
      • titleName – contains the name of the title
      • titleNameTranslations – contains the translations related to the title name. 
        • solmRefTransNo – contains the identification of the translation for this title. 
        • solmTranslationEntry – an array containing an element for each locale the title is returned in. 
          • solmLocaleID – contains the ID of the locale in which the title is returned
          • solmRefTransText– contains the name of the title in the locale (language) described by solmLocaleID
      • campPlanName – contains the name of the plan associated with the title
      • campPlanNameTranslations – contains the translations related to the campaign plan.
        • solmRefTransNo – contains the identification of the translation for this campaign plan. 
        • solmTranslationEntry – an array containing an element for each locale the campaign plan is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign plan is returned
          • solmRefTransText– contains the name of the campaign plan in the locale (language) described by solmLocaleID
             

Manage Campaign Detail (JSON API)

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/CampaignManagement/CampManageCampDetail
 

CampManageCampDetailRequest

The campManageCampDetailRequest is a JSON formatted request structure used by the caller to add, modify or remove campaigns. Multiple operations can be provided in the same request

Sample 1
A sample request used to add a new campaign with a list of titles and restrictions. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "campManageCampDetailList": [
        {
            "campManageCampDetailActionInfo": {
                "campManageCampDetailAction": "ADD"
            },
            "campManageCampDetailInfo": {
                "campID": "CAMP-1",
                "campName": "CAMPAIGN-1",
                "campDesc": "Description of Campaign-1",
                "campStatus": "ACTIVE",
                "campEligibility": "ANY",
                "campDurUnit": "WEEKS",
                "campDurLength": 5,
                "campDurEndDate": "",
                "campBillingCode": "IMMEDIATE",
                "campBillingSKU": "CAMP-1",
                "campBillingPrice": 9.99
            },
            "campManageCampDetailAddInfo": {
                "campNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Name"}
                    ]
                },
                "campDescTranslations": {
                    "solmRefTransNo": 1235,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Description"}
                    ]
                ]
            },
            "campManageCampDetailListTitles": [
                {
                    "campManageCampDetailInfoTitles": {
                        "titleCode": "XX",
                        "campPlanID": "XX-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campManageCampDetailAddInfoTitles": {
                        "titleName": "XX Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX Title Name"}
                            ]
                        },
                        "campPlanName": "XX-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": "a",
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX-FULL-DIGITAL"}
                            ]
                        }
                    }
                },
                {
                    "campManageCampDetailInfoTitles": {
                        "titleCode": "YY",
                        "campPlanID": "YY-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campManageCampDetailAddInfoTitles": {
                        "titleName": "YY Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY Title Name"}
                            ]
                        },
                        "campPlanName": "YY-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": 112244,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY-FULL-DIGITAL"}
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The campManageCampDetailList structure contains an entry for each operation to perform on the campaigns. Each entry contains the attributes described below:

  • campManageCampDetailActionInfo – the action control structure.
    • campManageCampDetailAction – contains the action to perform. “ADD” adds a new campaign; “MODIFY” modifies an existing campaign while “REMOVE” removes an existing campaign. 
  • campManageCampDetailInfo – a structure holding the general information on the campaign. 
    • campID – contains the identification of the campaign returned.
    • campName – contains the name of the campaign.
    • campDesc – contains the brief description of the campaign.
    • campStatus – contains the status of the campaign. The following codes apply:
      • DEFINITION” – the campaign is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the campaign is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the campaign is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the campaign is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the campaign is deprecated and cannot be selected for sales on the web sites. Status can only be set when no more customers are actively using the campaign.  
    • campEligibility - contains a code indicating what kind of restrictions that apply to the campaign. The following codes apply: 
      • "ANY" – no restrictions apply.
      • "INVITATION" – customer can select the campaign only if invited.
      • "RESTRICTION" – customer can select the campaign only if certain restrictions are fulfilled. 
    • campDurUnit – contains a code indicating the unit used to represent the length of the campaign. The following codes apply:
      • "DAYS" – the duration is expressed in days.
      • "WEEKS" – the duration is expressed in weeks.
      • "MONTHS" – the duration is expressed in months.
    • campDurLength – contains the number of units (days, weeks or months) the campaign runs. 
    • campDurEndDate – contains the end-date of the campaign, irrespective of the start date. If used, then the campaign duration unit and length is not used. 
    • campBillingCode – contains a code indicating when the charge for the campaign is billed to the end-customer. The following codes apply:
      • "IMMEDIATE" – the charge is billed immediate and a separate notice is sent to the customer. 
      • "ANNIVERSARY" – the charge is billed at the next anniversary date of the end-customer. 
    • campBillingSKU – contains the SKU used to make the initial charge when this campaign is selected. 
    • campBillingPrice – contains the price to charge the end-customer for this campaign. 
  • campManageCampDetailAddInfo – a structure holding additional information on the campaign. 
    • campNameTranslations – contains the translations related to the campaign name 
      • solmRefTransNo – contains the identification of the translation for this campaign name. 
      • solmTranslationEntry – an array containing an element for each locale the campaign name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign name is returned
        • solmRefTransText– contains the name of the campaign name in the locale (language) described by solmLocaleID
    • campDescTranslations – contains the translations related to the campaign description. 
      • solmRefTransNo – contains the identification of the translation for this campaign description. 
      • solmTranslationEntry – an array containing an element for each locale the campaign description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign description is returned
        • solmRefTransText– contains the name of the campaign description in the locale (language) described by solmLocaleID
  • campManageCampDetailListTitles – a structure holding the array of titles for which the campaign is applicable. Multiple entries may exist. 
    • campManageCampDetailInfoTitles – a structure that holds general information on the titles associated with the campaign.
      • titleCode – contains the identification of the title for which the campaign is applicable. 
      • campPlanID – contains the identification of the Aria Core product that is used when the title is purchased
      • campRecurringRSID – contains the identification of the Aria Core recurring rate schedule to be used with this title. If blank, the default is used. 
    • campManageCampDetailAddInfoTitles – a structure holding additional information on the title. 
      • titleName – contains the name of the title
      • titleNameTranslations – contains the translations related to the title name. 
        • solmRefTransNo – contains the identification of the translation for this title. 
        • solmTranslationEntry – an array containing an element for each locale the title is returned in. 
          • solmLocaleID – contains the ID of the locale in which the title is returned
          • solmRefTransText– contains the name of the title in the locale (language) described by solmLocaleID
      • campPlanName – contains the name of the plan associated with the title
      • campPlanNameTranslations – contains the translations related to the campaign plan.
        • solmRefTransNo – contains the identification of the translation for this campaign plan. 
        • solmTranslationEntry – an array containing an element for each locale the campaign plan is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign plan is returned
          • solmRefTransText– contains the name of the campaign plan in the locale (language) described by solmLocaleID

CampManageCampDetailResponse

The campManageCampDetailResponse is a JSON formatted response structure returned in response to the campManageCampDetailRequest. 

Sample 1
A sample response returned when a new campaign has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "campManageCampDetailListResponse": [
        {
            "campManageCampDetailActionInfoResponse": {
                "campManageCampDetailAction": "ADD",
                "resultCode": 0,
                "resultText": "OK"
            },
            "campManageCampDetailInfo": {
                "campID": "CAMP-1",
                "campName": "CAMPAIGN-1",
                "campDesc": "Description of Campaign-1",
                "campStatus": "ACTIVE",
                "campEligibility": "ANY",
                "campDurUnit": "WEEKS",
                "campDurLength": 5,
                "campDurEndDate": "",
                "campBillingCode": "IMMEDIATE",
                "campBillingSKU": "CAMP-1",
                "campBillingPrice": 9.99
            },
            "campManageCampDetailAddInfo": {
                "campNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Name"}
                    ]
                },
                "campDescTranslations": {
                    "solmRefTransNo": 1235,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Description"}
                    ]
                ]
            },
            "campManageCampDetailListTitles": [
                {
                    "campManageCampDetailInfoTitles": {
                        "titleCode": "XX",
                        "campPlanID": "XX-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campManageCampDetailAddInfoTitles": {
                        "titleName": "XX Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX Title Name"}
                            ]
                        },
                        "campPlanName": "XX-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": "a",
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "XX-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "XX-FULL-DIGITAL"}
                            ]
                        }
                    }
                },
                {
                    "campManageCampDetailInfoTitles": {
                        "titleCode": "YY",
                        "campPlanID": "YY-FULL-DIGITAL,
                        "campRecurringRSID": ""
                    },
                    "campManageCampDetailAddInfoTitles": {
                        "titleName": "YY Title Name",
                        "titleNameTranslations": {
                            "solmRefTransNo": 112233,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY Title Name"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY Title Name"}
                            ]
                        },
                        "campPlanName": "YY-FULL-DIGITAL",
                        "campPlanNameTranslations": {
                            "solmRefTransNo": 112244,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "YY-FULL-DIGITAL"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "YY-FULL-DIGITAL"}
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 

The campManageCampDetailListResponse structure contains the different actions to perform on the listed dates. The structure contains an array entry for each update to perform. The updates are performed for the title given above. Each entry contains the attributes described below:

  • campManageCampDetailActionInfoResponse – the action control response structure.
    • campManageCampDetailAction – contains the action to perform. “ADD” adds a new campaign; “MODIFY” modifies an existing campaign while “REMOVE” removes an existing campaign. 
    • resultCode – contains the result of the request processing for a given action. A value of 0 (zero) indicates success. Other codes indicate failure. 
    • resultText – contains a short text describing the error encountered for a given action. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 
  • campManageCampDetailInfo – a structure holding the general information on the campaign. 
    • campID – contains the identification of the campaign returned.
    • campName – contains the name of the campaign.
    • campDesc – contains the brief description of the campaign.
    • campStatus – contains the status of the campaign. The following codes apply:
      • DEFINITION” – the campaign is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the campaign is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the campaign is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the campaign is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the campaign is deprecated and cannot be selected for sales on the web sites. Status can only be set when no more customers are actively using the campaign.  
    • campEligibility - contains a code indicating what kind of restrictions that apply to the campaign. The following codes apply: 
      • "ANY" – no restrictions apply
      • "INVITATION" – customer can select the campaign only if invited
      • "RESTRICTION" – customer can select the campaign only if certain restrictions are fulfilled. 
    • campDurUnit – contains a code indicating the unit used to represent the length of the campaign. The following codes apply:
      • "DAYS" – the duration is expressed in days.
      • "WEEKS" – the duration is expressed in weeks.
      • "MONTHS" – the duration is expressed in months.
    • campDurLength – contains the number of units (days, weeks or months) the campaign runs. 
    • campDurEndDate – contains the end-date of the campaign, irrespective of the start date. If used, then the campaign duration unit and length is not used. 
    • campBillingCode – contains a code indicating when the charge for the campaign is billed to the end-customer. The following codes apply:
      • "IMMEDIATE" – the charge is billed immediate and a separate notice is sent to the customer. 
      • "ANNIVERSARY" – the charge is billed at the next anniversary date of the end-customer. 
    • campBillingSKU – contains the SKU used to make the initial charge when this campaign is selected. 
    • campBillingPrice – contains the price to charge the end-customer for this campaign. 
  • campManageCampDetailAddInfo – a structure holding additional information on the campaign. 
    • campNameTranslations – contains the translations related to the campaign name 
      • solmRefTransNo – contains the identification of the translation for this campaign name. 
      • solmTranslationEntry – an array containing an element for each locale the campaign name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign name is returned
        • solmRefTransText– contains the name of the campaign name in the locale (language) described by solmLocaleID
    • campDescTranslations – contains the translations related to the campaign description. 
      • solmRefTransNo – contains the identification of the translation for this campaign description. 
      • solmTranslationEntry – an array containing an element for each locale the campaign description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign description is returned
        • solmRefTransText– contains the name of the campaign description in the locale (language) described by solmLocaleID
  • campManageCampDetailListTitles – a structure holding the array of titles for which the campaign is applicable. Multiple entries may exist. 
    • campManageCampDetailInfoTitles – a structure that holds general information on the titles associated with the campaign.
      • titleCode – contains the identification of the title for which the campaign is applicable. 
      • campPlanID – contains the identification of the Aria Core product that is used when the title is purchased
      • campRecurringRSID – contains the identification of the Aria Core recurring rate schedule to be used with this title. If blank, the default is used. 
    • campManageCampDetailAddInfoTitles – a structure holding additional information on the title. 
      • titleName – contains the name of the title
      • titleNameTranslations – contains the translations related to the title name. 
        • solmRefTransNo – contains the identification of the translation for this title. 
        • solmTranslationEntry – an array containing an element for each locale the title is returned in. 
          • solmLocaleID – contains the ID of the locale in which the title is returned
          • solmRefTransText– contains the name of the title in the locale (language) described by solmLocaleID
      • campPlanName – contains the name of the plan associated with the title
      • campPlanNameTranslations – contains the translations related to the campaign plan.
        • solmRefTransNo – contains the identification of the translation for this campaign plan. 
        • solmTranslationEntry – an array containing an element for each locale the campaign plan is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign plan is returned
          • solmRefTransText– contains the name of the campaign plan in the locale (language) described by solmLocaleID
             

Retrieve Campaign Selection (JSON API)

Endpoint

This API can be called by making a POST call to the URL: 
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/CampaignManagement/CampRetrieveCampSelection
 

CampRetrieveCampSelectionRequest

The campRetrieveCampSelectionRequest message is a JSON formatted message used to retrieve campaign selections currently registered in the solution. 

Sample 1
A sample request used to retrieve all campaign selections. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    }
}

The individual data elements of msgAuthDetails are defined in the general AMPS integration documentation. 
 

CampRetrieveCampSelectionResponse

The campRetrieveCampSelectionResponse message is a JSON formatted message listing all campaign selections currently registered in the system. 

Sample 1
A sample response listing all campaign selections currently registered. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "campRetrieveCampSelectionList": [
        {
            "campRetrieveCampSelectionInfo": {
                "campCheckSeqNo": 1234,
                "campStartDate": "2018-08-01",
                "campEndDate": "2019-07-31",
                "campID": "CAMP-1",
                "campCriteriaCode": "ALL-PRODUCTS"
            },
            "campRetrieveCampSelectionAddInfo": {
                "campName": "CAMPAIGN-1",
                "campNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Name"}
                    ]
                },
                "campDesc": "Description of Campaign-1",
                "campDescTranslations": {
                    "solmRefTransNo": 1235,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign Description"}
                    ]
                ],
                "campStatus": "ACTIVE",
                "campEligibility": "ANY",
                "campDurUnit": "WEEKS",
                "campDurLength": 5,
                "campDurEndDate": "",
                "campBillingCode": "IMMEDIATE",
                "campBillingPrice": 9.99
            },
            "campRetrieveCampSelectionListPlans": [
                {
                    "campRetrieveCampSelectionInfoPlans": {
                        "campCriteriaPlanID": "XX-FULL-DIGITAL",
                    },
                    "campRetrieveCampSelectionAddInfoPlans": {
                        "campCriteriaPlanName": "Full Digital Plan XX"
                        "campCriteriaPlanNameTranslations": {
                            "solmRefTransNo": "112233",
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Full Digital Plan XX"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Full Digital Plan XX"}
                            ]
                        }
                    }
                },
                {
                    "campRetrieveCampSelectionInfoPlans": {
                        "campCriteriaPlanID": "YY-FULL-DIGITAL",
                    },
                    "campRetrieveCampSelectionAddInfoPlans": {
                        "campCriteriaPlanName": "Full Digital Plan YY",
                        "campCriteriaPlanNameTranslations": {
                            "solmRefTransNo": "112234",
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Full Digital Plan YY"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Full Digital Plan YY"}
                            ]
                        }
                    }
                }
            ],
            "campRetrieveCampDetailListRest": [
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 100,
                        "campRestPeriod": 3,
                        "campRestOption": "ALTERNATE",
                        "campRestCampID": "CAMP-X"
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                        "campRestCampName": "CAMP-X",
                        "campRestCampNameTranslations": {
                            "solmRefTransNo": 112255,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign X"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign X"}
                            ]
                        }
                    }
                },
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 200,
                        "campRestPeriod": 6,
                        "campRestOption": "REFUSE",
                        "campRestCampID": ""
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                    }
                }
            ]
        }
    ]
}

The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 

The campRetrieveCampSelectionList contains an array of the campaign selections returned. Each campaign selection is returned in the three structures, all occurring in the same entry of the array. The structures are as described below:

  • campRetrieveCampSelectionInfo – a structure holding the general information on the campaign selection. 
    • campCheckSeqNo – contains the sequence number assigned to this selection.
    • campStartDate – contains the date from which the campaign selection is valid.
    • campEndDate – contains the date to which the campaign selection is valid. 
    • campID – contains the identification of the campaign the current selection applies to. 
    • campCriteriaCode – contains a code indicating what plan restrictions that are in place for this campaign. The following codes apply:
      • "ANY" – No specific plans are required for this campaign.
      • "ALL-PRODUCTS" – the customer must currently subscribe to all plans listed in the plan-list. 
      • "ANY-PRODUCTS" – the customer must currently subscribe to at least one plan listed in the plan-list. 
  • campRetrieveCampSelectionAddInfo – a structure holding additional information on the campaign. 
    • campName – contains the name of the campaign
    • campNameTranslations – contains the translations related to the campaign name 
      • solmRefTransNo – contains the identification of the translation for this campaign name. 
      • solmTranslationEntry – an array containing an element for each locale the campaign name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign name is returned
        • solmRefTransText– contains the name of the campaign name in the locale (language) described by solmLocaleID
    • campDesc – contains the brief description of the campaign.
    • campDescTranslations – contains the translations related to the campaign description. 
      • solmRefTransNo – contains the identification of the translation for this campaign description. 
      • solmTranslationEntry – an array containing an element for each locale the campaign description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the campaign description is returned
        • solmRefTransText– contains the name of the campaign description in the locale (language) described by solmLocaleID
    • campStatus – contains the status of the campaign. The following codes apply:
      • DEFINITION” – the campaign is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the campaign is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the campaign is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the campaign is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the campaign is deprecated and cannot be selected for sales on the web sites. Status can only be set when no more customers are actively using the campaign.  
    • campEligibility - contains a code indicating what kind of restrictions that apply to the campaign. The following codes apply: 
      • "ANY" – no restrictions apply.
      • "INVITATION" – customer can select the campaign only if invited.
      • "RESTRICTION" – customer can select the campaign only if certain restrictions are fulfilled. 
    • campDurUnit – contains a code indicating the unit used to represent the length of the campaign. The following codes apply:
      • "DAYS" – the duration is expressed in days.
      • "WEEKS" – the duration is expressed in weeks.
      • "MONTHS" – the duration is expressed in months.
    • campDurLength – contains the number of units (days, weeks or months) the campaign runs. 
    • campDurEndDate – contains the end-date of the campaign, irrespective of the start date. If used, then the campaign duration unit and length is not used. 
    • campBillingCode – contains a code indicating when the charge for the campaign is billed to the end-customer. The following codes apply:
      • "IMMEDIATE" – the charge is billed immediate and a separate notice is sent to the customer. 
      • "ANNIVERSARY" – the charge is billed at the next anniversary date of the end-customer. 
    • campBillingPrice – contains the price to charge the end-customer for this campaign. 
  • campRetrieveCampSelectionListPlans – a structure holding the array of plans (products) that the customer must subscribe to for this campaign to be eligible. Might contain no elements. The elements shown below occurs for each entry in the array. 
    • campRetrieveCampSelectionInfoPlans – a structure holding general details on the pre-requisite plans. 
      • campCriteriaPlanID – contains the ID of the plan to which the customer must be subscribed. 
    • campRetrieveCampSelectionAddInfoPlans – a structure holding additional details on the plan (product) defined above. 
      • campCriteriaPlanName – contains the name of the plan defined as a prerequisite to the current campaign. 
      • campCriteriaPlanNameTranslations – contains the translations related to the campaign name.
        • solmRefTransNo – contains the identification of the translation for this campaign name. 
        • solmTranslationEntry – an array containing an element for each locale the campaign name is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign name is returned.
          • solmRefTransText– contains the name of the campaign name in the locale (language) described by solmLocaleID
  • campRetrieveCampSelectionListRest – a structure holding the array of restrictions applicable for the campaign. Multiple entries may exist. 
    • campRetrieveCampSelectionInfoRest – a structure that holds general information on the restrictions associated with the campaign.
      • campRestSeqNo – contains the sequence number assigned to this restriction. 
      • campRestPeriod – contains the number of months the restriction is valid.
      • campRestOption – contains a code indicating the restriction option to be used. The following codes apply:
        • "REFUSE" – the campaign should be refused and cannot be assigned at this time. 
        • "ALTERNATE" – the campaign should be refused but an alternate campaign can be offered to the customer.  
      • campRestCampID – contains the identification of the alternate campaign to be offered to the customer if the option indicates "ALTERNATE".  
    • campRetrieveCampSelectionAddInfoRest – a structure holding additional information on the restriction. 
      • campRestCampName – contains the name of the alternate campaign to be offered.
      • campRestCampNameTranslations – contains the translations related to the campaign name. 
        • solmRefTransNo – contains the identification of the translation for this campaign. 
        • solmTranslationEntry – an array containing an element for each locale the campaign is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign is returned.
          • solmRefTransText– contains the name of the campaign in the locale (language) described by solmLocaleID
             

Manage Campaign Selection (JSON API)

Endpoint

This API can be called by making a POST call to the URL:
https://[clienthost]/PostDataToFlow/ARIAMediaSuite/CampaignManagement/CampManageCampSelection
 

CampManageCampSelectionRequest

The campManageCampSelectionRequest is a JSON formatted request structure used by the caller to request the addition, update or removal of a campaign selection. Multiple updates can be done in a single request. 

Sample 1
A sample request to add a single campaign selection.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "campManageCampSelectionList": [
        {
            "campManageCampSelectionActionInfo": {
                "campManageCampSelectionAction": "ADD"
            },
            "campManageCampSelectionInfo": {
                "campCheckSeqNo": 1234,
                "campStartDate": "2018-08-01",
                "campEndDate": "2019-07-31",
                "campID": "CAMP-1",
                "campCriteriaCode": "ALL-PRODUCTS"
            },
            "campManageCampSelectionListPlans": [
                {"campManageCampSelectionInfoPlans": {"campCriteriaPlanID": "XX-FULL-DIGITAL"}},
                {"campManageCampSelectionInfoPlans": {"campCriteriaPlanID": "YY-FULL-DIGITAL"}}
            ], 
            "campRetrieveCampDetailListRest": [
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 100,
                        "campRestPeriod": 3,
                        "campRestOption": "ALTERNATE",
                        "campRestCampID": "CAMP-X"
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                        "campRestCampName": "CAMP-X",
                        "campRestCampNameTranslations": {
                            "solmRefTransNo": 112255,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign X"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign X"}
                            ]
                        }
                    }
                },
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 200,
                        "campRestPeriod": 6,
                        "campRestOption": "REFUSE",
                        "campRestCampID": ""
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                    }
                }
            ]
        }
    ]
}

The individual data elements of msgAuthDetails are defined elsewhere. The individual data elements of campManageCampSelectionRequest are defined as follows:

  • campManageCampSelectionActionInfo – the action control structure.
    • campManageCampSelectionAction – contains the same value as provided in the request. 
  • campManageCampSelectionInfo - contains details on the address part. 
    • campCheckSeqNo – contains the sequence number assigned to this selection.
    • campStartDate – contains the date from which the campaign selection is valid.
    • campEndDate – contains the date to which the campaign selection is valid. 
    • campID – contains the identification of the campaign the current selection applies to. 
    • campCriteriaCode – contains a code indicating what plan restrictions that are in place for this campaign. The following codes apply:
      • "ANY" – No specific plans are required for this campaign.
      • "ALL-PRODUCTS" – the customer must currently subscribe to all plans listed in the plan-list. 
      • "ANY-PRODUCTS" – the customer must currently subscribe to at least one plan listed in the plan-list. 
  • campManageCampSelectionListPlans – a structure holding the array of plans (products) that the customer must subscribe to for this campaign to be eligible. Might contain no elements. The elements shown below occurs for each entry in the array. 
    • campRetrieveCampSelectionInfoPlans – a structure holding general details on the pre-requisite plans. 
      • campCriteriaPlanID – contains the ID of the plan to which the customer must be subscribed. 
  • campManageCampSelectionListRest – a structure holding the array of restrictions applicable for the campaign. Multiple entries may exist. 
    • campManageCampSelectionInfoRest – a structure that holds general information on the restrictions associated with the campaign.
      • campRestSeqNo – contains the sequence number assigned to this restriction. 
      • campRestPeriod – contains the number of months the restriction is valid.
      • campRestOption – contains a code indicating the restriction option to be used. The following codes apply:
        • "REFUSE" – the campaign should be refused and cannot be assigned at this time. 
        • "ALTERNATE" – the campaign should be refused but an alternate campaign can be offered to the customer. 
      • campRestCampID – contains the identification of the alternate campaign to be offered to the customer if the option indicates "ALTERNATE".  
    • campManageCampSelectionAddInfoRest – a structure holding additional information on the restriction. 
      • campRestCampName – contains the name of the alternate campaign to be offered.
      • campRestCampNameTranslations – contains the translations related to the campaign name. 
        • solmRefTransNo – contains the identification of the translation for this campaign. 
        • solmTranslationEntry – an array containing an element for each locale the campaign is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign is returned.
          • solmRefTransText– contains the name of the campaign in the locale (language) described by solmLocaleID
             

CampManageCampSelectionResponse

The campManageCampSelectionResponse is a JSON formatted response structure used by the caller to request the addition, update or removal of a campaign selection. Multiple updates can be done in a single request and the response will contain the same number of entries as the request. 

Sample 1
A sample response for the addition of a campaign selection. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "campManageCampSelectionListResponse": [
        {
            "campManageCampSelectionActionInfoResponse": {
                "campManageCampSelectionAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "campManageCampSelectionInfo": {
                "campCheckSeqNo": 1234,
                "campStartDate": "2018-08-01",
                "campEndDate": "2019-07-31",
                "campID": "CAMP-1",
                "campCriteriaCode": "ALL-PRODUCTS"
            },
            "campManageCampSelectionListPlans": [
                {"campManageCampSelectionInfoPlans": {"campCriteriaPlanID": "XX-FULL-DIGITAL"}},
                {"campManageCampSelectionInfoPlans": {"campCriteriaPlanID": "YY-FULL-DIGITAL"}}
            ], 
            "campRetrieveCampDetailListRest": [
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 100,
                        "campRestPeriod": 3,
                        "campRestOption": "ALTERNATE",
                        "campRestCampID": "CAMP-X"
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                        "campRestCampName": "CAMP-X",
                        "campRestCampNameTranslations": {
                            "solmRefTransNo": 112255,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Campaign X"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Campaign X"}
                            ]
                        }
                    }
                },
                {
                    "campRetrieveCampDetailInfoRest": {
                        "campRestSeqNo": 200,
                        "campRestPeriod": 6,
                        "campRestOption": "REFUSE",
                        "campRestCampID": ""
                    },
                    "campRetrieveCampDetailAddInfoRest": {
                    }
                }
            }
        }
    ]
}

The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 

The campManageCampSelectionListResponse contains an array of the title entries returned. All title entries provided in the request will also be returned in this response. The structures are described below:

  • campManageCampSelectionActionInfoResponse – the overall array structure.
    • campManageCampSelectionAction – contains the same value as provided in the request. 
    • resultCode – contains the result of the processing for this one action. A value of 0 (zero) indicates success. Other codes indicate failure. 
    • resultText – contains a short text describing the error encountered for this action. 
  • campManageCampSelectionInfo - contains details on the address part. 
    • campCheckSeqNo – contains the sequence number assigned to this selection.
    • campStartDate – contains the date from which the campaign selection is valid.
    • campEndDate – contains the date to which the campaign selection is valid. 
    • campID – contains the identification of the campaign the current selection applies to. 
    • campCriteriaCode – contains a code indicating what plan restrictions that are in place for this campaign. The following codes apply:
      • "ANY" – No specific plans are required for this campaign.
      • "ALL-PRODUCTS" – the customer must currently subscribe to all plans listed in the plan-list. 
      • "ANY-PRODUCTS" – the customer must currently subscribe to at least one plan listed in the plan-list. 
  • campManageCampSelectionListPlans – a structure holding the array of plans (products) that the customer must subscribe to for this campaign to be eligible. Might contain no elements. The elements shown below occurs for each entry in the array. 
    • campRetrieveCampSelectionInfoPlans – a structure holding general details on the pre-requisite plans. 
      • campCriteriaPlanID – contains the ID of the plan to which the customer must be subscribed. 
  • campManageCampSelectionListRest – a structure holding the array of restrictions applicable for the campaign. Multiple entries may exist. 
    • campManageCampSelectionInfoRest – a structure that holds general information on the restrictions associated with the campaign.
      • campRestSeqNo – contains the sequence number assigned to this restriction. 
      • campRestPeriod – contains the number of months the restriction is valid.
      • campRestOption – contains a code indicating the restriction option to be used. The following codes apply:
        • "REFUSE" – the campaign should be refused and cannot be assigned at this time. 
        • "ALTERNATE" – the campaign should be refused but an alternate campaign can be offered to the customer. 
      • campRestCampID – contains the identification of the alternate campaign to be offered to the customer if the option indicates "ALTERNATE".  
    • campManageCampSelectionAddInfoRest – a structure holding additional information on the restriction. 
      • campRestCampName – contains the name of the alternate campaign to be offered.
      • campRestCampNameTranslations – contains the translations related to the campaign name. 
        • solmRefTransNo – contains the identification of the translation for this campaign. 
        • solmTranslationEntry – an array containing an element for each locale the campaign is returned in. 
          • solmLocaleID – contains the ID of the locale in which the campaign is returned
          • solmRefTransText– contains the name of the campaign in the locale (language) described by solmLocaleID
             

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.