Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

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

Interface and Integration Definitions for Discount Management

This article applies to:Aria Crescendo

Overview

This document describes the API methods used for Discount Management when integrating with the Aria Media and Publishing Suite (AMPS). The Discount 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 Discount Management functionality to manage discounts that can be applied to products purchased by the end-customer under certain circumstances. It defines the discount details as well as the sequence in which they are checked for eligibility. 

Discount Management

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

Each of the above APIs are described below.

Retrieve Discount Detail (JSON API)

Endpoint

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

DiscRetrieveDiscDetailRequest

The DiscRetrieveDiscDetailRequest is a JSON formatted request structure used by the caller to retrieve details on a single discount or all discounts currently registered. 

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

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

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

DiscRetrieveDiscDetailResponse

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

Sample 1
A sample response showing multiple discounts. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "discRetrieveDiscDetailList": [
        {
            "discRetrieveDiscDetailInfo": {
                "discID": "DISC-1",
                "discName": "DISCOUNT-1",
                "discDesc": "Description of Discount-1",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC1GL",
                "discCouponCode": "DISC1"
            },
            "discRetrieveDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1234",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "solmRefTransNo": "1255",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "discRetrieveDiscDetailInfo": {
                "discID": "DISC-2",
                "discName": "DISCOUNT-2",
                "discDesc": "Description of Discount-2",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC2GL",
                "discCouponCode": "DISC2"
            },
            "discRetrieveDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "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 discRetrieveDiscDetailList contains an array of the discount entries returned. The structures are described below:

  • discRetrieveDiscDetailInfo – a structure holding the general information on the discount. 
    • discID – contains the identification of the discount returned. 
    • discName – contains the name of the discount.
    • discDesc – contains the brief description of the discount.
    • discStatus – contains the status of the discount. The following codes apply:
      • DEFINITION” – the discount is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the discount is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the discount is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the discount is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the discount 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 discount.  
    • discEligibilityCount - contains the count of plans that must be greater than or equal to all discount eligible subscriptions already assigned to the account or being added to the account.
    • discPercentage - contains the percentage to be applied to the subscriptions added. The discount is not assigned to plans already subscribed to. If adding two subscriptions at the same time, two different discount rules may be applied depending on the criteria.
    • discGLCode - 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.
    • discCouponCode - contains the identification of the coupon to apply when this discount is in effect. Must exist in the Aria Core platform.
  • discRetrieveDiscDetailAddInfo – a structure holding additional information on the discount. 
    • discNameTranslations – contains the translations related to the discount name.
      • solmRefTransNo – contains the identification of the translation for this discount name. 
      • solmTranslationEntry – an array containing an element for each locale the discount name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount name is returned.
        • solmRefTransText– contains the name of the discount name in the locale (language) described by solmLocaleID
    • discDescTranslations – contains the translations related to the discount description. 
      • solmRefTransNo – contains the identification of the translation for this discount description. 
      • solmTranslationEntry – an array containing an element for each locale the discount description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount description is returned.
        • solmRefTransText– contains the name of the discount description in the locale (language) described by solmLocaleID
           

Manage Discount Detail (JSON API)

Endpoint

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

DiscManageDiscDetailRequest

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

Sample 1
A sample request used to add a new discount 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"
    },
    "discManageDiscDetailList": [
        {
            "discManageDiscDetailActionInfo": {
                "discManageDiscDetailAction": "ADD"
            },
            "discManageDiscDetailInfo": {
                "discID": "DISC-2",
                "discName": "DISCOUNT-2",
                "discDesc": "Description of Discount-2",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC2GL",
                "discCouponCode": "DISC2"
            },
            "discManageDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "discManageDiscDetailActionInfo": {
                "discManageDiscDetailAction": "REMOVE"
            },
            "discManageDiscDetailInfo": {
                "discID": "DISC-1",
                "discName": "DISCOUNT-1",
                "discDesc": "Description of Discount-1",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC1GL",
                "discCouponCode": "DISC1"
            },
            "discManageDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        }
    ]
}

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

  • discManageDiscDetailActionInfo – the action control structure.
    • discManageDiscDetailAction – contains the action to perform. “ADD” adds a new discount; “MODIFY” modifies an existing discount while “REMOVE” removes an existing discount. 
  • discRetrieveDiscDetailInfo – a structure holding the general information on the discount. 
    • discID – contains the identification of the discount.
    • discName – contains the name of the discount.
    • discDesc – contains the brief description of the discount.
    • discStatus – contains the status of the discount. The following codes apply
      • DEFINITION” – the discount is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the discount is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the discount is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the discount is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the discount 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 discount.  
    • discEligibilityCount - contains the count of plans that must be greater than or equal to all discount eligible subscriptions already assigned to the account or being added to the account.
    • discPercentage - contains the percentage to be applied to the subscriptions added. The discount is not assigned to plans already subscribed to. If adding two subscriptions at the same time, two different discount rules may be applied depending on the criteria.
    • discGLCode - 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.
    • discCouponCode - contains the identification of the coupon to apply when this discount is in effect. Must exist in the Aria Core platform.
  • discRetrieveDiscDetailAddInfo – a structure holding additional information on the discount. 
    • discNameTranslations – contains the translations related to the discount name. 
      • solmRefTransNo – contains the identification of the translation for this discount name. 
      • solmTranslationEntry – an array containing an element for each locale the discount name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount name is returned
        • solmRefTransText– contains the name of the discount name in the locale (language) described by solmLocaleID
    • discDescTranslations – contains the translations related to the discount description. 
      • solmRefTransNo – contains the identification of the translation for this discount description. 
      • solmTranslationEntry – an array containing an element for each locale the discount description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount description is returned
      • solmRefTransText– contains the name of the discount description in the locale (language) described by solmLocaleID.

DiscManageDiscDetailResponse

The discManageDiscDetailResponse is a JSON formatted response structure returned in response to the discManageDiscDetailRequest

Sample 1
A sample response returned when a new discount has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "discManageDiscDetailDetailsResponse": [
        {
            "discManageDiscDetailActionInfoResponse": {
                "discManageDiscDetailAction": "ADD",
                "resultCode": 0,
                "resultText": "OK"
            },
            "discManageDiscDetailInfo": {
                "discID": "DISC-2",
                "discName": "DISCOUNT-2",
                "discDesc": "Description of Discount-2",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC2GL",
                "discCouponCode": "DISC2"
            },
            "discManageDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "solmRefTransNo": "1266",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Description"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Description"}
                    ]}
                ]
            }
        },
        {
            "discManageDiscDetailActionInfoResponse": {
                "discManageDiscDetailAction": "REMOVE",
                "resultCode": 0,
                "resultText": "OK"
            },
            "discManageDiscDetailInfo": {
                "discID": "DISC-1",
                "discName": "DISCOUNT-1",
                "discDesc": "Description of Discount-1",
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discGLCode": "DISC1GL",
                "discCouponCode": "DISC1"
            },
            "discManageDiscDetailAddInfo": {
                "discNameTranslations": [{
                    "solmRefTransNo": "1244",
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bokmal Name"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Nynorsk Name"}
                    ]}
                ],
                "discDescTranslations": [{
                    "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 discManageDiscDetailListResponse 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:

  • discManageDiscDetailActionInfoResponse – the action control response structure.
    • discManageDiscDetailAction – contains the action to perform. “ADD” adds a new discount; “MODIFY” modifies an existing discount while “REMOVE” removes an existing discount. 
    • 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. 
  • discRetrieveDiscDetailInfo – a structure holding the general information on the discount. 
    • discID – contains the identification of the discount. 
    • discName – contains the name of the discount.
    • discDesc – contains the brief description of the discount.
    • discStatus – contains the status of the discount. The following codes apply:
      • DEFINITION” – the discount is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the discount is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the discount is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the discount is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the discount 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 discount.  
    • discEligibilityCount - contains the count of plans that must be greater than or equal to all discount eligible subscriptions already assigned to the account or being added to the account.
    • discPercentage - contains the percentage to be applied to the subscriptions added. The discount is not assigned to plans already subscribed to. If adding two subscriptions at the same time, two different discount rules may be applied depending on the criteria.
    • discGLCode - 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.
    •  discCouponCode - contains the identification of the coupon to apply when this discount is in effect. Must exist in the Ar ia Core platform.
  • discRetrieveDiscDetailAddInfo – a structure holding additional information on the discount. 
    • discNameTranslations – contains the translations related to the discount name 
      • solmRefTransNo – contains the identification of the translation for this discount name. 
      • solmTranslationEntry – an array containing an element for each locale the discount name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount name is returned
        • solmRefTransText– contains the name of the discount name in the locale (language) described by solmLocaleID
    • discDescTranslations – contains the translations related to the discount description. 
      • solmRefTransNo – contains the identification of the translation for this discount description. 
      • solmTranslationEntry – an array containing an element for each locale the discount description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount description is returned
        • solmRefTransText– contains the name of the discount description in the locale (language) described by solmLocaleID. 
           

Retrieve Discount Selection (JSON API)

Endpoint

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

DiscRetrieveDiscSelectionRequest

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

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

DiscRetrieveDiscSelectionResponse

The discRetrieveDiscSelectionResponse message is a JSON formatted message listing all discount selections currently registered in the system. 

Sample 1
A sample response listing all titles currently registered. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "discRetrieveDiscSelectionList": [
        {
            "discRetrieveDiscSelectionInfo": {
                "discCheckSeqNo": 1234,
                "discStartDate": "2018-08-01",
                "discEndDate": "2019-07-31",
                "discID": "DISC-1"
            },
            "discRetrieveDiscSelectionAddInfo": {
                "discName": "DISCOUNT-1",
                "discNameTranslations": [
                    {
                        "solmRefTransNo": 1232,
                        "solmTranslationEntry": [
                            {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Discount Name"},
                            {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Discount Name"}
                        ]
                    }
                ],
                "discDesc": "Description of Discount-1",
                "discDescTranslations": [
                    {
                        "solmRefTransNo": 1235,
                        "solmTranslationEntry": [
                            {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Discount Description"},
                            {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": " Discount Description "}
                        ]
                    }
                ],
                "discStatus": "ACTIVE",
                "discEligibilityCount": 2,
                "discPercentage": 10,
                "discCouponCode": "DISC1"
            }
        }
    ]
}

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

  • discRetrieveDiscSelectionInfo – a structure holding the general information on the discount. 
    • discCheckSeqNo – contains the sequence number assigned to this selection.
    • discStartDate – contains the date from which the discount selection is valid.
    • discEndDate – contains the date to which the discount selection is valid. 
    • discID – contains the identification of the discount. 
  • discRetrieveDiscSelectionAddInfo – a structure holding additional information on the discount. 
    • discName – contains the name of the discount.
    • discNameTranslations – contains the translations related to the discount name.
      • solmRefTransNo – contains the identification of the translation for this discount name. 
      • solmTranslationEntry – an array containing an element for each locale the discount name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount name is returned.
        • solmRefTransText– contains the name of the discount name in the locale (language) described by solmLocaleID
    • discDesc – contains the brief description of the discount.
    • discDescTranslations – contains the translations related to the discount description. 
      • solmRefTransNo – contains the identification of the translation for this discount description. 
      • solmTranslationEntry – an array containing an element for each locale the discount description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the discount description is returned.
        • solmRefTransText– contains the name of the discount description in the locale (language) described by solmLocaleID
    • discStatus – contains the status of the discount. The following codes apply:
      • DEFINITION” – the discount is currently being defined and is not available for selection by end-customers or authorized users.  
      • TRIAL” – the discount is currently being trialed and is available only to certain authorized users.
      • ACTIVE” – the discount is active and can be selected by end-customers on the web-sites provided the criteria has been met.   
      • INACTIVE” – the discount is inactive and cannot be selected for recent sales on the web sites. Existing customer are not affected.  
      • DEPRECATED” – the discount 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 discount.  
    • discEligibilityCount - contains the count of plans that must be greater than or equal to all discount eligible subscriptions already assigned to the account or being added to the account
    • discPercentage - contains the percentage to be applied to the subscriptions added. The discount is not assigned to plans already subscribed to. If adding two subscriptions at the same time, two different discount rules may be applied depending on the criteria.
    • discCouponCode - contains the identification of the coupon to apply when this discount is in effect. Must exist in the Aria Core platform.
       

Manage Discount Selection (JSON API)

Endpoint

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

DiscManageDiscSelectionRequest

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

Sample 1
A sample request to add a single discount selection.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "DiscManageDiscSelectionList": [
        {
            "discManageDiscSelectionActionInfo": {
                "discManageDiscSelectionAction": "ADD"
            },
            "discManageDiscSelectionInfo": {
                "discCheckSeqNo": 1234,
                "discStartDate": "2018-08-01",
                "discEndDate": "2019-07-31",
                "discID": "DISC-1"
            }
        }
    ]
}

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

  • discManageDiscSelectionActionInfo – the action control structure.
    • discManageDiscSelectionAction – contains the same value as provided in the request. 
  • discManageDiscSelectionInfo - contains details on the address part. 
    • discCheckSeqNo – contains the sequence number assigned to this selection.
    • discStartDate – contains the date from which the discount selection is valid.
    • discEndDate – contains the date to which the discount selection is valid. 
    • discID – contains the identification of the discount.

DiscManageDiscSelectionResponse

The discManageDiscSelectionResponse is a JSON formatted response structure used by the caller to request the addition, update or removal of a discount 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 discount selection. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "discManageDiscSelectionListResponse": [
        {
            "discManageDiscSelectionActionInfoResponse": {
                "discManageDiscSelectionAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "discManageDiscSelectionInfo": {
                "discCheckSeqNo": 1234,
                "discStartDate": "2018-08-01",
                "discEndDate": "2019-07-31",
                "discID": "DISC-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 discManageDiscSelectionListResponse 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:

  • discManageDiscSelectionActionInfoResponse – the overall array structure.
    • discManageDiscSelectionAction – 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. 
  • discManageDiscSelectionInfo - contains details on the discount selection part. 
    • discCheckSeqNo – contains the sequence number assigned to this selection
    • discStartDate – contains the date from which the discount selection is valid
    • discEndDate – contains the date to which the discount selection is valid. 
    • discID – contains the identification of the discount.
       

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.