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

Interface and Integration Definitions for Bundle Management

Overview

This document describes the API methods used for Bundle Management when integrating with the Aria Media and Publishing Suite (AMPS). The Bundle 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 Bundle Management functionality to manage bundles that can be applied to products offered by the client to end-customers in certain circumstances. 

Bundle Management

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

Each of the above APIs are described below. 

Retrieve Bundle Detail (JSON API)

Endpoint

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

BndlRetrieveBndlDetailRequest

The BndlRetrieveBndlDetailRequest is a JSON formatted request structure used by the caller to retrieve details on a single bundle or all bundles currently registered. 

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

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

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

BndlRetrieveBndlDetailResponse

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

Sample 1
A sample response showing multiple bundles. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "BndlRetrieveBndlDetailList": [
        {
            "bndlRetrieveBndlDetailInfo": {
                "bndlID": "BNDL-1",
                "bndlName": "BUNDLE-1",
                "bndlDesc": "Description of Bundle-1",
                "bndlStatus": "ACTIVE",
                "BndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN1", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL1GL"
            },
            "bndlRetrieveBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1234",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1255",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "bndlRetrieveBndlDetailInfo": {
                "bndlID": "BNDL-2",
                "bndlName": "BUNDLE-2",
                "bndlDesc": "Description of Bundle-2",
                "bndlStatus": "ACTIVE",
                "BndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN2", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL2GL"
            },
            "bndlRetrieveBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        }
    ]
}

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 BndlRetrieveBndlDetailList contains an array of the bundles returned. The structures are described below:

  • bndlRetrieveBndlDetailInfo – a structure holding the general information on the bundle. 
    • bndlID – contains the identification of the bundle returned.
    • bndlName – contains the name of the bundle.
    • bndlDesc – contains the brief description of the bundle.
    • bndlStatus – contains the status of the bundle. The following codes apply:
      • DEFINITION” – the bundle is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the bundle is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the bundle is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the bundle is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the bundle 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 bundle.  
    • bndlCriteriaCode – contains a code indicating which criteria that applies. The following codes apply
      • "DATES" – eligibility is determined by the start and end dates of the bundle only.   
      • "PRICE" – eligibility is determined by the value of the current subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "COUNT" – eligibility is determined by the number of active subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "PRICE-COUNT" – eligibility is determined by the number of active subscriptions and the value of these subscriptions has. If both values are exceeded the customer is eligible for the bundle.     
    • bndlEligibilityCount - Defines the number of active subscriptions the customer must have at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The number of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "COUNT" or "PRICE-COUNT".
    • bndlEligibilityPrice - Defines the value of active subscriptions the customer has at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The value of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "PRICE" or "PRICE-COUNT".
    • bndlPlanID - Contains the identification of the Aria Core plan associated with this bundle. This is the plan/product that will be added if the customer is eligible for the bundle. If the customer drops out of the bundle this plan will be cancelled.
    • bndlRecurringRSID - Contains the client defined identification of the rate schedule to use when assigning this plan as the bundle product. If not specified, the default rate schedule will be applied.
    • bndlGLCode - contains the client defined identification of the GL code to use when reporting revenue into the general ledger. If no special code is required, this field is left empty.
  • bndlRetrieveBndlDetailAddInfo – a structure holding additional information on the bundle. 
    • bndlNameTranslations – contains the translations related to the bundle name. 
      • solmRefTransNo – contains the identification of the translation for this bundle name. 
      • solmTranslationEntry – an array containing an element for each locale the bundle name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle name is returned.
        • solmRefTransText– contains the name of the bundle name in the locale (language) described by solmLocaleID
    • bndlDescTranslations – contains the translations related to the bundle description. 
      • solmRefTransNo – contains the identification of the translation for this bundle description. 
      • solmTranslationEntry – an array containing an element for each locale the bundle description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle description is returned.
        • solmRefTransText– contains the name of the bundle description in the locale (language) described by solmLocaleID
           

Manage Bundle Detail (JSON API)

Endpoint

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

BndlManageBndlDetailRequest

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

Sample 1
A sample request used to add a new bundle while also removing another one. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "bndlManageBndlDetailList": [
        {
            "bndlManageBndlDetailActionInfo": {
                "bndlManageBndlDetailAction": "ADD"
            },
            "bndlManageBndlDetailInfo": {
                "bndlID": "BNDL-2",
                "bndlName": "BUNDLE-2",
                "bndlDesc": "Description of Bundle-2",
                "bndlStatus": "ACTIVE",
                "bndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN2", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL2GL"
            },
            "bndlManageBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "bndlManageBndlDetailActionInfo": {
                "bndlManageBndlDetailAction": "REMOVE"
            },
            "bndlManageBndlDetailInfo": {
                "bndlID": "BNDL-1",
                "bndlName": "BUNDLE-1",
                "bndlDesc": "Description of Bundle-1",
                "bndlStatus": "ACTIVE",
                "bndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN1", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL1GL"
            },
            "bndlManageBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined elsewhere. The bndlManageBndlDetailList structure contains an entry for each operation to perform on the bundles. Each entry contains the attributes described below:

  • bndlManageBndlDetailActionInfo – the action control structure.
    • bndlManageBndlDetailAction – contains the action to perform. “ADD” adds a new bundle; “MODIFY” modifies an existing bundle while “REMOVE” removes an existing bundle. 
  • bndlManageBndlDetailInfo – a structure holding the general information on the bundle. 
    • bndlID – contains the identification of the bundle returned 
    • bndlName – contains the name of the bundle 
    • bndlDesc – contains the brief description of the bundle
    • bndlStatus – contains the status of the bundle. The following codes apply:
      • DEFINITION” – the bundle is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the bundle is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the bundle is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the bundle is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the bundle 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 bundle.  
    • bndlCriteriaCode – contains a code indicating which criteria that applies. The following codes apply:
      • "DATES" – eligibility is determined by the start and end dates of the bundle only.   
      • "PRICE" – eligibility is determined by the value of the current subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "COUNT" – eligibility is determined by the number of active subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "PRICE-COUNT" – eligibility is determined by the number of active subscriptions and the value of these subscriptions has. If both values are exceeded the customer is eligible for the bundle.     
    • bndlEligibilityCount - Defines the number of active subscriptions the customer must have at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The number of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "COUNT" or "PRICE-COUNT".
    • bndlEligibilityPrice - Defines the value of active subscriptions the customer has at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The value of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "PRICE" or "PRICE-COUNT".
    • bndlPlanID - Contains the identification of the Aria Core plan associated with this bundle. This is the plan/product that will be added if the customer is eligible for the bundle. If the customer drops out of the bundle this plan will be cancelled.
    • bndlRecurringRSID - Contains the client defined identification of the rate schedule to use when assigning this plan as the bundle product. If not specified, the default rate schedule will be applied.
    • bndlGLCode - contains the client defined identification of the GL code to use when reporting revenue into the general ledger. If no special code is required, this field is left empty.
  • bndlManageBndlDetailAddInfo – a structure holding additional information on the bundle. 
    • bndlNameTranslations – contains the translations related to the bundle name.
      • solmRefTransNo – contains the identification of the translation for this bundle name. 
      • solmTranslationEntry – an array containing an element for each locale the bundle name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle name is returned.
        • solmRefTransText– contains the name of the bundle name in the locale (language) described by solmLocaleID
    • bndlDescTranslations – contains the translations related to the bundle description. 
      • solmRefTransNo – contains the identification of the translation for this bundle description. 
      • solmTranslationEntry – an array containing an element for each locale the bundle description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle description is returned.
        • solmRefTransText– contains the name of the bundle description in the locale (language) described by solmLocaleID
           

BndlManageBndlDetailResponse

The bndlManageBndlDetailResponse is a JSON formatted response structure returned in response to the bndlManageBndlDetailRequest. 

Sample 1
A sample response returned when a new bundle has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "bndlManageBndlDetailDetailsResponse": [
        {
            "bndlManageBndlDetailActionInfoResponse": {
                "bndlManageBndlDetailAction": "ADD",
                "resultCode": 0,
                "resultText": "OK"
            },
            "bndlManageBndlDetailInfo": {
                "bndlID": "BNDL-2",
                "bndlName": "BUNDLE-2",
                "bndlDesc": "Description of Bundle-2",
                "bndlStatus": "ACTIVE",
                "bndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN2", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL2GL"
            },
            "bndlManageBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "bndlManageBndlDetailActionInfoResponse": {
                "bndlManageBndlDetailAction": "REMOVE",
                "resultCode": 0,
                "resultText": "OK"
            },
            "bndlManageBndlDetailInfo": {
                "bndlID": "BNDL-1",
                "bndlName": "BUNDLE-1",
                "bndlDesc": "Description of Bundle-1",
                "bndlStatus": "ACTIVE",
                "bndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN1", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL1GL"
            },
            "bndlManageBndlDetailAddInfo": {
                "bndlNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "bndlDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        }
    ]
}

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 bndlManageBndlDetailListResponse 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:

  • bndlManageBndlDetailActionInfoResponse – the action control response structure.
    • bndlManageBndlDetailAction – contains the action to perform. “ADD” adds a new bundle; “MODIFY” modifies an existing bundle while “REMOVE” removes an existing bundle. 
    • 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. 
  • bndlManageBndlDetailInfo – a structure holding the general information on the bundle. 
    • bndlID – contains the identification of the bundle returned. 
    • bndlName – contains the name of the bundle.
    • bndlDesc – contains the brief description of the bundle.
    • bndlStatus – contains the status of the bundle. The following codes apply:
      • DEFINITION” – the bundle is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the bundle is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the bundle is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the bundle is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the bundle 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 bundle.  
    • bndlCriteriaCode – contains a code indicating which criteria that applies. The following codes apply:
      • "DATES" – eligibility is determined by the start and end dates of the bundle only.   
      • "PRICE" – eligibility is determined by the value of the current subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "COUNT" – eligibility is determined by the number of active subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "PRICE-COUNT" – eligibility is determined by the number of active subscriptions and the value of these subscriptions has. If both values are exceeded the customer is eligible for the bundle.     
    • bndlEligibilityCount - Defines the number of active subscriptions the customer must have at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The number of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "COUNT" or "PRICE-COUNT".
    • bndlEligibilityPrice - Defines the value of active subscriptions the customer has at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The value of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "PRICE" or "PRICE-COUNT".
    • bndlPlanID - Contains the identification of the Aria Core plan associated with this bundle. This is the plan/product that will be added if the customer is eligible for the bundle. If the customer drops out of the bundle this plan will be cancelled.
    • bndlRecurringRSID - Contains the client defined identification of the rate schedule to use when assigning this plan as the bundle product. If not specified, the default rate schedule will be applied.
    • bndlGLCode - contains the client defined identification of the GL code to use when reporting revenue into the general ledger. If no special code is required, this field is left empty
  • bndlManageBndlDetailAddInfo – a structure holding additional information on the bundle. 
    • bndlNameTranslations – contains the translations related to the bundle name. 
      • solmRefTransNo – contains the identification of the translation for this bundle name. 
      • solmTranslationEntry – an array containing an element for each locale the bundle name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle name is returned.
        • solmRefTransText– contains the name of the bundle name in the locale (language) described by solmLocaleID
    • bndlDescTranslations – contains the translations related to the bundle description. 
      • solmRefTransNo – contains the identification of the translation for this bundle description. 
      • solmTranslationEntry – an array containing an element for each locale the bundle description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle description is returned.
        • solmRefTransText– contains the name of the bundle description in the locale (language) described by solmLocaleID
           

Retrieve Bundle Selection (JSON API)

Endpoint

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

BndlRetrieveBndlSelectionRequest

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

Sample 1
A sample request used to retrieve all bundle 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. 
 

BndlRetrieveBndlSelectionResponse

The BndlRetrieveBndlSelectionResponse message is a JSON formatted message listing all bundle selections currently registered in the system. 
Sample 1
A sample response listing all titles currently registered. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "BndlRetrieveBndlSelectionList": [
        {
            "bndlRetrieveBndlSelectionInfo": {
                "bndlCheckSeqNo": 1234,
                "bndlStartDate": "2018-08-01",
                "bndlEndDate": "2019-07-31",
                "bndlID": "BNDL-1"
            },
            "bndlRetrieveBndlSelectionAddInfo": {
                "bndlName": "BUNDLE-1",
                "bndlNameTranslations": [
                    {
                        "solmRefTransNo": 1232,
                        "solmTranslationEntry": [
                            {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bundle Name"},
                            {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Bundle Name"}
                        ]
                    }
                ],
                "bndlDesc": "Description of Bundle-1",
                "bndlDescTranslations": [
                    {
                        "solmRefTransNo": 1235,
                        "solmTranslationEntry": [
                            {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bundle Description"},
                            {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": " Bundle Description "}
                        ]
                    }
                ],
                "bndlCriteriaCode": "PRICE-COUNT", 
                "bndlEligibilityCount": 2,
                "bndlEligibilityPrice": 49.00,
                "bndlPlanID": "PLAN2", 
                "bndlRecurringRSID": "",
                "bndlGLCode": "BNDL2GL"
            }
        }
    ]
}

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 BndlRetrieveBndlSelectionList contains an array of the bundle selections returned. Each bundle selection is returned in the two structures, both occurring in the same entry of the array. The structures are as described below:

  • BndlRetrieveBndlSelectionInfo – a structure holding the general information on the bundle selection. 
    • bndlCheckSeqNo – contains the sequence number assigned to this selection.
    • bndlStartDate – contains the date from which the bundle selection is valid.
    • bndlEndDate – contains the date to which the bundle selection is valid. 
    • bndlID – contains the identification of the bundle.
  • BndlRetrieveBndlSelectionAddInfo – a structure holding additional information on the bundle. 
    • bndlName – contains the name of the bundle. 
    • bndlNameTranslations – contains the translations related to the bundle name. 
      • solmRefTransNo – contains the identification of the translation for this bundle name. 
      • solmTranslationEntry – an array containing an element for each locale the bundle name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle name is returned.
        • solmRefTransText– contains the name of the bundle name in the locale (language) described by solmLocaleID
    • bndlDesc – contains the brief description of the bundle.
    • bndlDescTranslations – contains the translations related to the bundle description. 
      • solmRefTransNo – contains the identification of the translation for this bundle description. 
      • solmTranslationEntry – an array containing an element for each locale the bundle description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the bundle description is returned.
        • solmRefTransText– contains the name of the bundle description in the locale (language) described by solmLocaleID
    • bndlStatus – contains the status of the bundle. The following codes apply:
      • DEFINITION” – the bundle is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the bundle is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the bundle is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the bundle is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the bundle 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 bundle.  
    • bndlCriteriaCode – contains a code indicating which criteria that applies. The following codes apply:
      • "DATES" – eligibility is determined by the start and end dates of the bundle only.   
      • "PRICE" – eligibility is determined by the value of the current subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "COUNT" – eligibility is determined by the number of active subscriptions assigned to the customer including the product being purchased. If the total exceeds the current value, the customer is eligible for the bundle.
      • "PRICE-COUNT" – eligibility is determined by the number of active subscriptions and the value of these subscriptions has. If both values are exceeded the customer is eligible for the bundle.     
    • bndlEligibilityCount - Defines the number of active subscriptions the customer must have at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The number of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "COUNT" or "PRICE-COUNT".
    • bndlEligibilityPrice - Defines the value of active subscriptions the customer has at purchase time for the customer to be eligible for the bundle. The subscription currently being purchased must be included as well. The value of subscriptions must be equal to or greater than this number. Used only if Bundle Criteria Code equals "PRICE" or "PRICE-COUNT".
    • bndlPlanID - Contains the identification of the Aria Core plan associated with this bundle. This is the plan/product that will be added if the customer is eligible for the bundle. If the customer drops out of the bundle this plan will be cancelled.
    • bndlRecurringRSID - Contains the client defined identification of the rate schedule to use when assigning this plan as the bundle product. If not specified, the default rate schedule will be applied.
    • bndlGLCode - contains the client defined identification of the GL code to use when reporting revenue into the general ledger. If no special code is required, this field is left empty.
       

Manage Bundle Selection (JSON API)

Endpoint

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

BndlManageBndlSelectionRequest

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

Sample 1
A sample request to add a single bundle selection.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "bndlManageBndlSelectionList": [
        {
            "bndlManageBndlSelectionActionInfo": {
                "bndlManageBndlSelectionAction": "ADD"
            },
            "bndlManageBndlSelectionInfo": {
                "bndlCheckSeqNo": 1234,
                "bndlStartDate": "2018-08-01",
                "bndlEndDate": "2019-07-31",
                "bndlID": "BNDL-1"
            }
        }
    ]
}

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

  • bndlManageBndlSelectionActionInfo – the action control structure.
    • bndlManageBndlSelectionAction – contains the same value as provided in the request. 
  • bndlManageBndlSelectionInfo - contains details on the address part. 
    • bndlCheckSeqNo – contains the sequence number assigned to this selection.
    • bndlStartDate – contains the date from which the bundle selection is valid.
    • bndlEndDate – contains the date to which the bundle selection is valid. 
    • bndlID – contains the identification of the bundle.
       

BndlManageBndlSelectionResponse

The bndlManageBndlSelectionResponse is a JSON formatted response structure used by the caller to request the addition, update or removal of a bundle 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 bundle selection. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "bndlManageBndlSelectionListResponse": [
        {
            "bndlManageBndlSelectionActionInfoResponse": {
                "bndlManageBndlSelectionAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "bndlManageBndlSelectionInfo": {
                "bndlCheckSeqNo": 1234,
                "bndlStartDate": "2018-08-01",
                "bndlEndDate": "2019-07-31",
                "bndlID": "BNDL-1"
            }
        }
    ]
}

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 bndlManageBndlSelectionListResponse 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:

  • bndlManageBndlSelectionActionInfoResponse – the overall array structure.
    • bndlManageBndlSelectionAction – 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. 
  • bndlManageBndlSelectionInfo - contains details on the bundle selection part. 
    • bndlCheckSeqNo – contains the sequence number assigned to this selection.
    • bndlStartDate – contains the date from which the bundle selection is valid.
    • bndlEndDate – contains the date to which the bundle selection is valid. 
    • bndlID – contains the identification of the bundle. 
       

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.