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

Interface and Integration Definitions for Distribution Management

Overview

This document describes the API methods used for Distribution Management when integrating with the Aria Media and Publishing Suite (AMPS). The  Distribution Management component is a set of generic components that are designed for use within both standard AMPS implementations and customer-specific workflows. This document describes the Distribution Management functionality to manage the distribution of delivery addresses for customers subscribing to physical media (newspapers, magazines, etc), and which must be delivered at a given address. Functions as the central hub for all delivery addresses maintained by a subscriber at any given time. Integration with some delivery companies are provided from the start, but new integrations can be added as required.

The APIs described in this document form the foundation for the request/reply structures for Distribution Management supported by AMPS. CLIENTS of Aria can extend the suite but not alter its internal functioning, primarily through client-managed development in integrated systems.

For AMPS to function as described, several account and product fields must be added to objects such as accounts, plans, plan instances, services and usage types within Aria Core. See Aria Media and Publishing Suite - Aria Core Configuration for details regarding these fields.

Distribution Management

The following details the definition of the APIs provided by the Distribution Management part of AMPS. The following messages are provided:

Each of the above APIs are described below.

Distribution Request (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistUpdater

DistDistributionRequest

The DistDistributionRequest message is a JSON formatted message used to initiate the generation of address changes for a given title and when complete transferring the generated information to the distribution company. The message is sent asynchronous to the destination. 

Sample 1
A sample request to initiate distribution for a title “RB” and covering changes effective as of 2018-03-31. The execution date of the distribution is 2018-03-29 and only changes are transferred.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distDistributionDetails": {
        "titleCode": "RB",
        "titleName": "Romerikes Blad",
        "titleDistSystem": "DI-BATCH",
        "titleDistType": "DELTA",
        "titleDistTitleCode": "DIRB",
        "titleDistPublTiming": "1",
        "distSelectDate": "2018-03-31",
        "distExecuteDate": "2018-03-29",
        "distOverride": true
    }
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was build. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the [CLIENT] defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of distDistributionDetails are defined as follows:

  • titleCode - contains identification of the title for which the distribution of address changes should take place. 
  • titleName - contains the name of the title for which distribution of address changes should take place. 
  • titleDistSystem - contains a code indicating which distribution system that should receive the address changes. Is defined as part of the TitleDetails table. 
  • titleDistType - contains a code indicating whether a full (FULL) or changes only (DELTA) should be transferred to the distribution system. 
  • titleDistTitleCode – contains a code indicating the distribution systems identification of the current title. 
  • titleDistPublTiming – contains a code indicating the timing of the publication delivery. “1” indicates morning delivery; “2” indicates evening delivery.
  • distSelectDate - contains the date used to determine what changes to include in the distribution. Must be in the format “YYYY-MM-DD”
  • distExecuteDate – contains the date the distribution is executed, usually the current date. Must be in format “YYYY-MM-DD”
  • distOverride – contains FALSE if the distribution is a normal scheduled distributed. If it contains TRUE it is an out-of-sequence distribution. 

DistDistributionResponse

N/A

Process Address Changes Request (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistProcessAddrChanges

DistProcessAddrChangesRequest

The DistProcessAddrChangesRequest message is a JSON formatted message used to initiate the processing of address changes for a given title. During processing, it will pick up the customer requested address changes from distAddrChanges table and populate them in distAddrChangeRecs table ready to be picked up by DistUpdater process. 

Sample 1
A sample request to initiate of address changes for a title “RB” and for publishing day of 2018-03-31.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distProcessAddrChangesDetails": {
        "titleCode": "RB",
        "distPublDate": "2018-03-31"
    }
}

The individual data elements of msgAuthDetails are defined in the beginning of the document. The individual data elements of distProcessAddrChangesDetails are defined as follows:

  • titleCode - contains identification of the title for which the distribution of address changes should take place. 
  • distPublDate - contains the date used to determine what changes to include for processing. Must be in the format “YYYY-MM-DD”. 
     

Retrieve Addresses (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistRetrieveAddr

DistRetrieveAddrRequest

The DistRetrieveAddrRequest message is a JSON formatted message used to retrieve all addresses currently registered for a given account. All addresses are returned in the response. 

Sample 1
A sample request to retrieve all addresses currently registered on the given account
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distRetrieveAddrAccountInfo": {
        "ariaAccountNo": 23445566
        "ariaAccountID": "",
    }
}

The individual data elements of msgAuthDetails are defined with the Distribution Request. The individual data elements of distRetrieveAddrAccountInfo are defined as follows:

  • ariaAccountNo - contains identification of the account for which the addresses should be returned. If not present, then ariaAccountID must be filled. 
  • ariaAccountID – contains the client defined identification of the account for which the addresses should be returned. If not present, then ariaAccountNo must be filled.

DistRetrieveAddrResponse

The DistRetrieveAddrResponse message is a JSON formatted message listing all addresses currently registered for a given account. 

Sample 1
A sample response listing all registered addresses for a given account.
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distRetrieveAddrList": [
        {
            "distRetrieveAddrInfo": {
                "distAddrNo": 100
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distRetrieveAddrAddressTypeInfo": {
                "distAddrType": 1,
                "distAddrTypeTranslations": {
                    "solmRefTransNo": 1233,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                    ]
                }
            }
        },
        {
            "distRetrieveAddrInfo": {
                "distAddrNo": 100
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distRetrieveAddrAddressTypeInfo": {
                "distAddrType": 2,
                "distAddrTypeTranslations": {
                    "solmRefTransNo": 1234,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        }
    ]
}

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 distRetrieveAddrList contains an array of the addresses returned. Each address is returned in the two structures (distRetrieveAddrInfo and distRetrieveAddrAddressTypeInfo) as described below:

  • distRetrieveAddrInfo - contains details on the address part. 
    • distAddrNo – the name associated with the address.
    • distAddrName – the name associated with the address.
    • distAddrLine1 – the first line of the current address.
    • distAddrLine2 – the second line of the current address.
    • distAddrLine3 – the third line of the current address.
    • distAddrCity – the city where the address is found.
    • distAddrPostalCode – the postal code / zip code of the current address.
    • distAddrCountryCode – contains the ISO country code associated with the current address.
    • distAddrLocality – contains the locality of the current address.
    • distAddrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • distStreetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • distStreetNo – if present, this field contains only the street number and no other part of the address.
    • distFlatNo – if present, this field contains the number of the flat.
    • distFlatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • distFlatFloor – if present, this field contains the floor where the flat is found.
    • distEntranceNo – if present, this field contains the number of the entrance to the flat.
    • distPublAddrNo – if present, this field contains a unique identification of the address as defined by relevant government authorities. 
    • distAddrLine4 – the fourth line of the current address.
    • distCoAddr – the "care-of" address part of the current address.
    • distApartmentNo – the apartment number of the current address. Primarily used when the apartment number does not follow the public standard.
    • distDirections – the directions provided by the customer to the address. 
  • distRetrieveAddrAddressTypeInfo - contains details on the type of address returned. 
    • distAddrType – contains a code indicating the type of address returned. 
    • distAddrTypeTranslations – contains a list of the address type name in each locale supported. 
      • solmRefTransNo – contains the identification of the translation for this address type. 
      • solmTranslationEntry – an array containing an element for each locale the address type is returned in. 
        • solmLocaleID – contains the ID of the locale in which the address type name is returned.
        • solmRefTransText– contains the name of the address type in the locale (language) described by solmLocaleID
           

Manage Addresses (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistManageAddr

DistManageAddrRequest

The DistManageAddrRequest message is a JSON formatted message used to manage (add, update or remove) addresses for a given account. Addresses are stored irrespective of title code and applies to the full account. 

Sample 1
A sample request to add two new address. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrList": [
        {
            "distManageAddrActionInfo": {"distManageAddrAction": "ADD"},
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": null,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        },
        {
            "distManageAddrActionInfo": {"distManageAddrAction": "ADD"},
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": null,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        }
    ]
}

Sample 2
A sample request to update two existing address
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrList": [
        {
            "distManageAddrActionInfo": {"distManageAddrAction": "MODIFY"},
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "Leilighet A1",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        },
        {
            "distManageAddrActionInfo": {"distManageAddrAction": " MODIFY "},
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": 101
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "Hytte Mount Olympus",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        }
    ]
}

Sample 3
A sample request to delete one existing address
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrList": [
        {
            "distManageAddrActionInfo": {"distManageAddrAction": "REMOVE"},
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "Leilighet A1",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        }
    ]
}

Sample 4
A sample request to add an address and remove another address
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrList": [
        {
            "distManageAddrActionInfo": {"distManageAddrAction": "ADD"},
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "Leilighet A1",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        },
        {
            "distManageAddrActionInfo": {"distManageAddrAction": " REMOVE"},
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": 101
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "Hytte Mount Olympus",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined as follows:

  • clientNo - contains the Aria specific identification of the instance in which the solution currently operates. Varies from test to production. This value is required in all API calls to Aria to authenticate the caller. 
  • authKey - contains the Aria specified authentication key. This key is required in all API calls to Aria to authenticate the caller.  
  • requestDateTime - contains the date and time when the message was build. 
  • signatureValue - contains the signature value calculated by the sending solution. Using the private key, the receiving solution will validate the information retrieved, and if no match is found, the call will fail. 
  • ariaAccountID - contains the [CLIENT] defined identification of the customer account, for example a number from a CRM system or other customer master.  Used for the signature value calculation.
  • ariaAccountNo - contains the Aria generated identification of the account. Will always be zero as the account has not been created yet. 

The individual data elements of distManageAddrAccountInfo are defined as follows:

  • ariaAccountNo - contains identification of the account for which the address changes were made. If not present, then ariaAccountID must be present. 
  • ariaAccountID – contains the client defined identification of the account for which the address changes are made. If not present, then ariaAccountNo must be present. 

The distManageAddrList contains an array of the operations to perform. Each address is defined in the two structures (distManageAddrActionInfo and distManageAddrInfo) as described below:

  • distManageAddrActionInfo - contains details on the operation to perform. 
    • distManageAddrAction – contains the operation to perform. Use ADD to add a new address, use MODIFY to modify an address and use REMOVE to remove an address. 
  • distManageAddrInfo - contains details on the address part. 
    • distAddrType – contains a code indicating the type of address managed. 
    • distAddrNo – the number associated with the address. If a new address is added the number will always be returned to the caller. 
    • distAddrName – the name associated with the address.
    • distAddrLine1 – the first line of the current address.
    • distAddrLine2 – the second line of the current address.
    • distAddrLine3 – the third line of the current address.
    • distAddrCity – the city where the address is found.
    • distAddrPostalCode – the postal code / zip code of the current address.
    • distAddrCountryCode – contains the ISO country code associated with the current address. 
    • distAddrLocality – contains the locality of the current address.
    • distAddrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • distStreetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • distStreetNo – if present, this field contains only the street number and no other part of the address.
    • distFlatNo – if present, this field contains the number of the flat. 
    • distFlatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • distFlatFloor – if present, this field contains the floor where the flat is found.
    • distEntranceNo – if present, this field contains the number of the entrance to the flat.
    • distPublAddrNo – if present, this field contains a unique identification of the address as defined by relevant government authorities. 
    • distAddrLine4 – the fourth line of the current address.
    • distCoAddr – the "care-of" address part of the current address.
    • distApartmentNo – the apartment number of the current address. Primarily used when the apartment number does not follow the public standard.
    • DistDirections – the directions provided by the customer to the address. 

DistManageAddrResponse

The DistManageAddrResponse message is a JSON formatted message used to manage (add, update or remove) addresses for a given account. Addresses are stored irrespective of title code and applies to the full account. This message returns the outcome of the operation. The following samples have been created: 

Sample 1
A sample response to add two new addresses. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrListResponse": [
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "ADD",
                "resultCode": 0,
                "resultText": "Address added"
            },
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                ]
            }
        },
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "ADD",
                "resultCode": 0,
                "resultText": "Address added"
            },
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": 101
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "Hytte Mount Olympus",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1234,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                ]
            }
        }
    ]
}

Sample 2
A sample response to update two existing address
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrListResponse": [
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "MODIFY",
                "resultCode": 0,
                "resultText": "Address modified"
            },
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                ]
            }
        },
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "MODIFY",
                "resultCode": 0,
                "resultText": "Address modified"
            },
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": 101
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "Hytte Mount Olympus",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1234,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                ]
            }
        }
    ]
}

Sample 3
A sample response to delete one existing address
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrListResponse": [
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "REMOVE",
                "resultCode": 0,
                "resultText": "Address removed"
            },
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                ]
            }
        }
    ]
}

Sample 4
A sample response to add an address and remove another address
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distManageAddrAccountInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distManageAddrListResponse": [
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "ADD",
                "resultCode": 0,
                "resultText": "Address added"
            },
            "distManageAddrInfo": {
                "distAddrType": 1,
                "distAddrNo": 100,
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Slottsgate 17",
                "distAddrLine2": "",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "1234",
                "distAddrCity": "Oslo",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                ]
            }
        },
        {
            "distManageAddrActionInfoResponse": {
                "distManageAddrAction": "REMOVE",
                "resultCode": 0,
                "resultText": "Address removed"
            },
            "distManageAddrInfo": {
                "distAddrType": 2,
                "distAddrNo": 101
                "distAddrName": "John Johnsen",
                "distAddrLine1": "Hyttefaldet 17",
                "distAddrLine2": "Hytte Mount Olympus",
                "distAddrLine3": "",
                "distAddrCountryCode": "NO",
                "distAddrPostalCode": "5234",
                "distAddrCity": "Kvitfjell",
                "distAddrLocality": "",
                "distAddrStateProv": "",
                "distStreetName": "",
                "distStreetNo": "",
                "distFlatNo": "",
                "distFlatSpec": "",
                "distFlatFloor": "",
                "distEntranceNo": "",
                "distPublAddrNo": ""
            },
            "distManageAddrTypeTrans": {
                "solmRefTransNo": 1234,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                    {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                ]
            }
        }
    ]
}

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 individual data elements of distManageAddrAccountInfo are defined as follows:

  • ariaAccountNo - contains identification of the account for which the address changes were made. If not present, then ariaAccountID must be filled. 
  • ariaAccountID – contains the client defined identification of the account for which the address changes were made. If not present, then ariaAccountNo must be filled. 

The distManageAddrListResponse contains an array of the addresses returned. Each address is returned in the two structures (distManageAddrActionInfoResponse, distManageAddrInfo and distManageAddrTypeTrans) as described below:

  • distManageAddrActionInfoResponse - contains details on the outcome of the operation. 
    • distManageAddrAction – 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 particular action. 
  • distManageAddrInfo - contains details on the address part. 
    • distAddrType – contains a code indicating the type of address managed. 
    • distAddrNo – the number associated with the address. If a new address is added the number will always be returned to the caller. 
    • distAddrName – the name associated with the address.
    • distAddrLine1 – the first line of the current address.
    • distAddrLine2 – the second line of the current address.
    • distAddrLine3 – the third line of the current address.
    • distAddrCity – the city where the address is found.
    • distAddrPostalCode – the postal code / zip code of the current address.
    • distAddrCountryCode – contains the ISO country code associated with the current address. 
    • distAddrLocality – contains the locality of the current address.
    • distAddrStateProv – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
    • distStreetName – if present, this field contains only the name of the street. Numbers, floors, etc. are not included. 
    • distStreetNo – if present, this field contains only the street number and no other part of the address.
    • distFlatNo – if present, this field contains the number of the flat. 
    • distFlatSpec – if present, this field contains the specification of the flat, for example left, right, center, etc. 
    • distFlatFloor – if present, this field contains the floor where the flat is found.
    • distEntranceNo – if present, this field contains the number of the entrance to the flat.
    • distPublAddrNo – if present, this field contains a unique identification of the address as defined by relevant government authorities. 
    • distAddrLine4 – the fourth line of the current address.
    • distCoAddr – the "care-of" address part of the current address.
    • distApartmentNo – the apartment number of the current address. Primarily used when the apartment number does not follow the public standard.
    • distDirections – the directions provided by the customer to the address. 
    • DistAddInfo1 - contains any additional information provided by customer.
    • DistAddInfo2 - contains any additional information provided by customer.
    • DistAddInfo3 - contains any additional information provided by customer.
  • distManageAddrTypeTrans - contains details on the type of address returned. 
    • solmRefTransNo – contains the identification of the translation for this address type. 
    • solmTranslationEntry – an array containing an element for each locale the address type is returned in. 
      • solmLocaleID – contains the ID of the locale in which the address type name is returned.
      • solmRefTransText– contains the name of the address type in the locale (language) described by solmLocaleID
         

Retrieve Address Changes (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistRetrieveAddrChg

DistRetrieveAddrChgRequest

The DistRetrieveAddrChgRequest message is a JSON formatted message used to retrieve all address changes currently registered for a given account. All addresses related to the title codes and happening within the date range are returned in the response.

Sample 1
A sample request to retrieve all address changes currently registered on the given account for a single title. All historic changes are also returned. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distRetrieveAddrChgInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100",
        "distRetrieveAddrChgTitleCode": [
            {"titleCode": "RB"}
        ],
        "distRetrieveStartDate": "",
        "distRetrieveEndDate": ""
    }
}

Sample 2
A sample request to retrieve all address changes currently registered on the given account for several titles. Only titles valid from today and in the future is returned.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distRetrieveAddrChgInfo": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100",
        "distRetrieveAddrChgTitleCode": [
            {"titleCode": "RB"},
            {"titleCode": "DT"},
            {"titleCode": "NO"}
        ],
        "distRetrieveStartDate": "2018-04-10",
        "distRetrieveEndDate": ""
    }
}

The individual data elements of msgAuthDetails are defined with the request. The individual data elements of distRetrieveAddrChgInfo are defined as follows:

  • ariaAccountNo - contains identification of the account for which the address should be returned. If not present, ariaAccountID must be filled. 
  • ariaAccountID – contains the client defined identification of the account for which the addresses should be returned. If not present, ariaAccountNo must be filled. 
  • distRetrieveAddrChgTitleCodeList – an array of titles for which address changes should be returned. If no title codes are given, all titles are returned. 
    • titleCode – contains the title code for which address changes are to be returned. 
  • distRetrieveStartDate – contains the date from which address changes are to be returned. If blank the full history of address changes are returned. Must be in format “YYYY-MM-DD” or blank. 
  • distRetrieveEndDate – contains the date to which address changes are to be returned. If blank the full future history of address changes are returned. Must be in format “YYYY-MM-DD” or blank. 

DistRetrieveAddrChgResponse

The DistRetrieveAddrChgResponse message is a JSON formatted message listing all address changes currently registered for a given account and title within a given date range.

Sample 1
A sample response listing all registered address changes for a given account. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distRetrieveAddrChgAcctDetails": {
        "ariaAccountNo": 11223344,
        "ariaAccountID": "ACCT-0100"
    },
    "distRetrieveAddrChgTitleList": [
        {"distRetrieveAddrChgTitleDetails": [
            {
                "distTitleCode": "RB",
                "distRetrieveAddrChgDetails": [
                    {
                        "distDateFrom": "2018-02-01",
                        "distDateTo": "2018-02-28",
                        "distAddrNo": 200,
                        "distAriaMpiNo": 200,
                        "distDeliveryDays": "DDDDDDX"
                    },
                    {
                        "distDateFrom": "2018-03-01",
                        "distDateTo": "",
                        "distAddrNo": 201,
                        "distAriaMpiNo": 200,
                        "distDeliveryDays": "DDDDDDX"
                    }
                ]
            },
            {
                "distTitleCode": "DT",
                "distRetrieveAddrChgDetails": [
                    {
                        "distDateFrom": "2018-03-01",
                        "distDateTo": "",
                        "distAddrNo": 201,
                        "distAriaMpiNo": 201,
                        "distDeliveryDays": "DDDDDXX"
                        }
                    ]
                }
            ]
        }
    ]
}

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 individual data elements of distRetrieveAddrChgAcctDetails are defined as follows:

  • ariaAccountNo - contains the Aria identification of the account for which the address changes are returned. 
  • ariaAccountID – contains the client defined identification of the account for which the address changes are returned. 

The distRetrieveAddrChgTitleList contains the following elements:

  • distRetrieveAddrChgTitleDetails – contains an element for each title for which address changes are returned. 
    • distTitleCode – the title code of the title for which address changes are returned.
    • distRetrieveAddrChgDetails – contains an element for each address change returned for the title.
      • distDateFrom – contains the date from which the address change is valid. Format is “YYYY-MM-DD”
      • distDateTo – contains the date to which the address change is valid. If blank, the address change is valid indefinitely. Format is “YYYY-MM-DD”.
      • distAddrNo – contains the number of the address which is used for this address change. 
      • distAriaMpiNo – contains the master plan instance number of the instance defining the subscription of the current title. 
      • distDeliveryDays – contains a code for each day of the week indicating whether the paper is delivered on that specific day of the week or not. “D” indicates that it is delivered; “X” indicates that it is not delivered. First character indicates Monday, second character indicates Tuesday, third character indicates Wednesday and so on. 

Other attributes or elements may be added later. 

 

Change Address (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistChangeAddr

DistChangeAddrRequest

The distChangeAddrRequest message is a JSON formatted message used to register changes to the delivery address for one or more titles. 

Sample 1
A sample request to change the delivery address for a single title code 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distChangeAddrList": [
        {
            "distChangeAddrInfo": {
                "ariaAccountNo": 11223344,
                "ariaAccountID": "ACCT-0100",
                "distEffectiveStartDate": "2018-08-01",
                "distEffectiveEndDate": null,
                "distTitleCodeList": [
                    {"distTitleCode": "RB", "distAriaMpiNo": 22334455}
                ]
            },
            "distChangeAddrDeliveryList": [
                {"distAddrNo": 1,    "distDeliveryDays": "DDDDDDX"}
            ]
        }
    ]
}

Sample 2
A sample request to change the delivery address for a set of title codes
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distChangeAddrList": [
        {
            "distChangeAddrInfo": {
                "ariaAccountNo": 11223344,
                "ariaAccountID": "ACCT-0100",
                "distEffectiveStartDate": "2018-08-01",
                "distEffectiveEndDate": null,
                "distTitleCodeList": [
                    {"distTitleCode": "RB", "distAriaMpiNo": 22334455},
                    {"distTitleCode": "DT", "distAriaMpiNo": 22334456}
                ]
            },
            "distChangeAddrDeliveryList": [
                {"distAddrNo": 1,    "distDeliveryDays": "DDDDDDX"}
            ]
        }
    ]
}

Sample 3
A sample request to change the delivery address for a single title code, splitting the delivery days over several addresses
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distChangeAddrList": [
        {
            "distChangeAddrInfo": {
                "ariaAccountNo": 11223344,
                "ariaAccountID": "ACCT-0100",
                "distEffectiveStartDate": "2018-08-01",
                "distEffectiveEndDate": null,
                "distTitleCodeList": [
                    {"distTitleCode": "RB", "distAriaMpiNo": 22334455},
                    {"distTitleCode": "DT", "distAriaMpiNo": 22334456}
                ]
            },
            "distChangeAddrDeliveryList": [
                {"distAddrNo": 1,"distDeliveryDays": "DDDDXXX"},
                {"distAddrNo": 2,"distDeliveryDays": "XXXXDDD"}
            ]
        }
    ]
}


The individual data elements of msgAuthDetails are defined with the Distribution Request. The distChangeAddrList is an array of address changes, that should be processed as one, for example when adding a temporary address which has an end date. The individual data elements of distChangeAddrList are defined as follows:

  • distChangeAddrInfo – a common structure holding details on the account and titles for which the address change applied. 
    • ariaAccountNo - contains identification of the account for which the address should be changed. If not present, ariaAccountID must be filled. 
    • ariaAccountID – contains the client defined identification of the account which the address should be changed. If not present, ariaAccountNo must be filled. 
    • distEffectiveStartDate – contains the date (formatted as YYYY-MM-DD" from which the address change should take effect. 
    • distEffectiveEndDate – contains the date (formatted as YYYY-MM-DD" to which the address change should remain in effect. If set to "null" no specific end date is set. 
    • distTitleCodeList – an array of titles for which address changes should be carried out. At least one title code is required. 
      • distTitleCode – contains the title code for which address changes are to be returned. 
      • distAriaMpiNo – contains the identification of the MPI that represents the subscription to the title code given. 
  • distChangeAddrDeliveryList – an array of delivery days that need to have the address changed. Though the array can contain multiple set of addresses it is not possible to have multiple entries indicating that delivery is available on the same day. 
    • distAddrNo – contains the number of the address to be assigned at the effective date and providing delivery of the paper as specified below. 
    • distDeliveryDays – contains a code for each day of the week indicating whether the paper is delivered to the specified address on that specific day of the week or not. “D” indicates that it is delivered; “X” indicates that it is not delivered. First character indicates Monday, second character indicates Tuesday, third character indicates Wednesday and so on. 

DistChangeAddrResponse

The distChangeAddrResponse message is a JSON formatted message used to report the outcome of the address change for one or more titles.

Sample 1
A general sample response 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    }
}

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. 

 

Retrieve Address Types (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistRetrieveAddrTypes

DistRetrieveAddrTypeRequest

The distRetrieveAddrTypeRequest message is a JSON formatted message used to retrieve all address types currently registered in the system. 

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

The individual data elements of msgAuthDetails are defined as part of the general request. 

DistRetrieveAddrTypeResponse

The distRetrieveAddrTypeResponse message is a JSON formatted message used to return a list of one or more address types. 

Sample 1
A general sample response 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distRetrieveAddrTypeList": [
        {
            "distRetrieveAddrTypeInfo": 
                {
                    "distAddrType": 1,
                    "distAddrTypeName": “Home”
                },
            "distRetrieveAddrTypeAddInfo": {
                "distAddrTypeTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hjemme"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Heime"}
                    ]
                }
            }
        },
        {
            "distRetrieveAddrTypeInfo":
                {
                    "distAddrType": 2,
                    "distAddrTypeName": “Cabin”
                },
            "distRetrieveAddrTypeAddInfo": {
                "distAddrTypeTranslations": {
                    "solmRefTransNo": 1234,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        },
    }
}

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 distRetrieveAddrTypeList is a specification of the address types returned to the caller. The list contains an entry for each address type returned. The individual data elements of distRetrieveAddrTypeList are defined as follows:

  • distRetrieveAddrTypeList – an array of address types returned by the API. 
    • distRetrieveAddrTypeInfo – a common structure holding details on the address type returned. 
      • distAddrType – The identification of the address type returned. 
      • distAddrTypeName – the short name associated with the address type. This value is not translated. 
  • distRetrieveAddrTypeAddInfo – contains additional details on the address type returned. 
    • distAddrTypeTranslations – contains the translations related to the address type. 
      • solmRefTransNo – contains the identification of the translation for this address type. 
      • solmTranslationEntry – an array containing an element for each locale the address type is returned in. 
        • solmLocaleID – contains the ID of the locale in which the address type name is returned.
        • solmRefTransText– contains the name of the address type in the locale (language) described by solmLocaleID
           

Manage Address Types (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/DistManageAddrTypes

DistManageAddrTypeRequest

The distManageAddrTypeRequest message is a JSON formatted message used to add, update or remove one or more address types currently registered in the system. 

Sample 1
A sample request used to add a new address type.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrTypeList": [
        {
            "distManageAddrTypeActionInfo": {
                "distManageAddrTypeAction": "ADD"
            },
            "distManageAddrTypeInfo": {
                "distAddrType": 1,
                "distAddrTypeName": "Cabin"
            },
            "distManageAddrTypeAddInfo": {
                "distManageAddrTypeTrans": {                    {
                    "solmRefTransNo": Null,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        }
    }
}

Sample 2
A sample request used to modify an address type.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrTypeList": [
        {
            "distManageAddrTypeActionInfo": {
                "distManageAddrTypeAction": "MODIFY"
            },
            "distManageAddrTypeInfo": {
                "distAddrType": 1,
                "distAddrTypeName": "Cabin"
            },
            "distManageAddrTypeAddInfo": {
                "distManageAddrTypeTrans": {
                    "solmRefTransNo": 1234,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        }
    }
}

Sample 3
A sample request used to remove an address type.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "distManageAddrTypeList": [
        {
            "distManageAddrTypeActionInfo": {
                "distManageAddrTypeAction": "REMOVE"
            },
            "distManageAddrTypeInfo": {
                "distAddrType": 1,
                "distAddrTypeName": "Cabin"
            },
            "distManageAddrTypeAddInfo": {
                "distManageAddrTypeTrans": {
                    "solmRefTransNo": 1234,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        }
    }
}

The individual data elements of msgAuthDetails are defined as part of the general request. The distManageAddrTypeList is an array each containing an operation to perform on the address type. The API can be used to add, modify or remove address types. The actions are done in the sequence provided in the list. The individual data elements of distManageAddrTypeList are defined as follows:

  • distRetrieveAddrTypeInfo – a common structure holding details on the action to perform. 
  • distManageAddrTypeActionInfo - contains details on the operation to perform. 
    • distManageAddrTypeAction – contains the operation to perform. Use ADD to add a new address type, use MODIFY to modify an address type and use REMOVE to remove an address type. 
  • distManageAddrTypeInfo - contains details on the address part. 
    • distAddrType – identifies the address type to add, modify or remove from the system. 
    • distAddrTypeName – contains a brief description of the address type being worked on. Is not used when removing address types.  
  • distManageAddrTypeAddInfo – contains additional information on the address type. 
    • distManageAddrTypeTrans – contains the translations related to the address type. 
      • solmRefTransNo – contains the identification of the translation for this address type. Use Null when adding a new address type. 
      • solmTranslationEntry – an array containing an element for each locale the address type is provided in. 
        • solmLocaleID – contains the ID of the locale in which the address type name is provided.
        • solmRefTransText– contains the description of the address type in the locale (language) described by solmLocaleID

DistManageAddrTypeResponse

The distManageAddrTypeResponse message is a JSON formatted message used to return the outcome of the add, modify or remove action performed on address types. 

Sample 1
A sample response showing a removed address type.
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "distManageAddrTypeListResponse": [
        {
            "distManageAddrTypeInfoResponse": {
                "distManageAddrTypeAction": "REMOVE",
                "resultCode": 0,
                "resultText": "OK"
            },
            "distManageAddrTypeInfo": {
                "distAddrType": 1,
                "distAddrTypeName": "Cabin"
            },
            "distManageAddrTypeAddInfo": {
                "distManageAddrTypeTrans": {
                    "solmRefTransNo": 1234,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL","solmRefTransText": "Hytte"},
                        {"solmLocaleID": "NO-NYNORSK","solmRefTransText": "Hytte"}
                    ]
                }
            }
        }
    }
}

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 distManageAddrTypeListResponse is a specification of the address types returned to the caller. The list contains an entry for each address type returned. The individual data elements of distManageAddrTypeListResponse are defined as follows:

  • distManageAddrTypeInfoResponse - contains details on the outcome of the operation. 
    • distManageAddrTypeAction – 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. 
  • distRetrieveAddrTypeInfo – a common structure holding details on the address type returned. 
    • distAddrType – The identification of the address type returned. 
    • distAddrTypeName – the short name associated with the address type. This value is not translated. 
  • distManageAddrTypeAddInfo – contains additional details on the address type returned. 
    • distManageAddrTypeTrans – contains the translations related to the address type. 
      • solmRefTransNo – contains the identification of the translation for this address type. 
      • solmTranslationEntry – an array containing an element for each locale the address type is returned in. 
        • solmLocaleID – contains the ID of the locale in which the address type name is returned
        • solmRefTransText– contains the name of the address type in the locale (language) described by solmLocaleID
           

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.