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

Interface and Integration Definitions for Title Management

Table of contents
  1. Overview
    1. Title Management 
    2. Generate Holidays (JSON API)
      1. Endpoint
      2. TitleGenerateHolidaysRequest
      3. TitleGenerateHolidaysResponse
    3. Retrieve Holidays (JSON API)
      1. Endpoint
      2. TitleRetrieveHolidayRequest
      3. TitleRetrieveHolidaysResponse
    4. Manage Holidays (JSON API)
      1. Endpoint
      2. TitleManageHolidayRequest
      3. TitleManageHolidayResponse
    5. Generate Calendar (JSON API)
      1. Endpoint
      2. TitleGenerateCalendarRequest
      3. TitleGenerateCalendarResponse
    6. Retrieve Calendar (JSON API)
      1. Endpoint
      2. TitleRetrieveCalendarRequest
      3. TitleRetrieveCalendarResponse
    7. Manage Calendar (JSON API)
      1. Endpoint
      2. TitleManageCalendarRequest
      3. TitleManageCalendarResponse
    8. Retrieve Titles (JSON API)
      1. Endpoint
      2. TitleRetrieveTitlesRequest
      3. TitleRetrieveTitlesResponse
    9. Manage Titles (JSON API)
      1. Endpoint
      2. TitleManageTitleRequest
      3. TitleManageTitleResponse
    10. Retrieve Title Publishing Days (JSON API)
      1. Endpoint
      2. TitleRetrieveTitlePublDaysRequest
      3. TitleRetrieveTitlePublDaysResponse
    11. Manage Title Publishing Days (JSON API)
      1. Endpoint
      2. TitleManageTitlePublDaysRequest
      3. TitleManageTitlePublDaysResponse
    12. Retrieve Title Owners (JSON API)
      1. Endpoint
      2. TitleRetrieveTitleOwnersRequest
      3. TitleRetrieveTitleOwnersResponse
    13. Manage Title Owners (JSON API)
      1. Endpoint
      2. TitleManageTitleOwnersRequest
      3. TitleManageTitleOwnersResponse
    14. Retrieve Dunning (JSON API)
      1. Endpoint
      2. TitleRetrieveDunningRequest
      3. TitleRetrieveDunningResponse
    15. Manage Dunning (JSON API)
      1. Endpoint
      2. TitleManageDunningRequest
      3. TitleManageDunningResponse
    16. Title Manage Pay Options (JSON API)
      1. Endpoint
      2. TitleManagePayOptionsRequest
    17.  
      1. TitleManagePayOptionsResponse
    18. Title Retrieve Pay Options (JSON API)
      1. Endpoint
      2. TitleRetrievePayOptionsRequest
      3. TitleRetrievePayOptionsResponse
    19. Title Manage Pay Terms (JSON API)
      1. Endpoint
      2. TitleRetrievePayOptionsRequest
      3. TitleRetrievePayOptionsResponse
    20. Title Retrieve Pay Terms (JSON API)
      1. Endpoint
      2. TitleRetrievePayTermsRequest
      3. TitleRetrievePayTermsResponse

Overview

This document describes the API methods used for Title Management when integrating with the Aria Media and Publishing Suite (AMPS). The Title 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 Title Management functionality to manage titles (newspapers, magazines, etc) published and handled either digitally or via physical media. A title defines certain key attributes of the title, such as name, description, distribution system, distribution calendar, publishing days, revenue controls, access controls, etc.

The APIs described in this document form the foundation for the request/reply structures for Title 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.

Title Management 

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

Each of the above APIs are described below. 

Generate Holidays (JSON API)

Endpoint

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

TitleGenerateHolidaysRequest

The TitleGenerateHolidaysRequest message is a JSON formatted message used to initiate the generation of public holidays for a given country. The holiday details are retrieved from an external website. 

Sample 1
A sample request to generate the public holidays for a given country and year:
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleGenerateHolidayDetails": {
        "countryCode": “NO",
        "holidayYear": 2018
    }
}

The individual data elements of msgAuthDetails are defined in the general interface and integration specification document.

The individual data elements of titleRetrieveHolidaysInfo are defined as follows:

  • countryCode - contains the identification of the country for which the holiday entries should be generated.
  • holidayYear - contains the year for which the holidays are generated. Format is YYYY-MM-DD.

TitleGenerateHolidaysResponse

The TitleGenerateHolidaysResponse message is a JSON formatted message returned in response to the request to generate new holidays for a country and year. 

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 Holidays (JSON API)

Endpoint

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

TitleRetrieveHolidayRequest

The TitleRetrieveHolidaysRequest is a JSON formatted request structure used by the caller to retrieve details on the holidays for a given country and year. All holiday entries are returned in the response. The following sample is provided:

•    Sample 1); Request to retrieve the holidays for a given country and date range

Sample 1
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleRetrieveHolidaysInfo": {
        "countryCode": "NO",
        "holidayYear": 2018
    }
}

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

  • countryCode – contains the identification of the country for which the holiday entries should be returned.
  • holidayYear – contains the year for which the holidays are returned. Format is YYYY.

TitleRetrieveHolidaysResponse

The TitleRetrieveHolidaysResponse is a JSON formatted response structure used return details on the holidays for a given country and date range. Multiple entries may exist depending on the country and its holidays. The following sample is provided:

Sample 1
A sample response showing multiple holiday entries
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleRetrieveHolidaysList": [
        {
            "countryCode": "NO",
            "holidayDate": "2018-01-01",
            "holidayName": "New Years day",
            "holidayOneLiner": "New Years day",
            "holidayType": "NATIONAL"
        },
        {
            "countryCode": "NO",
            "holidayDate": "2018-05-17",
            "holidayName": "National Day",
            "holidayOneLiner": "National Day",
            "holidayType": "NATIONAL"
        }
    ]
}

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 titleRetrieveHolidaysList contains an array of the holiday entries returned. All calendar entries that exist in the given date range is returned. The structures is described below:

  • titleRetrieveHolidayList – the overall array structure.
    • CountryCode – represents the ISO country code of the country for which the holidays are defined. 
    • HolidayDate – contains the date of the public holiday.
    • HolidayName – contains the short name of the holiday as defined by timeanddate.com
    • HolidayOneLiner – contains a brief description or one-line for the holiday. Is defined by timeanddate.com
    • HolidayType – contains a code indicating the type of holiday. The following codes are accepted:
      • NATIONAL” – the holiday is a national holiday.
      • STATE” – the holiday is a state holiday.
      • REGIONAL” – the holiday is a regional holiday.
      • LOCAL” – the holiday is a local holiday.
         

Manage Holidays (JSON API)

Endpoint

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

TitleManageHolidayRequest

The TitleManageHolidayRequest is a JSON formatted request structure used by the caller to add, modify or remove holidays for a given country. It is possible to perform several actions in the same API call should more than one operation be required.

Sample 1
A sample request used to add a new holiday while also updating another. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleManageHolidayCountryInfo": {
        "countryCode": "NO",
        "holidayYear": 2018
    },
    "titleManageHolidayDetails": [
        {
            "titleManageHolidayActionInfo": {
                "titleManageHolidayAction": "ADD"
            },
            "titleManageHolidayInfo":     {
                "holidayDate": "2018-01-01",
                "holidayName": "New Years day",
                "holidayOneLiner": "New Years day",
                "holidayType": "NATIONAL"
            }
        },
        {
            "titleManageHolidayActionInfo": {
                "titleManageHolidayAction": "MODIFY"
            },
            "titleManageHolidayInfo": {
                "holidayDate": "2018-05-17",
                "holidayName": "National Day",
                "holidayOneLiner": "Norge’s National Dag",
                "holidayType": "NATIONAL"
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The individual data elements of titleManageHolidayCountryInfo are defined as follows:

  • countryCode – contains the identification of the country for which the holidays are maintained. Must be an ISO defined country code. 
  • holidayYear – contains the year for which the holidays are maintained. 

The titleManageHolidayDetails structure contains the different actions to perform on the listed holidays. The structure contains an array entry for each update to perform. The updates are performed for the country and year given above. Each entry contains the attributes described below:

  • titleManageHolidayActionInfo – the action control structure.
    • titleManageHolidayAction – contains the action to perform. “ADD” adds a new holiday; “MODIFY” modifies an existing holiday while “REMOVE” removes an existing holiday. 
  • titleManageHolidayInfo – a structure holding the publishing day information.
    • HolidayDate – contains the date of the public holiday.
    • HolidayName – contains the short name of the holiday.
    • HolidayOneLiner – contains a brief description or one-liner for the holiday. HolidayType – contains a code indicating the type of holiday. The following codes are accepted:
      • NATIONAL” – the holiday is a national holiday.
      • STATE” – the holiday is a state holiday.
      • REGIONAL” – the holiday is a regional holiday.
      • LOCAL” – the holiday is a local holiday.

TitleManageHolidayResponse

The titleManageHolidayResponse is a JSON formatted response structure returned in response to the titleManageHolidayRequest

Sample 1
A sample response returned when a new publishing day has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageHolidayCountryInfo": {
        "countryCode": "NO",
        "holidayYear": 2018
    },
    "titleManageHolidayDetailsResponse": [
        {
            "titleManageHolidayActionInfoResponse": {
                "titleManageHolidayAction": "ADD"
            },
            "titleManageHolidayInfo":     {
                "holidayDate": "2018-01-01",
                "holidayName": "New Years day",
                "holidayOneLiner": "New Years day",
                "holidayType": "NATIONAL"
            }
        },
        {
            "titleManageHolidayActionInfoResponse": {
                "titleManageHolidayAction": "MODIFY"
            },
            "titleManageHolidayInfo":     {
                "holidayDate": "2018-05-17",
                "holidayName": "National Day",
                "holidayOneLiner": "Norge’s National Dag",
                "holidayType": "NATIONAL"
            }
        }
    ]
}

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 titleManageHolidayCountryInfo are defined as follows:

  • countryCode – contains the identification of the country for which the holidays are maintained. Must be an ISO defined country code. 
  • holidayYear – contains the year for which the holidays are maintained. 

The titleManageHolidayDetailsResponse structure contains the different actions to perform on the listed holidays. The structure contains an array entry for each update to perform. The updates are performed for the country and year given above. Each entry contains the attributes described below:

  • titleManageHolidayActionInfoResponse – the action control structure.
    • titleManageHolidayAction – contains the action to perform. “ADD” adds a new holiday; “MODIFY” modifies an existing holiday while “REMOVE” removes an existing holiday. 
    • resultCode – contains the result of the request processing for this action. A value of 0 (zero) indicates success. Other codes indicate failure. 
    • resultText – contains a short text describing the error encountered for this action. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 
  • titleManageHolidayInfo – a structure holding the publishing day information
    • HolidayDate – contains the date of the public holiday.
    • HolidayName – contains the short name of the holiday 
    • HolidayOneLiner – contains a brief description or one-liner for the holiday. HolidayType – contains a code indicating the type of holiday. The following codes are accepted:
      • NATIONAL” – the holiday is a national holiday.
      • STATE” – the holiday is a state holiday.
      • REGIONAL” – the holiday is a regional holiday.
      • LOCAL” – the holiday is a local holiday.
         

Generate Calendar (JSON API)

Endpoint

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

TitleGenerateCalendarRequest

The TitleGenerateCalendarRequest message is a JSON formatted message used to initiate the generation of publishing calendars for a given title and date range. The calendar details are generated based on the public holidays for a given country and the configuration of the title itself. 

Sample 1
A sample request to generate the publishing calendar for a given title and date range.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleGenerateCalendarDetails": {
        "titleCode": "RB",
        "calendarStartDate": "2018-01-01",
        "calendarEndDate": "2018-12-31"
    }
}

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

  • titleCode – contains the identification of the title for which the calendar entries should be generated.
  • calendarStartDate – contains the start date of the date range to be generated. Format is YYYY-MM-DD.
  • calendarEndDate – contains the last date of the date range to be generated. Format is YYYY-MM-DD.


TitleGenerateCalendarResponse

The TitleGenerateCalendarResponse message is a JSON formatted message returned in response to the request to generate new publishing calendars for a title and date range. 

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 Calendar (JSON API)

Endpoint

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

TitleRetrieveCalendarRequest

The TitleRetrieveCalendarRequest is a JSON formatted request structure used by the caller to retrieve details on the publishing calendar for a given title and date range. All calendar entries are returned in the response. 

Sample 1
A sample request used to retrieve the publishing calendar for a given title and date range. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleRetrieveCalendarInfo": {
        "titleCode": "RB",
        "calendarStartDate": "2018-01-01",
        "calendarEndDate": "2018-12-31"
    }
}

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

  • titleCode – contains the identification of the title for which the calendar entries should be returned.
  • calendarStartDate – contains the start date of the date range to be retrieved and returned. Format is YYYY-MM-DD.
  • calendarEndDate – contains the last date of the date range to be retrieved and returned. Format is YYYY-MM-DD. 

TitleRetrieveCalendarResponse

The TitleRetrieveCalendarResponse is a JSON formatted response structure used return details on the publishing calendar for a given title and date range. Multiple entries may exist depending on the title and its publishing calendar. 

Sample 1
A sample response showing multiple publishing calendar entries. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageCalendarTitleInfo": {
        "titleCode": "RB",
        "calendarStartDate": "2018-01-01",
        "calendarEndDate": "2018-12-31"
    },
    "titleRetrieveCalendarList": [
        {
            "titlePublDate": "2018-04-23",
            "titlePublDateType": "N",
            "titlePublOriginalDate": "",
            "titlePublWeekNo": 17,
            "titlePublWeekNoYear": 2018,
            "titlePublDayOfWeek": 1,
            "titleEarliestDeliveryChangeDate": "2018-04-25",
            "TitleDistFileGenDate": "2018-04-21",
            "TitleDistDateStart": "2018-04-20", 
            "TitleDistDateEnd": "2018-04-23"
        },
        {
            "titlePublDate": "2018-04-24",
            "titlePublDateType": "N",
            "titlePublOriginalDate": "",
            "titlePublWeekNo": 17,
            "titlePublWeekNoYear": 2018,
            "titlePublDayOfWeek": 2,
            "titleEarliestDeliveryChangeDate": "2018-04-26",
            "TitleDistFileGenDate": "2018-04-21",
            "TitleDistDateStart": "2018-04-20", 
            "TitleDistDateEnd": "2018-04-23"
        }
    ]
}

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 titleRetrieveCalendarTitleInfo are defined as follows:

  • titleCode – contains the identification of the title for which the calendar entries have been returned. 
  • calendarStartDate – contains the start date of the date range returned in the response.
  • calendarEndDate – contains the last date of the date range returned in the response.

The titleRetrieveCalendarList contains an array of the calendar entries returned. All calendar entries that exist in the given date range is returned. The structures is described below:

  • titleRetrieveCalendarList – the overall array structure.
    • titlePublDate – contains the date on which the title is published.
    • titlePublDateType – contains a code indicate the type of day on which the title is published. The following values exist:
      • N” – indicates that the date is a weekday.
      • W” – indicates that the date is a weekend date.
      • H” – indicates that the date is a public holiday date.
    • titlePublOriginalDate – contains a date where the title was originally scheduled to be published. Is null, if the publishing date has not been changed by the user. 
    • titlePublWeekNo – contains the week number in which the publishing date occurs. 
    • titlePublWeekNoYear – contains the year associated with the week found in the previous attribute. May reference a year other than that found in publishing date. 
    • titlePublDayOfWeek – contains a code indicate the day of the week to which the publishing date points. The following values exist:
      • 1 – the publishing date is a Monday.
      • 2 – the publishing date is a Tuesday.
      • 3 – the publishing date is a Wednesday.
      • 4 – the publishing date is a Thursday.
      • 5 – the publishing date is a Friday.
      • 6 – the publishing date is a Saturday.
      • 7 – the publishing date is a Sunday.
    • titleEarliestDeliveryChangeDate – contains the earliest possible date a delivery change can be executed for the current title. Is set to a date in format YYYY-MM-DD. 
    • titleDistFileGenDate – contains the date address changes occurring on the current publishing day is sent to the external distribution company. Is set to a date in format YYYY-MM-DD.
    • titleDistDateStart – contains the start of the range of dates to be included when the address changes are sent to the external distribution company. Is set to a date in format YYYY-MM-DD.
    • titleDistDateEnd – contains the end of the range of dates to be included when the address changes are sent to the external distribution company. Is set to a date in format YYYY-MM-DD.
       

Manage Calendar (JSON API)

Endpoint

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

TitleManageCalendarRequest

The TitleManageCalendarRequest is a JSON formatted request structure used by the caller to add, modify or remove publishing days currently in a given titles publishing calendar. If moving a publishing day from one day to another, then two entries must be added to the request, namely a request to ADD a new entry and a REMOVE of the old entry. 

Sample 1
A sample request used to add a new publishing day while also removing one. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleManageCalendarTitleInfo": {
        "titleCode": "RB"
    },
    "titleManageCalendarDetails": [
        {
            "titleManageCalendarActionInfo": {
                "titleManageCalendarAction": "ADD"
            },
            "titleManageCalendarInfo": {
                "titlePublDate": "2018-04-23",
                "titlePublDateType": "N",
                "titlePublOriginalDate": "2018-04-22",
                "titlePublWeekNo": 17,
                "titlePublWeekNoYear": 2018,
                "titlePublDayOfWeek": 1,
                "titleDistFileGenDate": "2018-04-20"
            }
        },
        {
            "titleManageCalendarActionInfo": {
                "titleManageCalendarAction": "REMOVE"
            },
            "titleManageCalendarInfo": {
                "titlePublDate": "2018-04-22",
                "titlePublDateType": "N",
                "titlePublOriginalDate": "",
                "titlePublWeekNo": 17,
                "titlePublWeekNoYear": 2018,
                "titlePublDayOfWeek": 1,
                "titleDistFileGenDate": "2018-04-20"
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The individual data elements of titleManageCalendarTitleInfo are defined as follows:

  • titleCode – contains the identification of the title for which the calendar entries should be added, modified or removed. 

The titleManageCalendarDetails 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:

  • titleManageCalendarActionInfo – the action control structure.
    • titleManageCalendarAction – contains the action to perform. “ADD” adds a new publishing date; “MODIFY” modifies an existing publishing date while “REMOVE” removes an existing publishing date. 
  • titleManageCalendarInfo – a structure holding the publishing day information
    • titlePublDate – contains the date on which the title is published
    • titlePublDateType – contains a code indicate the type of day on which the title is published. The following values exist:
      • N” – indicates that the date is a weekday
      • W” – indicates that the date is a weekend date
      • H” – indicates that the date is a public holiday date
    • titlePublOriginalDate – contains a date where the title was originally scheduled to be published. Is null, if the publishing date has not been changed by the user. 
    • titlePublWeekNo – contains the week number in which the publishing date occurs. 
    • titlePublWeekNoYear – contains the year associated with the week found in the previous attribute. May reference a year other than that found in publishing date. 
    • titlePublDayOfWeek – contains a code indicate the day of the week to which the publishing date points. The following values exist:
      • 1 – the publishing date is a Monday
      • 2 – the publishing date is a Tuesday
      • 3 – the publishing date is a Wednesday
      • 4 – the publishing date is a Thursday
      • 5 – the publishing date is a Friday
      • 6 – the publishing date is a Saturday
      • 7 – the publishing date is a Sunday 
    • titleDistFileGenDate – contains the date on which changes are sent to the distribution company, if the address change is scheduled on this delivery day. 

TitleManageCalendarResponse

The titleManageCalendarResponse is a JSON formatted response structure returned in response to the titleManageCalendarRequest

Sample 1
A sample response returned when a new publishing day has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageCalendarTitleInfo": {
        "titleCode": "RB"
    },
    "titleManageCalendarDetailsResponse": [
        {
            "titleManageCalendarActionInfoResponse": {
                "titleManageCalendarAction": "ADD"
            },
            "titleManageCalendarInfo": {
                "titlePublDate": "2018-04-23",
                "titlePublDateType": "N",
                "titlePublOriginalDate": "2018-04-22",
                "titlePublWeekNo": 17,
                "titlePublWeekNoYear": 2018,
                "titlePublDayOfWeek": 1,
                "titleDistFileGenDate": "2018-04-20"
            }
        },
        {
            "titleManageCalendarActionInfoResponse": {
                "titleManageCalendarAction": "REMOVE"
            },
            "titleManageCalendarInfo": {
                "titlePublDate": "2018-04-22",
                "titlePublDateType": "N",
                "titlePublOriginalDate": "",
                "titlePublWeekNo": 17,
                "titlePublWeekNoYear": 2018,
                "titlePublDayOfWeek": 1,
                "titleDistFileGenDate": "2018-04-20"
            }
        }
    ]
}

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 titleManageCalendarTitleInfo are defined as follows:

  • titleCode – contains the identification of the title for which the calendar entries has been added, modified or removed. 

The titleManageCalendarDetailsResponse 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:

  • titleManageCalendarActionInfoResponse – the action control structure.
    • titleManageCalendarAction – contains the action to perform. “ADD” adds a new publishing date; “MODIFY” modifies an existing publishing date while “REMOVE” removes an existing publishing date. 
    • 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. 
  • titleManageCalendarInfo – a structure holding the publishing day information
    • titlePublDate – contains the date on which the title is published
    • titlePublDateType – contains a code indicate the type of day on which the title is published. The following values exist:
      • N” – indicates that the date is a weekday.
      • W” – indicates that the date is a weekend date.
      • H” – indicates that the date is a public holiday date.
    • titlePublOriginalDate – contains a date where the title was originally scheduled to be published. Is null, if the publishing date has not been changed by the user. 
    • titlePublWeekNo – contains the week number in which the publishing date occurs. 
    • titlePublWeekNoYear – contains the year associated with the week found in the previous attribute. May reference a year other than that found in publishing date. 
    • titlePublDayOfWeek – contains a code indicate the day of the week to which the publishing date points. The following values exist:
      • 1 – the publishing date is a Monday.
      • 2 – the publishing date is a Tuesday.
      • 3 – the publishing date is a Wednesday.
      • 4 – the publishing date is a Thursday.
      • 5 – the publishing date is a Friday.
      • 6 – the publishing date is a Saturday.
      • 7 – the publishing date is a Sunday. 
    • titleDistFileGenDate – contains the date on which changes are sent to the distribution company, if the address change is scheduled on this delivery day. 
       

Retrieve Titles (JSON API)

Endpoint

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

TitleRetrieveTitlesRequest

The TitleRetrieveTitlesRequest message is a JSON formatted message used to retrieve titles currently registered in the solution. The request allows the caller to retrieve all registered titles, or only a specific title. 

Sample 1
A sample request used to retrieve a specific title. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleRetrieveTitlesInfoDetails": {
        "specificTitle": "SPECIFIC",
        "titleCode": "RB"
    }
}

Sample 2
A sample request used to retrieve all titles currently registered. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleRetrieveTitlesInfoDetails": {
        "specificTitle": "ALL",
        "titleCode": ""
    }
}

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

  • specificTitle - contains a code indicating whether all titles are to be returned or just a single title. The following codes are allowed:
    • ALL” – return all registered titles.
    • SPECIFIC” – return only the title specified in titleCode.  
  • titleCode – contains the identification of the title to be returned if specificTitle contains “SPECIFIC”. If it contains “ALL” the titleCode field is not used and should be blank. 

TitleRetrieveTitlesResponse

The TitleRetrieveTitlesResponse message is a JSON formatted message listing all titles currently registered for a given account. 

Sample 1
A sample response listing all titles currently registered. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleRetrieveTitlesList": [
        {
            "titleRetrieveTitlesTitleInfo": {
                "titleCode": "RB",
                "titleName": "Romerikes Blad",
                "titleDesc": "Romerikes Blad",
                "titleDistSystem": "DI-BATCH",
                "titleDistType": "DELTA",
                "titleDistAdvDays": 2,
                "titleDistDaysOfWeek": "NNNNNXX",
                "titleDistTimeOfDay": "22:00:00",
                "titleDistNextExecution": "2018-04-21 22:00:00",
                "titlePublCalStart": "2018-01-01",
                "titlePublCalEnd": "2019-12-31",
                "titleOwnerID": "OWNER",
                "titleDomain": "www.owner.no",
                "titleERPGLCode": "3511",
                "titleDistTitleCode": "DI-RB",
                "titleAccessTitleCode": “ACC-RB”,
                "titleDistPublTiming": "1",
                "titleCountryCode": "NO",
                "titleLogoReference": "logo.jpg"
            },
            "titleRetrieveTitlesTitleAddInfo": {
                "titleNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Oslo Blad"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Oslo Blad"}
                    ]
                },
                "titleDescTranslations": {
                    "solmRefTransNo": 1235,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Lokalavisa Oslo Blad"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Lokalavisa Oslo Blad"}
                    ]
                },
                "titleOwnerName": "OWNER A/S",
                "titleOwnerDesc": "Mediakompagniet OWNER A/S",
                "titleDistSystemName": "BATCH DI",
                "titleDistSystemDesc": "Batch Interface to Distribution Innovation AS"
            },
            "titleRetrieveTitlesCompanyInfo": {
                "titleCompanyName": "[CLIENT] Billing AS",
                "titleCompanyID": "AMBILL",
                "titleCompanyVATNumber": "NO11223344",
                "titleCompanyBusinessReg": "1122334455",
                "titleCompanyBankAccount": "16700815678",
                "titleCompanyIBAN": "NO9316700815678",
                "titleCompanySWIFTAddress": "NOKNXXXX",
                "titleCompanyLogoReference": "[CLIENT]Billing.jpg",
                "titleCompanyAddress": {
                    "titleCompanyFullName": "[CLIENT] Billing AS",
                    "titleCompanyAddressLine1": "Akersgt. 34",
                    "titleCompanyAddressLine2": "",
                    "titleCompanyAddressLine3": "",
                    "titleCompanyCity": "Oslo",
                    "titleCompanyLocality": "",
                    "titleCompanyStateProvince": "",
                    "titleCompanyPostalCode": "0454",
                    "titleCompanyCountryCode": "NO",
                    "titleCompanyCountryName": "Norge"
                },
                "titleCompanyContact": {
                    "titlePrimaryPhoneNumber": "+4722334455",
                    "titlePrimaryEmailAddress": "info@[CLIENT]billing.no",
                    "titlePrimaryFaxNumber": "+4722334456",
                    "titlePrimaryURL": "www.[CLIENT]billing.no/bruker",
                    "titleSecondaryPhoneNumber": "+4722334466",
                    "titleSecondaryEmailAddress": "faktura@[CLIENT]billing.no",
                    "titleSecondaryFaxNumber": "+4722334467",
                    "titleSecondaryURL": "www.[CLIENT]billing.no/faktura",
                    "titleServicePhoneNumber": "+4722334477",
                    "titleServiceEmailAddress": "service@[CLIENT]billing.no",
                    "titleServiceFaxNumber": "+4722334478",
                    "titleServiceURL": "www.[CLIENT]billing.no/service"
                }
            },
            "titleRetrieveTitlesPaymentOptionList": [
                {
                    "titleRetrieveTitlesPaymentOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titlePayTermID": "BANKGIRO-01",
                        "titlePayTermDefault": "YES"
                    },
                    "titleRetrieveTitlesPaymentOptionAddInfo": {
                        "titlePayOptionName": "Bankgiro",
                        "titlePayOptionDesc": "Bankgiro / OCR",
                        "titlePayTermName": "Bankgiro (Default)",
                        "titlePayTermDesc": "Bankgiro (Default)",
                        "titlePayTermDescTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bankgiro"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Bankgiro"}
                            ]
                        },
                        "titlePayTermNameTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bankgiro (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Bankgiro (Default)"}
                            ]
                        }
                    }
                }
            ],
            "titleRetrieveTitlesDunningOptionList": [
                {
                    "titleRetrieveTitlesDunningOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titleDunProcID": "DUNNING-01",
                        "titleDunProcDefault": "YES"
                    },
                    "titleRetrieveTitlesDunningOptionAddInfo": {
                        "titlePayOptionName": "Bankgiro",
                        "titlePayOptionDesc": "Bankgiro / OCR",
                        "titleDunProcName": "Dunning (Default)",
                        "titleDunProcDesc": "Dunning (Default)",
                        "titleDunProcDescTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning (Default)"}
                            ]
                        },
                        "titleDunProcNameTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning (Default)"}
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

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 titleRetrieveTitlesList contains an array of the titles returned. Will return either the requested title or all registered titles. Each title is returned in the two structures, both occurring in the same entry of the array. The structures are titleRetrieveTitlesTitleInfo and titleRetrieveTitlesTitleAddInfo as described below:

  • titleRetrieveTitlesTitleInfo - contains details on the title itself. 
    • titleCode – a value representing the title code. 
    • titleName – a string value that contains the name associated with the title code. 
    • titleDesc – a string that contains a brief description of the title code. 
    • titleDistSystem – contains a code indicating what system the printed media is distributed via. The codes must exist in the TitleDistSystem table. 
    • titleDistType – contains a code indicating how changes are sent to the distribution system identified in TitleDistSystem. The following codes apply:
      • FULL” – information on deliveries to ALL customers are transferred in each file. 
      • DELTA” – information on any changes, i.e. the delta, are transferred in each file. 
    • titleDistAdvDays – contains the number of days before the change in delivery takes place, that the change must be sent to the distribution system. Must contain a value greater than zero, if an external distribution system is used. 
    • titleDistDaysOfWeek – contains a code per weekday indicating whether the system should distribute address changes to the selected distribution system. The first character represents Monday, second character represents Tuesday and so on. Each day may be represented by the following codes:
      • X” – indicates that no address changes are distributed on the given day.
      • N” – indicates that address changes are distributed on the given day. 
    • titleDistTimeOfDay – contains the time of day when the changes in distribution must be sent to the distribution system using the chosen method. The format is HH:MM:SS
    • titleDistNextExecution – contains the date and time the distribution should be executed next. When moving the execution date and time, only the date is moved. The time is kept as it was originally defined.  The format is YYYY-MM-DD HH:MM:SS
    • titlePublCalStart – contains the date from which the publishing calendar has been generated for the current title. Information only.
    • titlePublCalEnd – contains the date until which the publishing calendar has been generated. This date is used when creating further calendar entries for this title. 
    • titleOwnerID – contains a code identifying the owner of the title. The title owner must exist in the TitleOwner table. 
    • titleDomain – contains the domain name associated with the title code. 
    • titleERPGLCode – contains the code used to represent the title in client’s ERP system. 
    • titleDistTitleCode – contains the code used to represent the title in the distribution system. 
    • titleAccessTitleCode – contains the code used to represent the title in the access management system. 
    • titleDistPublTiming – contains a code indicating the time of day the title is published. The following codes apply:
      • 1” – published in the morning.
      • 2” – published in the evening.
    • titleCountryCode – contains a code indicating the country in which the title is published. Must contain a valid ISO country code. 
    • titleLogoReference – contains the identification of the logo to be used for the current title.

The titleRetrieveTitlesTitleAddInfo contains the additional information for a title retrieved from other tables, and not as such updateable. The attributes are defined as follows:

  • titleRetrieveTitlesTitleAddInfo – contains additional information the title returned. 
    • titleNameTranslations – contains the translations related to the title name. 
      • solmRefTransNo – contains the identification of the translation for this title name. 
      • solmTranslationEntry – an array containing an element for each locale the title name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title name is returned.
        • solmRefTransText– contains the name of the title name in the locale (language) described by solmLocaleID
    • titleDescTranslations – contains the translations related to the title description. 
      • solmRefTransNo – contains the identification of the translation for this title description. 
      • solmTranslationEntry – an array containing an element for each locale the title description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title description is returned.
        • solmRefTransText– contains the name of the title description in the locale (language) described by solmLocaleID
    • titleOwnerName – contains the name of the owner associated with the current title. Is retrieved from the TitleOwner table. 
    • titleOwnerDesc – contains the description of the owner associated with the current title. Is retrieved from the TitleOwner table. 
    • titleDistSystemName – contains the name of the distribution system associated with the current title. Is retrieved from the TitleDistSystem table. 
    • titleDistSystemDesc – contains the description of the distribution system associated with the current title. Is retrieved from the TitleDistSystem table. 

The titleRetrieveTitlesCompanyInfo contains the additional company information for a title. The information describes the company that issues the invoices for this title. The attributes are defined as follows:

  • titleRetrieveTitlesCompanyInfo – the overall structure holding the details on company that performs the billing for the title 
    • titleCompanyName – defines the name of the billing company.
    • titleCompanyID – defines a unique identification of the billing company.
    • titleCompanyVATNumber – defines the VAT number for the billing company.
    • titleCompanyBusinessReg – defines the business registration number for the billing company.
    • titleCompanyBankAccount – defines the bank account number to which payments should be made for invoices issued by the billing company. 
    • titleCompanyIBAN - defines the IBAN account number to which payments should be made for invoices issued by the billing company.
    • titleCompanySWIFTAddress - defines the swift address to which payments should be made for invoices issued by the billing company.
    • titleCompanyLogoReference – defines the identification of the logo to be used for the current billing company. 
    • titleCompanyAddress – a structure holding the address of the billing company.
      • titleCompanyFullName – defines the full name of the billing company.
      • titleCompanyAddressLine1 – defines the first address line for the billing company.
      • titleCompanyAddressLine2 – defines the second address line for the billing company.
      • titleCompanyAddressLine3 – defines the third address line for the billing company.
      • titleCompanyCity – the city where the address is found.
      • titleCompanyPostalCode – the postal code / zip code of the current address.
      • titleCompanyCountryCode – contains the ISO country code associated with the current address.
      • titleCompanyLocality – contains the locality of the current address.
      • titleCompanyStateProvince – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
      • titleCompanyCountryName – contains the name associated with the current country code of the billing company. 
    • titleCompanyContact
      • titlePrimaryPhoneNumber – defines the primary telephone of the billing company.
      • titlePrimaryEmailAddress – defines the primary email address of the billing company.
      • titlePrimaryFaxNumber – defines the primary fax number of the billing company.
      • titlePrimaryURL – defines the primary URL for the billing company.
      • titleSecondaryPhoneNumber – defines the secondary telephone of the billing company.
      • titleSecondaryEmailAddress – defines the secondary email address of the billing company.
      • titleSecondaryFaxNumber – defines the secondary fax number of the billing company.
      • titleSecondaryURL – defines the secondary URL for the billing company.
      • titleServicePhoneNumber – defines the service telephone of the billing company.
      • titleServiceEmailAddress – defines the service email address of the billing company.
      • titleServiceFaxNumber – defines the service fax number of the billing company.
      • titleServiceURL – defines the service URL for the billing company.

The titleRetrieveTitlesPaymentOptionList contains a list (array) of all the payment terms defined for the current title. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleRetrieveTitlesPaymentOptionList – the array holding the list of payment options applied for the current title. 
    • titleRetrieveTitlesPaymentOptionInfo – a structure holding the overall updateable payment option information. 
      • titlePayOptionID – contains the identification of the payment option associated with the current title.
      • titlePayOptionVariant – contains the variant of the payment option associated with the current title.
      • titlePayTermID – contains the identification of the payment term to be used for the title when the payment option and payment option variant has been chosen. 
      • titlePayTermDefault – contains a code indicating whether the term is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default.
        • "NO" indicates that it is not the default. 
    • titleRetrieveTitlesPaymentOptionAddInfo – a structure holding additional information for the payment options. 
      • titlePayOptionName – define the name of the payment option configured.
      • titlePayOptionDesc – defines the brief description of the payment option configured.
      • titlePayTermName – define the name of the payment term configured.
      • titlePayTermDesc – defines the brief description of the payment term configured.
      • titlePayTermNameTranslations – contains the translations related to the payment term name.
        • solmRefTransNo – contains the identification of the translation. 
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID
      • titlePayTermDescTranslations – contains the translations related to the payment term description
        • solmRefTransNo – contains the identification of the translation 
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID

The titleRetrieveTitlesDunningOptionList contains a list (array) of all the dunning processes defined for the current title per payment option. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleRetrieveTitlesDunningOptionList – the array holding the list of dunning options applied for the current title. 
    • titleRetrieveTitlesDunningOptionInfo – a structure holding the overall updateable dunning option information. 
      • titlePayOptionID – contains the identification of the dunning option associated with the current title.
      • titlePayOptionVariant – contains the variant of the dunning option associated with the current title.
      • titleDunProcID – contains the identification of the dunning process to be used for the title when the payment option and payment option variant has been chosen. 
      • titleDunProcDefault – contains a code indicating whether the dunning process is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default.
        • "NO" indicates that it is not the default. 
    • titleRetrieveTitlesDunningOptionAddInfo – a structure holding additional information for the dunning options. 
      • titlePayOptionName – define the name of the payment option configured.
      • titlePayOptionDesc – defines the brief description of the payment option configured.
      • titleDunProcName – define the name of the dunning process configured.
      • titleDunProcDesc – defines the brief description of the dunning process configured.
      • titleDunProcNameTranslations – contains the translations related to the dunning process name.
        • solmRefTransNo – contains the identification of the translation.
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID
      • titleDunProcDescTranslations – contains the translations related to the dunning process description.
        • solmRefTransNo – contains the identification of the translation. 
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID

Manage Titles (JSON API)

Endpoint

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

TitleManageTitleRequest

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

Sample 1
A sample request to add a single title.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "TitleManageTitleList": [
        {
            "titleManageTitleActionInfo": {
                "titleManageTitleAction": "ADD"
            },
            "titleManageTitleInfo": {
                "titleCode": "DT",
                "titleName": "Drammens Tidende",
                "titleDesc": "Drammens Tidende",
                "titleDistSystem": "DI-BATCH",
                "titleDistType": "DELTA",
                "titleDistAdvDays": 1,
                "titleDistDaysOfWeek": "NNNNNXX",
                "titleDistTimeOfDay": "22:00:00",
                "titleDistNextExecution": "2018-04-23 22:00:00",
                "titlePublCalStart": null,
                "titlePublCalEnd": null,
                "titleOwnerID": "[CLIENT]",
                "titleDomain": "www.dt.no",
                "titleERPGLCode": "2611",
                "titleDistTitleCode": "DI-DT",
                "titleAccessTitleCode": "ACC-DT",
                "titleDistPublTiming": "1",
                "titleCountryCode": "NO"
            },
            "titleManageTitleAddInfo": {
                "titleNameRefTransNo": 12345,
                "titleNameTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ],
                "titleDescRefTransNo": 12346,
                "titleDescTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ]
            },
            "titleManageTitleCompanyInfo": {
                "titleCompanyName": "[CLIENT] Billing AS",
                "titleCompanyID": "AMBILL",
                "titleCompanyVATNumber": "NO11223344",
                "titleCompanyBusinessReg": "1122334455",
                "titleCompanyBankAccount": "16700815678",
                "titleCompanyIBAN": "NO9316700815678",
                "titleCompanySWIFTAddress": "NOKNXXXX",
                "titleCompanyLogoReference": "[CLIENT]Billing.jpg",
                "titleCompanyAddress": {
                    "titleCompanyFullName": "[CLIENT] Billing AS",
                    "titleCompanyAddressLine1": "Akersgt. 34",
                    "titleCompanyAddressLine2": "",
                    "titleCompanyAddressLine3": "",
                    "titleCompanyCity": "Oslo",
                    "titleCompanyLocality": "",
                    "titleCompanyStateProvince": "",
                    "titleCompanyPostalCode": "0454",
                    "titleCompanyCountryCode": "NO",
                    "titleCompanyCountryName": "Norge"
                },
                "titleCompanyContact": {
                    "titlePrimaryPhoneNumber": "+4722334455",
                    "titlePrimaryEmailAddress": "info@[CLIENT]billing.no",
                    "titlePrimaryFaxNumber": "+4722334456",
                    "titlePrimaryURL": "www.[CLIENT]billing.no/bruker",
                    "titleSecondaryPhoneNumber": "+4722334466",
                    "titleSecondaryEmailAddress": "faktura@[CLIENT]billing.no",
                    "titleSecondaryFaxNumber": "+4722334467",
                    "titleSecondaryURL": "www.[CLIENT]billing.no/faktura",
                    "titleServicePhoneNumber": "+4722334477",
                    "titleServiceEmailAddress": "service@[CLIENT]billing.no",
                    "titleServiceFaxNumber": "+4722334478",
                    "titleServiceURL": "www.[CLIENT]billing.no/service"
                }
            },
            "titleManageTitlePaymentOptionList": [
                {
                    "titleRetrieveTitlesPaymentOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titlePayTermID": "BANKGIRO-01",
                        "titlePayTermDefault": "YES"
                    }
                }
            ],
            "titleManageTitleDunningOptionList": [
                {
                    "titleRetrieveTitlesDunningOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titleDunProcID": "DUNNING-01",
                        "titleDunProcDefault": "YES"
                    }
                }
            ]
        }
    ]
}

Sample 2
A sample request to remove a given title. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "TitleManageTitleList": [
        {
            "titleManageTitleActionInfo": {
                "titleManageTitleAction": "REMOVE"
            },
            "titleManageTitleInfo": {
                "titleCode": "DT",
                "titleName": "Drammens Tidende",
                "titleDesc": "Drammens Tidende",
                "titleDistSystem": "DI-BATCH",
                "titleDistType": "DELTA",
                "titleDistAdvDays": 1,
                "titleDistDaysOfWeek": "NNNNNXX",
                "titleDistTimeOfDay": "22:00:00",
                "titleDistNextExecution": "2018-04-23 22:00:00",
                "titlePublCalStart": "",
                "titlePublCalEnd": "",
                "titleOwnerID": "OWNER",
                "titleDomain": "www.owner.no",
                "titleERPGLCode": "2611",
                "titleDistTitleCode": "DI-DT",
                "titleAccessTitleCode": "ACC-DT",
                "titleDistPublTiming": "1",
                "titleCountryCode": "NO"
            },
            "titleManageTitleAddInfo": {
                "titleNameRefTransNo": 12345,
                "titleNameTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-BOKMAL-A-ENDING", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ],
                "titleDescRefTransNo": 12346,
                "titleDescTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-BOKMAL-A-ENDING", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ]
            },
            "titleManageTitleCompanyInfo": {
                "titleCompanyName": "[CLIENT] Billing AS",
                "titleCompanyID": "AMBILL",
                "titleCompanyVATNumber": "NO11223344",
                "titleCompanyBusinessReg": "1122334455",
                "titleCompanyBankAccount": "16700815678",
                "titleCompanyIBAN": "NO9316700815678",
                "titleCompanySWIFTAddress": "NOKNXXXX",
                "titleCompanyLogoReference": "[CLIENT]Billing.jpg",
                "titleCompanyAddress": {
                    "titleCompanyFullName": "[CLIENT] Billing AS",
                    "titleCompanyAddressLine1": "Akersgt. 34",
                    "titleCompanyAddressLine2": "",
                    "titleCompanyAddressLine3": "",
                    "titleCompanyCity": "Oslo",
                    "titleCompanyLocality": "",
                    "titleCompanyStateProvince": "",
                    "titleCompanyPostalCode": "0454",
                    "titleCompanyCountryCode": "NO",
                    "titleCompanyCountryName": "Norge"
                },
                "titleCompanyContact": {
                    "titlePrimaryPhoneNumber": "+4722334455",
                    "titlePrimaryEmailAddress": "info@[CLIENT]billing.no",
                    "titlePrimaryFaxNumber": "+4722334456",
                    "titlePrimaryURL": "www.[CLIENT]billing.no/bruker",
                    "titleSecondaryPhoneNumber": "+4722334466",
                    "titleSecondaryEmailAddress": "faktura@[CLIENT]billing.no",
                    "titleSecondaryFaxNumber": "+4722334467",
                    "titleSecondaryURL": "www.[CLIENT]billing.no/faktura",
                    "titleServicePhoneNumber": "+4722334477",
                    "titleServiceEmailAddress": "service@[CLIENT]billing.no",
                    "titleServiceFaxNumber": "+4722334478",
                    "titleServiceURL": "www.[CLIENT]billing.no/service"
                }
            },
            "titleManageTitlePaymentOptionList": [
                {
                    "titleRetrieveTitlesPaymentOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titlePayTermID": "BANKGIRO-01",
                        "titlePayTermDefault": "YES"
                    }
                }
            ],
            "titleManageTitleDunningOptionList": [
                {
                    "titleRetrieveTitlesDunningOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titleDunProcID": "DUNNING-01",
                        "titleDunProcDefault": "YES"
                    }
                }
            ]
        }
    ]
}

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

  • titleManageTitleActionInfo – the action control structure.
    • titleManageTitleAction – contains the same value as provided in the request. 
  • titleManageTitleInfo - contains details on the address part. 
    • titleCode – a value representing the title code. 
    • titleName – a string value that contains the name associated with the title code. 
    • titleDesc – a string that contains a brief description of the title code. 
    • titleDistSystem – contains a code indicating what system the printed media is distributed via. Must exist in the TitleDistSystem table.  
    • titleDistType – contains a code indicating how changes are sent to the distribution system identified in TitleDistSystem. The following codes apply:
      • FULL” – information on deliveries to ALL customers are transferred in each file. 
      • DELTA” – information on any changes, i.e. the delta, are transferred in each file. 
    • titleDistAdvDays – contains the number of days before the change in delivery takes place, that the change must be sent to the distribution system. Must contain a value greater than zero, if an external distribution system is used. 
    • titleDistDaysOfWeek – contains a code per weekday indicating whether the system should distribute address changes to the selected distribution system. The first character represents Monday, second character represents Tuesday and so on. Each day may be represented by the following codes:
      • X” – indicates that no address changes are distributed on the given day.
      • N” – indicates that address changes are distributed on the given day. 
    • titleDistTimeOfDay – contains the time of day when the changes in distribution must be sent to the distribution system using the chosen method. The format is HH:MM:SS
    • titleDistNextExecution – contains the date and time the distribution should be executed next. When moving the execution date and time, only the date is moved. The time is kept as it was originally defined.  The format is YYYY-MM-DD HH:MM:SS
    • titlePublCalStart – contains the date from which the publishing calendar has been generated for the current title. Information only. When adding a new title, this field should be given as NULL. 
    • titlePublCalEnd – contains the date until which the publishing calendar has been generated. This date is used when creating further calendar entries for this title. When adding a new title, this field should be given as NULL.
    • titleOwnerID – contains a code identifying the owner of the title. The title owner must exist in the TitleOwner table. 
    • titleDomain – contains the domain name associated with the title code. 
    • titleERPGLCode – contains the code used to represent the title in [CLIENT]’s ERP system. 
    • titleDistTitleCode – contains the code used to represent the title in the distribution system. 
    • titleAccessTitleCode – contains the code used to represent the title in the access management system. 
    • titleDistPublTiming – contains a code indicating the time of day the title is published. The following codes apply:
      • 1” – published in the morning.
      • 2” – published in the evening.
    • titleCountryCode – contains a code indicating the country in which the title is published. Must contain a valid ISO country code. 
    • titleLogoReference – contains the identification of the logo to be used for the current title. 

The titleManageTitleAddInfo contains the additional information for a title retrieved from other tables, and not as such updateable. The attributes are defined as follows:

  • titleManageTitleAddInfo – contains additional information the title returned. 
    • titleNameTranslations – contains the translations related to the title name.
      • solmRefTransNo – contains the identification of the translation for this title name. 
      • solmTranslationEntry – an array containing an element for each locale the title name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title name is returned.
        • solmRefTransText– contains the name of the title name in the locale (language) described by solmLocaleID
    • titleDescTranslations – contains the translations related to the title description. 
      • solmRefTransNo – contains the identification of the translation for this title description. 
      • solmTranslationEntry – an array containing an element for each locale the title description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title description is returned
        • solmRefTransText– contains the name of the title description in the locale (language) described by solmLocaleID

The titleRetrieveTitlesCompanyInfo contains the additional company information for a title. The information describes the company that issues the invoices for this title. The attributes are defined as follows:

  • titleManageTitleCompanyInfo – the overall structure holding the details on company that performs the billing for the title 
    • titleCompanyName – defines the name of the billing company.
    • titleCompanyID – defines a unique identification of the billing company.
    • titleCompanyVATNumber – defines the VAT number for the billing company.
    • titleCompanyBusinessReg – defines the business registration number for the billing company
    • titleCompanyBankAccount – defines the bank account number to which payments should be made for invoices issued by the billing company. 
    • titleCompanyIBAN - defines the IBAN account number to which payments should be made for invoices issued by the billing company.
    • titleCompanySWIFTAddress - defines the swift address to which payments should be made for invoices issued by the billing company.
    • titleCompanyLogoReference – defines the identification of the logo to be used for the current billing company. 
    • titleCompanyAddress – a structure holding the address of the billing company.
      • titleCompanyFullName – defines the full name of the billing company.
      • titleCompanyAddressLine1 – defines the first address line for the billing company.
      • titleCompanyAddressLine2 – defines the second address line for the billing company.
      • titleCompanyAddressLine3 – defines the third address line for the billing company.
      • titleCompanyCity – the city where the address is found.
      • titleCompanyPostalCode – the postal code / zip code of the current address.
      • titleCompanyCountryCode – contains the ISO country code associated with the current address.
      • titleCompanyLocality – contains the locality of the current address.
      • titleCompanyStateProvince – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
      • titleCompanyCountryName – contains the name associated with the current country code of the billing company. 
    • titleCompanyContact
      • titlePrimaryPhoneNumber – defines the primary telephone of the billing company.
      • titlePrimaryEmailAddress – defines the primary email address of the billing company.
      • titlePrimaryFaxNumber – defines the primary fax number of the billing company.
      • titlePrimaryURL – defines the primary URL for the billing company.
      • titleSecondaryPhoneNumber – defines the secondary telephone of the billing company.
      • titleSecondaryEmailAddress – defines the secondary email address of the billing company.
      • titleSecondaryFaxNumber – defines the secondary fax number of the billing company.
      • titleSecondaryURL – defines the secondary URL for the billing company.
      • titleServicePhoneNumber – defines the service telephone of the billing company.
      • titleServiceEmailAddress – defines the service email address of the billing company.
      • titleServiceFaxNumber – defines the service fax number of the billing company.
      • titleServiceURL – defines the service URL for the billing company.

The titleManageTitlePaymentOptionList contains a list (array) of all the payment terms defined for the current title. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleManageTitlePaymentOptionList – the array holding the list of payment options applied for the current title. 
    • titleManageTitlePaymentOptionInfo – a structure holding the overall updateable payment option information. 
      • titlePayOptionID – contains the identification of the payment option associated with the current title.
      • titlePayOptionVariant – contains the variant of the payment option associated with the current title.
      • titlePayTermID – contains the identification of the payment term to be used for the title when the payment option and payment option variant has been chosen. 
      • titlePayTermDefault – contains a code indicating whether the term is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default.
        • "NO" indicates that it is not the default. 

The titleManageTitleDunningOptionList contains a list (array) of all the dunning processes defined for the current title per payment option. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleManageTitleDunningOptionList – the array holding the list of dunning options applied for the current title. 
    • titleManageTitleDunningOptionInfo – a structure holding the overall updateable dunning option information. 
      • titlePayOptionID – contains the identification of the dunning option associated with the current title.
      • titlePayOptionVariant – contains the variant of the dunning option associated with the current title.
      • titleDunProcID – contains the identification of the dunning process to be used for the title when the payment option and payment option variant has been chosen. 
      • titleDunProcDefault – contains a code indicating whether the dunning process is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default
        • "NO" indicates that it is not the default. 

TitleManageTitleResponse

The TitleManageTitleResponse is a JSON formatted response structure used by the caller to request the addition, update or removal of a title. 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 title. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "TitleManageTitleListResponse": [
        {
            "titleManageTitleActionInfoResponse": {
                "titleManageTitleAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageTitleInfo": {
                "titleCode": "DT",
                "titleName": "Drammens Tidende",
                "titleDesc": "Drammens Tidende",
                "titleDistSystem": "DI-BATCH",
                "titleDistType": "DELTA",
                "titleDistAdvDays": 1,
                "titleDistDaysOfWeek": "NNNNNXX",
                "titleDistTimeOfDay": "22:00:00",
                "titleDistNextExecution": "2018-04-23 22:00:00",
                "titlePublCalStart": "",
                "titlePublCalEnd": "",
                "titleOwnerID": "OWNER",
                "titleDomain": "www.owner.no",
                "titleERPGLCode": "2611",
                "titleDistTitleCode": "DI-DT",
                "titleAccessTitleCode": "ACC-DT",
                "titleDistPublTiming": "1",
                "titleCountryCode": "NO"
            },
            "titleManageTitleAddInfo": {
                "titleNameRefTransNo": 12345,
                "titleNameTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-BOKMAL-A-ENDING", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ],
                "titleDescRefTransNo": 12346,
                "titleDescTranslations": [
                    {"localeID": "NO-BOKMAL", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-BOKMAL-A-ENDING", "objectName": "Drammens Tidende"},
                    {"localeID": "NO-NYNORSK", "objectName": "Drammens Tidende"}
                ]
            },
            "titleManageTitleCompanyInfo": {
                "titleCompanyName": "[CLIENT] Billing AS",
                "titleCompanyID": "AMBILL",
                "titleCompanyVATNumber": "NO11223344",
                "titleCompanyBusinessReg": "1122334455",
                "titleCompanyBankAccount": "16700815678",
                "titleCompanyIBAN": "NO9316700815678",
                "titleCompanySWIFTAddress": "NOKNXXXX",
                "titleCompanyLogoReference": "[CLIENT]Billing.jpg",
                "titleCompanyAddress": {
                    "titleCompanyFullName": "[CLIENT] Billing AS",
                    "titleCompanyAddressLine1": "Akersgt. 34",
                    "titleCompanyAddressLine2": "",
                    "titleCompanyAddressLine3": "",
                    "titleCompanyCity": "Oslo",
                    "titleCompanyLocality": "",
                    "titleCompanyStateProvince": "",
                    "titleCompanyPostalCode": "0454",
                    "titleCompanyCountryCode": "NO",
                    "titleCompanyCountryName": "Norge"
                },
                "titleCompanyContact": {
                    "titlePrimaryPhoneNumber": "+4722334455",
                    "titlePrimaryEmailAddress": "info@[CLIENT]billing.no",
                    "titlePrimaryFaxNumber": "+4722334456",
                    "titlePrimaryURL": "www.[CLIENT]billing.no/bruker",
                    "titleSecondaryPhoneNumber": "+4722334466",
                    "titleSecondaryEmailAddress": "faktura@[CLIENT]billing.no",
                    "titleSecondaryFaxNumber": "+4722334467",
                    "titleSecondaryURL": "www.[CLIENT]billing.no/faktura",
                    "titleServicePhoneNumber": "+4722334477",
                    "titleServiceEmailAddress": "service@[CLIENT]billing.no",
                    "titleServiceFaxNumber": "+4722334478",
                    "titleServiceURL": "www.[CLIENT]billing.no/service"
                }
            },
            "titleManageTitlePaymentOptionListResponse": [
                {
                    "titleManageTitlePaymentOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titlePayTermID": "BANKGIRO-01",
                        "titlePayTermDefault": "YES"
                    },
                    "titleManageTitlePaymentOptionAddInfo": {
                        "titlePayOptionName": "Bankgiro",
                        "titlePayOptionDesc": "Bankgiro / OCR",
                        "titlePayTermName": "Bankgiro (Default)",
                        "titlePayTermDesc": "Bankgiro (Default)",
                        "titlePayTermDescTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bankgiro"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Bankgiro"}
                            ]
                        },
                        "titlePayTermNameTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Bankgiro (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Bankgiro (Default)"}
                            ]
                        }
                    }
                }
            ],
            "titleManageTitleDunningOptionListResponse": [
                {
                    "titleManageTitleDunningOptionInfo": {
                        "titlePayOptionID": "BANKGIRO",
                        "titlePayOptionVariant": "STANDARD",
                        "titleDunProcID": "DUNNING-01",
                        "titleDunProcDefault": "YES"
                    },
                    "titleManageTitleDunningOptionAddInfo": {
                        "titlePayOptionName": "Bankgiro",
                        "titlePayOptionDesc": "Bankgiro / OCR",
                        "titleDunProcName": "Dunning (Default)",
                        "titleDunProcDesc": "Dunning (Default)",
                        "titleDunProcDescTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning (Default)"}
                            ]
                        },
                        "titleDunProcNameTranslations": {
                            "solmRefTransNo": 1235,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning (Default)"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning (Default)"}
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

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

  • titleManageTitleActionInfoResponse – the overall array structure.
    • titleManageTitleAction – 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. 
  • titleManageTitleInfo - contains details on the address part. 
    • titleCode – a value representing the title code. 
    • titleName – a string value that contains the name associated with the title code. 
    • titleDesc – a string that contains a brief description of the title code. 
    • titleDistSystem – contains a code indicating what system the printed media is distributed via. Must exist in the TitleDistSystem table. 
    • titleDistType – contains a code indicating how changes are sent to the distribution system identified in TitleDistSystem. The following codes apply:
      • FULL” – information on deliveries to ALL customers are transferred in each file. 
      • DELTA” – information on any changes, i.e. the delta, are transferred in each file. 
    • titleDistAdvDays – contains the number of days before the change in delivery takes place, that the change must be sent to the distribution system. Must contain a value greater than zero, if an external distribution system is used. 
    • titleDistDaysOfWeek – contains a code per weekday indicating whether the system should distribute address changes to the selected distribution system. The first character represents Monday, second character represents Tuesday and so on. Each day may be represented by the following codes:
      • X” – indicates that no address changes are distributed on the given day.
      • N” – indicates that address changes are distributed on the given day. 
    • titleDistTimeOfDay – contains the time of day when the changes in distribution must be sent to the distribution system using the chosen method. The format is HH:MM:SS
    • titleDistNextExecution – contains the date and time the distribution should be executed next. When moving the execution date and time, only the date is moved. The time is kept as it was originally defined.  The format is YYYY-MM-DD HH:MM:SS
    • titlePublCalStart – contains the date from which the publishing calendar has been generated for the current title. Information only.
    • titlePublCalEnd – contains the date until which the publishing calendar has been generated. This date is used when creating further calendar entries for this title. 
    • titleOwnerID – contains a code identifying the owner of the title. The title owner must exist in the TitleOwner table. 
    • titleDomain – contains the domain name associated with the title code. 
    • titleERPGLCode – contains the code used to represent the title in [CLIENT]’s ERP system. 
    • titleDistTitleCode – contains the code used to represent the title in the distribution system. 
    • titleAccessTitleCode – contains the code used to represent the title in the access management system. 
    • titleDistPublTiming – contains a code indicating the time of day the title is published. The following codes apply:
      • 1” – published in the morning.
      • 2” – published in the evening.
    • titleCountryCode – contains a code indicating the country in which the title is published. Must contain a valid ISO country code. 
    • titleLogoReference – contains the identification of the logo to be used for the current title.

The titleManageTitleAddInfo contains the additional information for a title retrieved from other tables, and not as such updateable. The attributes are defined as follows:

  • titleManageTitleAddInfo – contains additional information the title returned. 
    • titleNameTranslations – contains the translations related to the title name.
      • solmRefTransNo – contains the identification of the translation for this title name. 
      • solmTranslationEntry – an array containing an element for each locale the title name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title name is returned.
        • solmRefTransText– contains the name of the title name in the locale (language) described by solmLocaleID.  
    • titleDescTranslations – contains the translations related to the title description. 
      • solmRefTransNo – contains the identification of the translation for this title description. 
      • solmTranslationEntry – an array containing an element for each locale the title description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the title description is returned.
        • solmRefTransText– contains the name of the title description in the locale (language) described by solmLocaleID

The titleManageTitleCompanyInfo contains the additional company information for a title. The information describes the company that issues the invoices for this title. The attributes are defined as follows:

  • titleManageTitleCompanyInfo – the overall structure holding the details on company that performs the billing for the title 
    • titleCompanyName – defines the name of the billing company.
    • titleCompanyID – defines a unique identification of the billing company.
    • titleCompanyVATNumber – defines the VAT number for the billing company.
    • titleCompanyBusinessReg – defines the business registration number for the billing company.
    • titleCompanyBankAccount – defines the bank account number to which payments should be made for invoices issued by the billing company. 
    • titleCompanyIBAN - defines the IBAN account number to which payments should be made for invoices issued by the billing company.
    • titleCompanySWIFTAddress - defines the swift address to which payments should be made for invoices issued by the billing company.
    • titleCompanyLogoReference – defines the identification of the logo to be used for the current billing company. 
    • titleCompanyAddress – a structure holding the address of the billing company.
      • titleCompanyFullName – defines the full name of the billing company.
      • titleCompanyAddressLine1 – defines the first address line for the billing company.
      • titleCompanyAddressLine2 – defines the second address line for the billing company.
      • titleCompanyAddressLine3 – defines the third address line for the billing company.
      • titleCompanyCity – the city where the address is found.
      • titleCompanyPostalCode – the postal code / zip code of the current address.
      • titleCompanyCountryCode – contains the ISO country code associated with the current address.
      • titleCompanyLocality – contains the locality of the current address.
      • titleCompanyStateProvince – for addresses in the United States (US), Australia (AU) and Canada (CA) this field contains the code identifying the state or province.
      • titleCompanyCountryName – contains the name associated with the current country code of the billing company. 
    • titleCompanyContact
      • titlePrimaryPhoneNumber – defines the primary telephone of the billing company.
      • titlePrimaryEmailAddress – defines the primary email address of the billing company.
      • titlePrimaryFaxNumber – defines the primary fax number of the billing company.
      • titlePrimaryURL – defines the primary URL for the billing company.
      • titleSecondaryPhoneNumber – defines the secondary telephone of the billing company.
      • titleSecondaryEmailAddress – defines the secondary email address of the billing company.
      • titleSecondaryFaxNumber – defines the secondary fax number of the billing company.
      • titleSecondaryURL – defines the secondary URL for the billing company.
      • titleServicePhoneNumber – defines the service telephone of the billing company.
      • titleServiceEmailAddress – defines the service email address of the billing company.
      • titleServiceFaxNumber – defines the service fax number of the billing company.
      • titleServiceURL – defines the service URL for the billing company.

The titleManageTitlePaymentOptionListResponse contains a list (array) of all the payment terms defined for the current title. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleManageTitlePaymentOptionList – the array holding the list of payment options applied for the current title. 
    • titleManageTitlePaymentOptionInfo – a structure holding the overall updateable payment option information. 
      • titlePayOptionID – contains the identification of the payment option associated with the current title.
      • titlePayOptionVariant – contains the variant of the payment option associated with the current title.
      • titlePayTermID – contains the identification of the payment term to be used for the title when the payment option and payment option variant has been chosen. 
      • titlePayTermDefault – contains a code indicating whether the term is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default.
        • "NO" indicates that it is not the default. 
    • titleManageTitlePaymentOptionAddInfo – a structure holding additional information for the payment options. 
      • titlePayOptionName – define the name of the payment option configured.
      • titlePayOptionDesc – defines the brief description of the payment option configured.
      • titlePayTermName – define the name of the payment term configured.
      • titlePayTermDesc – defines the brief description of the payment term configured.
      • titlePayTermNameTranslations – contains the translations related to the payment term name.
        • solmRefTransNo – contains the identification of the translation. 
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID
      • titlePayTermDescTranslations – contains the translations related to the payment term description.
        • solmRefTransNo – contains the identification of the translation .
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID

The titleManageTitleDunningOptionListResponse contains a list (array) of all the dunning processes defined for the current title per payment option. The information is stored for each payment option defined in the system. The attributes are defined as follows:

  • titleManageTitleDunningOptionList – the array holding the list of dunning options applied for the current title. 
    • titleManageTitleDunningOptionInfo – a structure holding the overall updateable dunning option information. 
      • titlePayOptionID – contains the identification of the dunning option associated with the current title.
      • titlePayOptionVariant – contains the variant of the dunning option associated with the current title.
      • titleDunProcID – contains the identification of the dunning process to be used for the title when the payment option and payment option variant has been chosen. 
      • titleDunProcDefault – contains a code indicating whether the dunning process is the default. Only one combination of payment option and payment variant can be assigned as the default. 
        • "YES" indicates that this is the default.
        • "NO" indicates that it is not the default. 
    • titleManageTitleDunningOptionAddInfo – a structure holding additional information for the dunning options. 
      • titlePayOptionName – define the name of the payment option configured.
      • titlePayOptionDesc – defines the brief description of the payment option configured.
      • titleDunProcName – define the name of the dunning process configured.
      • titleDunProcDesc – defines the brief description of the dunning process configured.
      • titleDunProcNameTranslations – contains the translations related to the dunning process name.
        • solmRefTransNo – contains the identification of the translation.
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID
      • titleDunProcDescTranslations – contains the translations related to the dunning process description .
        • solmRefTransNo – contains the identification of the translation .
        • solmTranslationEntry – an array containing an element for each locale. 
          • solmLocaleID – contains the ID of the locale in which the translation is returned.
          • solmRefTransText– contains the translated value in the locale described by solmLocaleID. 
             

Retrieve Title Publishing Days (JSON API)

Endpoint

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

TitleRetrieveTitlePublDaysRequest

The TitleRetrieveTitlePublDaysRequest is a JSON formatted request structure used by the caller to request the list of publishing days maintained for a given title. If the publishing days has changed over time, one entry is returned for each row found. 

Sample 1
A sample request to retrieve publishing days for a single title.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleRetrieveTitlePublDaysInfoDetails": {
        "titleCode": "RB"
    }
}

The individual data elements of msgAuthDetails are defined with another request. The individual data elements of titleRetrieveTitlePublDaysInfoDetails are defined as follows:

  • titleRetrieveTitlePublDaysInfoDetails - contains details on the criteria to be used
    • titleCode – a value representing the title code for which publishing days are returned. 

TitleRetrieveTitlePublDaysResponse

The TitleRetrieveTitlePublDaysResponse is a JSON formatted response structure used to return the list of publishing days maintained for a given title. If the publishing days has changed over time, one entry is returned for each effective date found. 

Sample 1
A sample response listing the publishing days for a given title.
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleRetrieveTitlePublDaysList": [
        {
            "titleRetrieveTitlePublDaysTitleInfo": {
                "titleCode": "RB",
                "titleName": "Oslo Blad",
                "titleDesc": "Lokalavisa Oslo Blad"
            },
            "titleRetrieveTitlePublDaysPublList": {
                "titleRetrieveTitlePublDaysInfo": [
                    {
                        "titlePublDaysEffective": "2018-01-01",
                        "titlePublDays": "NNNNNWX"
                    },
                    {
                        "titlePublDaysEffective": "2019-01-01",
                        "titlePublDays": "NNNNXWX"
                    }
                ]
            }
        }
    ]
}
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 titleRetrieveTitlePublDaysResponse contains details related to the publishing days for a given title. Information for a single title is returned. The structures are described below:

  • titleRetrieveTitlePublDaysTitleInfo - contains details on the title itself. No translations are returned. 
    • titleCode – a value representing the title code for which publishing days are returned. 
    • titleName – a string value that contains the name associated with the title code. 
    • titleDesc – a string that contains a brief description of the title code. 
  • titleRetrieveTitlePublDaysPublList – contains detailed information on the publishing days for a given title. 
    • titleRetrieveTitlePublDaysInfo – an array that contains the publishing days for a given title specified by effective date. Multiple rows will exist if the publishing calendar of the title has changed or is scheduled to change.
      • titlePublDaysEffective – contains the date from which the specified publishing days come into effect. Must be formatted as YYYY-MM-DD and cannot be null. 
      • titlePublDays – represents the days the given title is published. Each character represents a day of the week, with character 1 representing Monday, character 2 representing Tuesday, character 3 representing Wednesday, and so on. Different codes are used to represent weekdays and weekends, for example “NNNNNWW” indicates that the title is published every day of the week, with Monday to Friday considered weekday editions and Saturday and Sunday considered weekend editions. “X” indicates that nothing is published for this title on the given day; “N” indicates that the title is published as a weekday edition on the given day and “W” indicates that the title is published as a weekend edition on the given day. 
         

Manage Title Publishing Days (JSON API)

Endpoint

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

TitleManageTitlePublDaysRequest

The TitleManageTitlePublDaysRequest is a JSON formatted request structure used by the caller to request the addition, update or removal of a publishing date specification. Multiple updates can be done in a single request. 

Sample 1
A sample request to add two new publishing day sets for a given title.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleManageTitlePublDaysTitleInfo": {
        "titleCode": "RB"
    },
    "titleManageTitlePublDaysDetails": [
        {
            "titleManageTitlePublDaysActionInfo": {
                "titleManageTitlePublDaysAction": "ADD"
            },
            "titleManageTitlePublDaysInfo": {
                "titlePublDaysEffective": "2018-07-01",
                "titlePublDays": "NNNNNWX"
            }
        },
        {
            "titleManageTitlePublDaysActionInfo": {
                "titleManageTitlePublDaysAction": "ADD"
            },
            "titleManageTitlePublDaysInfo": {
                "titlePublDaysEffective": "2019-01-01",
                "titlePublDays": "NNNNXWX"
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The individual data elements of titleManageTitlePublDaysTitleInfo are defined as follows:

  • titleManageTitlePublDaysTitleInfo - contains details on the criteria to be used.
    • titleCode – a value representing the title code for which publishing days are returned.

The titleManageTitlePublDaysDetails contains details related to the publishing days for a given title and the updates to perform. All changes are related to a single title. The structures are described below:

  • titleManageTitlePublDaysActionInfo - contains details what action to perform for a given row. 
    • titleManageTitleOwnersAction – contains the action to perform. “ADD” adds a new title owner; “MODIFY” modifies an existing title owner while “REMOVE” removes an existing title owner. 
  • titleManageTitlePublDaysInfo – the overall publishing day information.
    • titlePublDaysEffective – contains the date from which the specified publishing days come into effect. Must be formatted as YYYY-MM-DD and cannot be null. 
    • titlePublDays – represents the days the given title is published. Each character represents a day of the week, with character 1 representing Monday, character 2 representing Tuesday, character 3 representing Wednesday, and so on. Different codes are used to represent weekdays and weekends, for example “NNNNNWW” indicates that the title is published every day of the week, with Monday to Friday considered weekday editions and Saturday and Sunday considered weekend editions. “X” indicates that nothing is published for this title on the given day; “N” indicates that the title is published as a weekday edition on the given day and “W” indicates that the title is published as a weekend edition on the given day. 

TitleManageTitlePublDaysResponse

The titleManageTitlePublDaysResponse is a JSON formatted response structure returned in response to the titleManageTitlePublDaysRequest. 

Sample 1
A sample response returned when two new publishing day sets has been added. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageTitlePublDaysTitleInfo": {
        "titleCode": "RB"
    },
    "titleManageTitlePublDaysDetailsResponse": [
        {
            "titleManageTitlePublDaysActionInfoResponse": {
                "titleManageTitlePublDaysAction": "ADD",
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageTitlePublDaysInfo": {
                "titlePublDaysEffective": "2018-07-01",
                "titlePublDays": "NNNNNWX"
            }
        },
        {
            "titleManageTitlePublDaysActionInfoResponse": {
                "titleManageTitlePublDaysAction": "ADD",
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageTitlePublDaysInfo": {
                "titlePublDaysEffective": "2019-01-01",
                "titlePublDays": "NNNNXWX"
            }
        }
    ]
}

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 titleManageTitlePublDaysTitleInfo are defined as follows:

  • titleManageTitlePublDaysTitleInfo - contains details on the criteria to be used.
    • titleCode – a value representing the title code for which publishing days are returned. 

The titleManageTitlePublDaysDetailsResponse structure contains the different actions to perform on the listed dates. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleManageTitlePublDaysActionInfoResponse – the action control structure.
    • titleManageCalendarAction – contains the action to perform. “ADD” adds a new publishing date; “MODIFY” modifies an existing publishing date while “REMOVE” removes an existing publishing date. 
    • 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. 
  • titleManageTitlePublDaysInfo – the overall title owner information.
    • titlePublDaysEffective – contains the date from which the specified publishing days come into effect. Must be formatted as YYYY-MM-DD and cannot be null. 
    • titlePublDays – represents the days the given title is published. Each character represents a day of the week, with character 1 representing Monday, character 2 representing Tuesday, character 3 representing Wednesday, and so on. Different codes are used to represent weekdays and weekends, for example “NNNNNWW” indicates that the title is published every day of the week, with Monday to Friday considered weekday editions and Saturday and Sunday considered weekend editions. “X” indicates that nothing is published for this title on the given day; “N” indicates that the title is published as a weekday edition on the given day and “W” indicates that the title is published as a weekend edition on the given day. 

 

Retrieve Title Owners (JSON API)

Endpoint

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

TitleRetrieveTitleOwnersRequest

The TitleRetrieveTitleOwnersRequest is a JSON formatted request structure used by the caller to retrieve all title owners defined in the system. The request will always return all owners. 

Sample 1
A sample request to retrieve all title owners.
{
"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 with another request. No other attributes are used in the request. 

TitleRetrieveTitleOwnersResponse

The TitleRetrieveTitleOwnersResponse is a JSON formatted response structure used to return the list of title owners maintained in the system. One row is returned for each owner. 

Sample 1
A sample response listing the publishing days for a given title.
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleRetrieveTitleOwnersInfo": [
        {
            "titleOwnerID": "RB",
            "titleOwnerName": "Oslo Blad",
            "titleOwnerDesc": "Lokalavisa Oslo Blad"
        },
        {
            "titleOwnerID": "XX",
            "titleOwnerName": "Bergen Blad",
            "titleOwnerDesc": "Lokalavisa Bergen Blad"
        }
    ]
}

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 titleRetrieveTitleOwnersResponse contains details related to the title owners returned. The structure returned is described below:

  • titleRetrieveTitleOwnersInfo – contains an entry for each title owner returned. 
    • titleOwnerID – a value representing the ID of the title owner returned.
    • titleOwnerName – a string value that contains the name associated with the title owner. 
    • titleOwnerDesc – a string that contains a brief description of the title owner. 
       

Manage Title Owners (JSON API)

Endpoint

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

TitleManageTitleOwnersRequest

The TitleManageTitleOwnersRequest is a JSON formatted request structure used by the caller to request the addition, update or removal of one or more title owners. Multiple updates can be done in a single request. 

Sample 1
A sample request to add one title owner and removing another.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleManageTitleOwnersList": [
        {
            "titleManageTitleOwnersActionInfo": {
                "titleManageTitleOwnersAction": "ADD"
            },
            "titleManageTitleOwnersInfo": {
                "titleOwnerID": "RB",
                "titleOwnerName": "Oslo Blad",
                "titleOwnerDesc": "Lokalavisa Oslo Blad"
            }
        },
        {
            "titleManageTitleOwnersActionInfo": {
                "titleManageTitleOwnersAction": "REMOVE"
            },
            "titleManageTitleOwnersInfo": {
                "titleOwnerID": "XX",
                "titleOwnerName": "Bergen Blad",
                "titleOwnerDesc": "Lokalavisa Bergen Blad"
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The titleManageTitleOwnersList structure contains the different actions to perform on the title owners. 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:

  • titleManageTitleOwnersActionInfo – the action control structure.
    • titleManageTitleOwnersAction – contains the action to perform. “ADD” adds a new title owner; “MODIFY” modifies an existing title owner while “REMOVE” removes an existing title owner. 
  • titleManageTitleOwnersInfo – the overall title owner information.
    • titleOwnerID – a value representing the ID of the title owner.
    • titleOwnerName – a string value that contains the name associated with the title owner. 
    • titleOwnerDesc – a string that contains a brief description of the title owner. 

TitleManageTitleOwnersResponse

The titleManageTitleOwnersResponse is a JSON formatted response structure returned in response to the titleManageTitleOwnersRequest

Sample 1
A sample response returned when a new title owner has been added while another has been removed. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageTitleOwnersListResponse": [
        {
            "titleManageTitleOwnersActionInfoResponse": {
                "titleManageTitleOwnersAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageTitleOwnersInfo": {
                "titleOwnerID": "RB",
                "titleOwnerName": "Oslo Blad",
                "titleOwnerDesc": "Lokalavisa Oslo Blad"
            }
        },
        {
            "titleManageTitleOwnersActionInfoResponse": {
                "titleManageTitleOwnersAction": "REMOVE"
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageTitleOwnersInfo": {
                "titleOwnerID": "XX",
                "titleOwnerName": "Bergen Blad",
                "titleOwnerDesc": "Lokalavisa Bergen Blad"
            }
        }
    ]
}

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 titleManageTitleOwnersListResponse structure contains the different actions to perform on the listed dates. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleManageTitleOwnersActionInfoResponse – the action control structure.
    • titleManageCalendarAction – contains the action to perform. “ADD” adds a new publishing date; “MODIFY” modifies an existing publishing date while “REMOVE” removes an existing publishing date. 
    • 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. 
  • titleManageTitleOwnersInfo – the overall title owner information.
    • titleOwnerID – a value representing the ID of the title owner.
    • titleOwnerName – a string value that contains the name associated with the title owner. 
    • titleOwnerDesc – a string that contains a brief description of the title owner. 
       

Retrieve Dunning (JSON API)

Endpoint

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

TitleRetrieveDunningRequest

The TitleRetrieveDunningRequest is a JSON formatted request structure used by the caller to request the retrieval of all dunning processes. 

Sample 1
A sample request to retrieve all dunning processes.
{
    "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 with another request. 

TitleRetrieveDunningResponse

The titleRetrieveDunningResponse is a JSON formatted response structure returned in response to the titleRetrieveDunningRequest. 

Sample 1
A sample response returning a dunning processes. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleRetrieveDunningInfo": [
        {
            "titleDunProcID": "DP1",
            "titleDunProcName": "DUNNING1",
            "titleDunProcNameTranslations": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                ]
            },
            "titleDunProcDesc": "Dunning Process #1",
            "titleDunProcDescRefTransNo": 112234,
            "titleDunProcDescTranslations": {
                "solmRefTransNo": 1232,
                "solmTranslationEntry": [
                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                ]
            },
            "titleRetrieveDunningStepList": [
                {
                    "titleDunStepNo": 1,
                    "titleDunStepDuration": 5,
                    "titleDunStepEliminateFee": "NONE",
                    "titleDunStepFinalInvoiceAction": "NONE",
                    "titleDunStepOrigInvoiceAction": "NONE"
                },
                {
                    "titleDunStepNo": 2,
                    "titleDunStepDuration": 5,
                    "titleDunStepEliminateFee": "PREVIOUS",
                    "titleDunStepFinalInvoiceAction": "FINAL-INVOICE",
                    "titleDunStepOrigInvoiceAction": "VOID-INVOICE"
                }
            ]
        }
    ]
}

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 titleRetrieveDunningInfo structure contains the different actions to perform on the listed dates. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleRetrieveDunningInfo – the overall dunning process information.
    • titleDunProcID – contains the client defined ID for the dunning process. Must match the ID created in Aria Core. 
    • titleDunProcName – a string value that contains the name associated with the dunning process. 
    • titleDunProcNameTranslations – contains the translations related to the dunning process name.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleDunProcDesc – a string that contains a brief description of the dunning process. 
    • titleDunProcDescTranslations – contains the translations related to the dunning process description.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleRetrieveDunningStepList – an array containing the individual steps of the dunning process. 
      • titleDunStepNo – contain a sequence number for the dunning step. Always start at 1 and is incremented by one for each step. 
      • titleDunStepDuration – contain the number of days before the next dunning step is executed. 
      • titleDunStepEliminateFee – contains a code indicating if and how dunning fees are to be eliminated for the current step. The following codes are supported:
        • "NONE" – no fees are eliminated.
        • "PREVIOUS" – the fee for the previous dunning step is eliminated when process the current step. If this is the first step, this value is ignored. 
      • titleDunStepFinalInvoiceAction – contains a code indicating how the final step invoice are processed. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "FINAL-INVOICE" – a final invoice is produced for this step.  
      • titleDunStepOrigInvoiceAction – contains a code indicating how the original invoice are processed when reaching the final step. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "VOID-INVOICE" – a original invoice is voided.  
           

Manage Dunning (JSON API)

Endpoint

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

TitleManageDunningRequest

The TitleManageDunningRequest is a JSON formatted request structure used by the caller to request the addition, update or removal of one or more dunning processes. Multiple updates can be done in a single request. 

Sample 1
A sample request to add one dunning process.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "titleManageDunningList": [
        {
            "titleManageDunningActionInfo": {
                "titleManageDunningAction": "ADD"
            },
            "titleManageDunningInfo": {
                "titleDunProcID": "DP1",
                "titleDunProcName": "DUNNING1",
                "titleDunProcNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                    ]
                },
                "titleDunProcDesc": "Dunning Process #1",
                "titleDunProcDescRefTransNo": 112234,
                "titleDunProcDescTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                    ]
                },
                "titleManageDunningStepList": [
                    {
                        "titleDunStepNo": 1,
                        "titleDunStepDuration": 5,
                        "titleDunStepEliminateFee": "NONE",
                        "titleDunStepFinalInvoiceAction": "NONE",
                        "titleDunStepOrigInvoiceAction": "NONE"
                    },
                    {
                        "titleDunStepNo": 2,
                        "titleDunStepDuration": 5, 
                        "titleDunStepEliminateFee": "PREVIOUS",
                        "titleDunStepFinalInvoiceAction": "FINAL-INVOICE",
                        "titleDunStepOrigInvoiceAction": "VOID-INVOICE"
                    }
                ]
            }
        }
    ]
}

The individual data elements of msgAuthDetails are defined with another request. The titleManageDunningList structure contains the different actions to perform on the dunning processes. 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:

  • titleManageDunningActionInfo – the action control structure.
    • titleManageDunningAction – contains the action to perform. “ADD” adds a new dunning process; “MODIFY” modifies an existing dunning process while “REMOVE” removes an existing dunning process. 

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 titleManageDunningInfo structure contains the different actions to perform on the listed dunning processes. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleManageDunningInfo – the overall dunning process information.
    • titleDunProcID – contains the client defined ID for the dunning process. Must match the ID created in Aria Core. 
    • titleDunProcName – a string value that contains the name associated with the dunning process. 
    • titleDunProcNameTranslations – contains the translations related to the dunning process name.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleDunProcDesc – a string that contains a brief description of the dunning process. 
    • titleDunProcDescTranslations – contains the translations related to the dunning process description.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleManageDunningStepList – an array containing the individual steps of the dunning process. 
      • titleDunStepNo – contain a sequence number for the dunning step. Always start at 1 and is incremented by one for each step. 
      • titleDunStepDuration – contain the number of days before the next dunning step is executed. 
      • titleDunStepEliminateFee – contains a code indicating if and how dunning fees are to be eliminated for the current step. The following codes are supported:
        • "NONE" – no fees are eliminated.
        • "PREVIOUS" – the fee for the previous dunning step is eliminated when process the current step. If this is the first step, this value is ignored. 
      • titleDunStepFinalInvoiceAction – contains a code indicating how the final step invoice are processed. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "FINAL-INVOICE" – a final invoice is produced for this step.  
      • titleDunStepOrigInvoiceAction – contains a code indicating how the original invoice are processed when reaching the final step. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "VOID-INVOICE" – a original invoice is voided.  

TitleManageDunningResponse

The titleManageDunningResponse is a JSON formatted response structure returned in response to the titleManageDunningRequest

Sample 1
A sample response returned when a new dunning process has been added. 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "titleManageDunningListResponse": [
        {
            "titleManageDunningActionInfoResponse": {
                "titleManageDunningAction": "ADD"
                "resultCode": 0,
                "resultText": "OK"
            },
            "titleManageDunningInfo": {
                "titleDunProcID": "DP1",
                "titleDunProcName": "DUNNING1",
                "titleDunProcNameTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                    ]
                },
                "titleDunProcDesc": "Dunning Process #1",
                "titleDunProcDescRefTransNo": 112234,
                "titleDunProcDescTranslations": {
                    "solmRefTransNo": 1232,
                    "solmTranslationEntry": [
                        {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Dunning Process #1"},
                        {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Dunning Process #1"}
                    ]
                },
                "titleRetrieveDunningStepList": [
                    {
                        "titleDunStepNo": 1,
                        "titleDunStepDuration": 5,
                        "titleDunStepEliminateFee": "NONE",
                        "titleDunStepFinalInvoiceAction": "NONE",
                        "titleDunStepOrigInvoiceAction": "NONE"
                    },
                    {
                        "titleDunStepNo": 2,
                        "titleDunStepDuration": 5,
                        "titleDunStepEliminateFee": "PREVIOUS",
                        "titleDunStepFinalInvoiceAction": "FINAL-INVOICE",
                        "titleDunStepOrigInvoiceAction": "VOID-INVOICE"
                    }
                ]
            }
        }
    ]
}

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 titleManageDunningListResponse structure contains the different actions to perform on the listed dunning processes. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleManageDunningActionInfoResponse – the action control structure.
    • titleManageDunningAction – contains the action to perform. “ADD” adds a new dunning process; “MODIFY” modifies an existing dunning process while “REMOVE” removes an existing dunning process. 
    • 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.

The titleManageDunningInfo structure contains the different actions to perform on the listed dunning processes. The structure contains an array entry for each update to perform. Each entry contains the attributes described below:

  • titleManageDunningInfo – the overall dunning process information.
    • titleDunProcID – contains the client defined ID for the dunning process. Must match the ID created in Aria Core. 
    • titleDunProcName – a string value that contains the name associated with the dunning process. 
    • titleDunProcNameTranslations – contains the translations related to the dunning process name.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleDunProcDesc – a string that contains a brief description of the dunning process. 
    • titleDunProcDescTranslations – contains the translations related to the dunning process description.
      • solmRefTransNo – contains the identification of the translation.
      • solmTranslationEntry – an array containing an element for each locale. 
        • solmLocaleID – contains the ID of the locale in which the translation is returned.
        • solmRefTransText– contains the translated value in the locale described by solmLocaleID
    • titleManageDunningStepList – an array containing the individual steps of the dunning process. 
      • titleDunStepNo – contain a sequence number for the dunning step. Always start at 1 and is incremented by one for each step. 
      • titleDunStepDuration – contain the number of days before the next dunning step is executed. 
      • titleDunStepEliminateFee – contains a code indicating if and how dunning fees are to be eliminated for the current step. The following codes are supported:
        • "NONE" – no fees are eliminated.
        • "PREVIOUS" – the fee for the previous dunning step is eliminated when process the current step. If this is the first step, this value is ignored. 
      • titleDunStepFinalInvoiceAction – contains a code indicating how the final step invoice are processed. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "FINAL-INVOICE" – a final invoice is produced for this step.  
      • titleDunStepOrigInvoiceAction – contains a code indicating how the original invoice are processed when reaching the final step. The following codes are supported:
        • "NONE" – no final invoice is produced for this step.
        • "VOID-INVOICE" – a original invoice is voided.  
           

Title Manage Pay Options (JSON API)

Endpoint

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

TitleManagePayOptionsRequest

The TitleManagePayOptionsRequest message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

Sample 1) Removing an already existing pay option.

Sample 1
A sample request used to add a pay option.
{
   "msgAuthDetails": {
  "clientNo": 99,
  "authKey": "",
  "requestDateTime": "2019-01-01",
  "signatureValue": "",
  "ariaAccountID": "",
  "ariaAccountNo": 0,
  "signatureVersion": "0"
 },
"titleManagePayOptionsList": [
    {
      "titleManagePayOptionsActionInfo": {
        "titleManagePayOptionsAction": "ADD"
      },
      "titleManagePayOptionsInfo": {
        "titlePayOptionID": "CREDITCARD",
        "titlePayOptionVariant": "W-NOTIFY",
        "titlePayOptionName": "ABCDEFGHIJKLMNOPQRSTUVWXY",
        "titlePayOptionNameTranslations": {
          "solmRefTransNo": 62,
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMN",
              "solmRefTransText": "ABCDEFG"
            }
          ]
        },
        "titlePayOptionDesc": "ABCDEFGHIJKLMNOPQRSTU",
        "titlePayOptionDescTranslations": {
          "solmRefTransNo": 710,
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMNOPQRSTUVWX",
              "solmRefTransText": "ABCDEFGHIJ"
            }
          ]
        },
        "titlePayOptionVariantName": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "titlePayOptionVariantNameTranslations": {
          "solmRefTransNo": 959,
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQRSTUVWXY"
            }
          ]
        },
        "titlePayOptionVariantDesc": "ABCDEFG",
        "titlePayOptionVariantDescTranslations": {
          "solmRefTransNo": 274,
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFG",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQRSTUVWXYZAB"
            }
          ]
        },
        "titlePayOptionNew": "CSR",
        "titlePayOptionNewDflt": false,
        "titlePayOptionUpdate": "WEB",
        "titlePayOptionUpdateDflt": true,
        "titlePayOptionBillTiming": "CUTOFF",
        "titlePayOptionBillTimingCutoff": 474,
        "titlePayOptionGatewayType": "INTERNAL",
        "titlePayOptionGatewayID": "ABCDEFGHIJKLMNOPQRSTUVWX",
        "titlePayOptionGatewayColl": "ALL",
        "titlePayOptionDocInitialGen": "NONE",
        "titlePayOptionDocPartnerGen": "NONE",
        "titlePayOptionDocFormatID": "ABCDEFGHIJKLMNOPQRSTUVWXYZA",
        "titlePayOptionDocFormatVersion": "ABCDEFGHI",
        "titlePayOptionDocDestID": "ABCDEFGHIJ",
        "titlePayOptionDocDestType": "REST",
        "titlePayOptionDocDestLocation": "ABCDEFGHIJKLMNOPQRSTU",
        "titlePayOptionCaptureType": "CC-OFFLINE",
        "titlePayOptionCustInvRefGen": "NEW",
        "PaymentOptionSelectionRule": "AVT-WITH",
        "titlePayOptionDocDist": "EMAIL-PDF",
        "titlePayOptionUnderPayThresh": 637.0,
        "titlePayOptionUnderPayActionInside": "WRITEOFF",
        "titlePayOptionOverPayThresh": 171.75,
        "titlePayOptionManualRefund": "ORIGINAL",
        "titlePayOptionOverPayActionInside": "NONE",
        "titlePayOptionOverPayActionOutside": "REFUND",
        "titlePayOptionReactivateTime": 640
      }
    }
  ]

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. 
  • requestDateTime - contains the date and time when the message was built. 
  • 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 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. 
  • userID – contains the user id associated with the account. 
  • signatureVersion – contains the version number to validate the signatureValue. Version is provided to client along with clientNo & authKey.
  • titleManagePayOptionsList – defines an array of actions to perform for the Manage Payment Options service. May contain 1 or more entries. Is based on titleManagePayOptionsList structure described later in this section.


The individual data elements of the titleManagePayOptionsList structure are defined as follows:

  • titleManagePayOptionsList – the overall structure for the definition.
    • titleManagePayOptionsActionInfo – defines a structure that hold details on what action the service should perform on the payment options. The data structure is built using the titleManagePayOptionsActionInfo structure defined later in this section. 
    • titleManagePayOptionsInfo – defines a structure that hold details on the actual content of the payment options. The data structure is built using the titleManagePayOptionsInfo structure defined later in this section.


The individual data elements of the titleManagePayOptionsActionInfo structure are defined as follows:

  • titleManagePayOptionsActionInfo – the action control structure describing what action to take. 
    • titleManagePayOptionsAction – contains the action to perform. “ADD” adds a new payment option; “MODIFY” modifies an existing payment option while “REMOVE” removes an existing payment option.

 
The individual data elements of the titleManagePayOptionsInfo structure are defined as follows:

  • titleManagePayOptionsInfo – a structure holding the general information on the payment option to be managed. 
    • titlePayOptionID – contains the identification of the payment option for which information is returned.
    • titlePayOptionVariant – contains the identification of the payment variant for which information is returned. 
    • titlePayOptionName – contains the name of the payment option for which information is returned.
    • titlePayOptionNameTranslations – contains the translations related to the payment option name. 
      • solmRefTransNo – contains the identification of the translation for this payment option name. 
      • solmTranslationEntry – an array containing an element for each locale the payment option name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option name is returned.
        • solmRefTransText– contains the name of the payment option name in the locale (language) described by solmLocaleID. 
    • titlePayOptionDesc – contains the description of the payment option for which information is returned.
    • titlePayOptionDescTranslations – contains the translations related to the payment option description. 
      • solmRefTransNo – contains the identification of the translation for this payment option description. 
      • solmTranslationEntry – an array containing an element for each locale the payment option description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option description is returned.
        • solmRefTransText– contains the name of the payment option description in the locale (language) described by solmLocaleID
    • titlePayOptionVariantName – contains the name of the payment option variant for which information is returned.
    • titlePayOptionVariantNameTranslations – contains the translations related to the payment option variant name.
      • solmRefTransNo – contains the identification of the translation for this payment option variant name. 
      • solmTranslationEntry – an array containing an element for each locale the payment option variant name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option variant name is returned
        • solmRefTransText– contains the name of the payment option variant name in the locale (language) described by solmLocaleID. 
    • titlePayOptionVariantDesc – contains the description of the payment option variant for which information is returned.
    • titlePayOptionVariantDescTranslations – contains the translations related to the payment option variant description. 
      • solmRefTransNo – contains the identification of the translation for this payment option variant description. 
      • solmTranslationEntry – an array containing an element for each locale the payment option variant description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option variant description is returned
        • solmRefTransText– contains the name of the payment option variant description in the locale (language) described by solmLocaleID
    • titlePayOptionNew – contains a code indicating whether the payment option can be used to create new accounts and/or billing groups. The following options apply:
      • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. 
      • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only. 
      • "ANY" – the payment option can be used to create new accounts and/or billing groups from either WEB or CSR platforms. 
    • titlePayOptionNewDflt – contains a code that describes whether the payment variant is the default when creating new entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
      • "TRUE" – the payment variant is the default for this payment option.
      • "FALSE" – the payment variant is NOT the default for this payment option. 
    • titlePayOptionUpdate – contains a code indicating whether the payment option can be used to update existing billing groups. The following options apply:
      • "WEB" – the payment option can be used to update billing groups from the WEB only. 
      • "CSR" – the payment option can be used to update billing groups from the CSR platform only. 
      • "ANY" – the payment option can be used to update billing groups from either WEB or CSR platforms. 
    • titlePayOptionUpdateDflt – contains a code describes whether the payment variant is the default when updating existing entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
      • "TRUE" – the payment variant is the default for this payment option when performing updates.
      • "FALSE" – the payment variant is NOT the default for this payment option.
    • titlePayOptionBillTiming – contains a code indicating how bill timing is controlled. The following options exist:
      • "ARIA" – the standard ARIA functionality for controlling the bill timing is used, i.e. the bill lag days defined in payment terms, billing groups, etc. 
      • "CUTOFF" – the bill timing is calculated based on a cutoff time. AMPS will calculate the appropriate bill lag days to ensure that bills are produced and collected prior to the cutover time in each month. 
    • titlePayOptionBillTimingCutoff – contains the day of the month when the cutoff day is set. Is used only if TitlePayOptionBillTiming contains "CUTOFF". 
    • titlePayOptionGatewayType – contains a code indicating if and how AMPS integrate with the payment gateway. Is used only for payment option types indicating "CC01". The following codes apply: 
      • "NONE" – no payment gateway is in use. 
      • "INTERNAL" – the payment gateway is managed directly by ARIA
      • "EXTERNAL" – the payment gateway is managed outside ARIA, for example in Workflow. 
    • titlePayOptionGatewayID – contains the identification of the payment gateway used for this payment option. Used only if the payment option indicates "CREDITCARD" and if the gateway type equals "EXTERNAL" in which case the gateway ID must exist the "Payment Option Gateway" table. Contains "Null" if not used. 
    • titlePayOptionGatewayColl – contains a code that defines how and for what invoices AMPS will be attempting collection funds. Is used only for Gateway Type is "EXTERNAL". The following codes apply: 
      • "ALL" – All invoices will trigger a collection attempt. 
      • "NOT-FIRST" – All invoices, except the first invoice, will trigger a collection attempt.
    • titlePayOptionDocInitialGen – contains a code indicating if, and how, the initial invoice document is generated and sent to the end-customer. The following codes apply:
      • "NONE" – no special treatment is done for the initial invoice.
      • "FIRST-DIRECT" – the first invoice produced by ARIA will be sent directly to the end-customer via email from ARIA. Subsequent invoices will be sent via partners only. 
      • "ALL-DIRECT" – all invoices and financial documents are sent directly to the end-customer via email. Copies may also be sent to the partner, ref. the "Payment Option Document Partner Generation" field. 
    • titlePayOptionDocPartnerGen – contains a code indicating if, and how, documents generated by AMPS are sent to the external document partner. Details on the option is also sent to the partner. The following codes apply:
      • "NONE" – no document generated by AMPS.
      • "SAVE-ONLY-ALL" – send to the partner as copy only.
      • "SAVE-AND-SEND-ALL" – send to the partner as a normal invoice, credit note, reminder, etc. 
    • titlePayOptionDocFormatID – contains the identification of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
    • titlePayOptionDocFormatVersion – contains the version of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
    • titlePayOptionDocDestID – a string column that contains the identification of the destination to which documents are sent in the chosen format. The ID selected must exist in the "Payment Option Document Destination" table. 
    • titlePayOptionDocDestType – contains a code identifying how the documents are delivered to this destination. This column cannot be updated via the API. The following codes apply:
      • "SFTP" – the documents are delivered via SFTP to a server and server folder designated by the partner. The documents are delivered in the format specified by the ID. 
      • "REST" – the documents are delivered via REST API calls to a destination URL designated by the partner. The documents are delivered in the format specified by the ID. 
    • titlePayOptionDocDestLocation – contains the folder path or REST URL where the documents are delivered by AMPS. Must contain a valid folder path or REST URL depending on the destination type defined above. This column cannot be updated via the API.
    • titlePayOptionCaptureType – contains a code indicating the method used by AMPS to capture details on the payment requests. The following codes currently apply:
      • "BANK" – payment transaction is captured by AMPS on receipt of payment confirmation from bank, for example as OCR or bank transfers. AMPS will use the generated customer invoice reference number to match the payment received to an invoice. 
      • "CC-ONLINE" – payment transaction is captured by AMPS when ARIA fires an event indicating the completion of the payment. Used only with ARIA managed payment gateways. 
      • "CC-OFFLINE " – payment transaction is captured by AMPS when AMPS receive confirmation (via batch or other interface) from the payment gateway that funds have successfully been transferred. Used only with AMPS managed payment gateways. Confirmation received later via batch or interface file. 
    • titlePayOptionCustInvRefGen – contains a code indicating how AMPS will generate the customer invoice reference number, also known as KID number or OCR number. The following options apply:
      • "NONE" – generate no new reference. Primarily used with credit card transactions.
      • The following options apply when chosen payment option is EFAKTURA (EF01)"NEW" – generate new customer invoice reference for each invoice and use this number of match the payment with the invoice. Generated based on the Statement Number suffixed with a check digit. 
      • "EAN" – use the customer invoice reference defined by EAN Requisition number (AVTALEGIRO and EFAKTURA) when the billing group or account was first created.
    • Payment Option Selection Rule [TitlePayOptionSelectionRule] - a new string column that defines how certain automatic selection rules apply to the payment method, for example when customer signs-up for AVTALEGIRO (DD01) and is already on EFAKTURA (EF01). The following options apply when chosen payment option is neither AVTALEGIRO (DD01) nor EFAKTURA (EF01):
      • "NONE" – is set to "NONE" for payment options other than AVTALEGIRO (DD01) or EFAKTURA (EF01). 

The following options apply when chosen payment option is EFAKTURA (EF01):

  • "STANDARD" – this is the automatic selection done when signing up for EFAKTURA electronically via the banks.
  • "AVT-WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO (DD01) with notification when already on EFAKTURA (EF01).
  • "AVT-WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO (DD01) without notification when already on EFAKTURA (EF01)

The following options apply when chosen payment option is AVTALEGIRO (DD01)

  • "WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO (DD01) with notification when on any other payment option than EFAKTURA (EF01). Can also be used to switch between with and without notification when on AVTALEGIRO (DD01) already.  
  • "WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO without notification when on any other payment option than EFAKTURA. Can also be used to switch between with and without notification when on AVTALEGIRO already. 

 

 

  • titlePayOptionDocDist – contains a code that defines how the invoice, credit note, and dunning notices are distributed to the end-customer by the third-party document management system. The parameter is used only if titlePayOptionDocGeneration contains a value other than "NONE". The following options apply:
    • "PARTNER" – the external partner is responsible for selecting the best distribution option for the document. 
    • "EMAIL-PDF" – the external partner will send the invoice, credit note, and dunning notices to the end-customer via email with an PDF attachment.
  • titlePayOptionUnderPayThresh – contains the value that defines the under-payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the under-payment threshold, the action described in "Under Payment Action Inside" is executed for the payment
  • titlePayOptionUnderPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value less "Under Payment Threshold". An example of this is where the invoice is for NOK 1025; the under-payment threshold is set at NOK 50; a payment of NOK 925 through NOK 1025 is within the under-payment threshold. A payment of less than NOK 925 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is within the threshold specified except that partial payment is applied on the invoice, which eventually will go into dunning. 
    • "WRITEOFF" – if the payment is within the value of the invoice and the "Under Payment Threshold", the missing payment is automatically written-off and the remaining payment is recognized in the ERP system. 
  • titlePayOptionOverPayThresh – contains the value that defines the over payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the over-payment threshold, the action described in "Over Payment Action Inside" is executed for the payment. If the payment received is greater than the invoice value plus the over-payment threshold, the action described in "Over Payment Action Outside" is executed for the payment.
  • titlePayOptionManualRefund – contains a code that defines whether manual refunds can be created for billing groups associated with this payment option, and if so, how it can be refunded. The following options exist:
    • "NONE" – manual refunds cannot be registered for subscriptions or payment agreements on the current billing group.  
    • "ORIGINAL" – manual refunds can be created by the CSR, but only specifying the original payment method with which the payment was made, for example if payment was by credit card, then refund must also be on the same credit card. 
    • "ANY" – manual refunds can be created by the CSR using any of the supported means of payment. 
  • titlePayOptionOverPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; a payment of NOK 1025 through NOK 1075 is within the over-payment threshold. A payment of more than NOK 1075 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is within the threshold specified except that full payment is applied on the invoice and any excess payment is placed on the account for future consumption. 
    • "REFUND" – if the payment is within the value of the invoice and the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
  • titlePayOptionOverPayActionOutside – contains a code that defines the action to take if the payment received is greater than the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; A payment of more than NOK 1075 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is greater than the invoice value plus the "Over-Payment Threshold"
    • "REFUND" – if the payment is greater than the value of the invoice plus the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
  • titlePayOptionReactivateTime – contains a value that indicates the number of days after suspending the subscription due to missing payment, that a payment will automatically reopen the subscription. 0 (Zero) indicates that it will not be reopened.

 

TitleManagePayOptionsResponse

The TitleManagePayOptionsResponse message is a JSON formatted response structure returned in response to the TitleManagePayOptionsRequest

  • Sample 1); Returns response on whether a new pay option has been added or not. 

Sample 1

A sample response returned when a new pay option is tried to be added. 
{
  "resultInfo": {
    "resultCode": 103,
    "resultText": "ABCDEFGHIJKLMNOPQR"
  },
  "titleManagePayTermsListResponse": [
    {
      "titleManagePayTermsInfoResponse": {
        "actionDirective": "ADD",
        "actionResultInfo": {
          "resultCode": 965,
          "resultText": "ABCDEFGHIJKLMNOPQRSTUVW"
        }
      },
      "titleManagePayTermsInfo": {
        "titlePayTermID": "ABCDEFGHIJKLMNOPQRSTUV",
        "titlePayTermName": "ABCDEFGHIJKLMNOPQRSTUVW",
        "titlePayTermNameTranslations": {
          "solmRefTransNo": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDE",
              "solmRefTransText": "ABCDEFGHIJKL"
            }
          ]
        },
        "titlePayTermDesc": "ABCDEFGHIJKLMNOPQ",
        "titlePayTermDescTranslationsc": true,
        "titlePayBillLagDays": -64,
        "titlePayDaysUntilDue": 184,
        "titlePayDaysUntilDueOption": 215,
        "titlePayTermDescTranslations": {
          "solmRefTransNo": "ABCDEFGHIJKLMNOPQRSTUVWX",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMNOPQRSTUVWXY",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQR"
            }
          ]
        }
      }
    }
  ]
}

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 titleManagePayOptionsListResponse – an array structure holding the general information on the payment options that have been processed by the JSON service.
 
The individual data elements of the titleManagePayOptionsListResponse structure are defined as follows:

  • titleManagePayOptionsListResponse – a structure holding the holding the details of the processing of each payment option found in the request. Consist of the following attributes:
    • titleManagePayOptionsInfoResponse – contains the structure defining the outcome of processing for each payment term entry. Is built using the titleManagePayOptionsInfoResponse structure. 
    • titleManagePayOptionsInfo – contains the structure defining the details on the payment option returned after the operation is complete. Is built using the titleManagePayOptionsInfo structure found later in this section.

 
The individual data elements of the titleManagePayOptionsInfoResponse structure are defined as follows:

  • titleManagePayOptionsInfoResponse – a structure holding the holding the details of the processing of each payment term found in the request. Consist of the following attributes:
    • actionDirective – contains the action that has been performed. “ADD” adds a new payment option; “MODIFY” modifies an existing payment option while “REMOVE” removes an existing payment option. 
    • actionResultInfo – contains the outcome of the processing for the given entry in the API call. Is built using the standard resultInfo structure.

 
The individual data elements of the titleManagePayOptionsInfo structure are defined as follows:

  • titleManagePayOptionsInfo – a structure holding the general information on the payment option to be managed. 
    • titlePayOptionID – contains the identification of the payment option for which information is returned
    • titlePayOptionVariant – contains the identification of the payment variant for which information is returned. 
    • titlePayOptionName – contains the name of the payment option for which information is returned.
    • titlePayOptionNameTranslations – contains the translations related to the payment option name.
      • solmRefTransNo – contains the identification of the translation for this payment option name. 
      • solmTranslationEntry – an array containing an element for each locale the payment option name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option name is returned.
        • solmRefTransText– contains the name of the payment option name in the locale (language) described by solmLocaleID
    • titlePayOptionDesc – contains the description of the payment option for which information is returned.
    • titlePayOptionDescTranslations – contains the translations related to the payment option description. 
      • solmRefTransNo – contains the identification of the translation for this payment option description. 
      • solmTranslationEntry – an array containing an element for each locale the payment option description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option description is returned.
        • solmRefTransText– contains the name of the payment option description in the locale (language) described by solmLocaleID
    • titlePayOptionVariantName – contains the name of the payment option variant for which information is returned.
    • titlePayOptionVariantNameTranslations – contains the translations related to the payment option variant name. 
      • solmRefTransNo – contains the identification of the translation for this payment option variant name. 
      • solmTranslationEntry – an array containing an element for each locale the payment option variant name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option variant name is returned.
        • solmRefTransText– contains the name of the payment option variant name in the locale (language) described by solmLocaleID
    • titlePayOptionVariantDesc – contains the description of the payment option variant for which information is returned.
    • titlePayOptionVariantDescTranslations – contains the translations related to the payment option variant description.
      • solmRefTransNo – contains the identification of the translation for this payment option variant description. 
      • solmTranslationEntry – an array containing an element for each locale the payment option variant description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment option variant description is returned.
        • solmRefTransText– contains the name of the payment option variant description in the locale (language) described by solmLocaleID
    • titlePayOptionNew – contains a code indicating whether the payment option can be used to create new accounts and/or billing groups. The following options apply:
      • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. 
      • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only. 
      • "ANY" – the payment option can be used to create new accounts and/or billing groups from either WEB or CSR platforms. 
    • titlePayOptionNewDflt – contains a code that describes whether the payment variant is the default when creating new entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
      • "TRUE" – the payment variant is the default for this payment option.
      • "FALSE" – the payment variant is NOT the default for this payment option. 
    • titlePayOptionUpdate – contains a code indicating whether the payment option can be used to update existing billing groups. The following options apply:
      • "WEB" – the payment option can be used to update billing groups from the WEB only. 
      • "CSR" – the payment option can be used to update billing groups from the CSR platform only. 
      • "ANY" – the payment option can be used to update billing groups from either WEB or CSR platforms. 
    • titlePayOptionUpdateDflt – contains a code describes whether the payment variant is the default when updating existing entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
      • "TRUE" – the payment variant is the default for this payment option when performing updates.
      • "FALSE" – the payment variant is NOT the default for this payment option.
    • titlePayOptionBillTiming – contains a code indicating how bill timing is controlled. The following options exist:
      • "ARIA" – the standard Aria functionality for controlling the bill timing is used, i.e. the bill lag days defined in payment terms, billing groups, etc. 
      • "CUTOFF" – the bill timing is calculated based on a cutoff time. AMPS will calculate the appropriate bill lag days to ensure that bills are produced and collected prior to the cutover time in each month. 
    • titlePayOptionBillTimingCutoff – contains the day of the month when the cutoff day is set. Is used only if TitlePayOptionBillTiming contains "CUTOFF". 
    • titlePayOptionGatewayType – contains a code indicating if and how AMPS integrate with the payment gateway. Is used only for CREDITCARD payment variants. The following codes apply: 
      • "NONE" – no payment gateway is in use. 
      • "INTERNAL" – the payment gateway is managed directly by Aria.
      • "EXTERNAL" – the payment gateway is managed outside Aria, for example in Workflow. 
    • titlePayOptionGatewayID – contains the identification of the payment gateway used for this payment option. Used only if the payment option indicates "CREDITCARD" and if the gateway type equals "EXTERNAL" in which case the gateway ID must exist the "Payment Option Gateway" table. Contains "Null" if not used. 
    • titlePayOptionGatewayColl – contains a code that defines how and for what invoices AMPS will be attempting collection funds. Is used only for Gateway Type is "EXTERNAL". The following codes apply: 
      • "ALL" – All invoices will trigger a collection attempt. 
      • "NOT-FIRST" – All invoices, except the first invoice, will trigger a collection attempt.
    • titlePayOptionDocInitialGen – contains a code indicating if, and how, the initial invoice document is generated and sent to the end-customer. The following codes apply:
      • "NONE" – no special treatment is done for the initial invoice
      • "FIRST-DIRECT" – the first invoice produced by ARIA will be sent directly to the end-customer via email from ARIA. Subsequent invoices will be sent via partners only. 
      • "ALL-DIRECT" – all invoices and financial documents are sent directly to the end-customer via email. Copies may also be sent to the partner, ref. the "Payment Option Document Partner Generation" field. 
    • titlePayOptionDocPartnerGen – contains a code indicating if, and how, documents generated by AMPS are sent to the external document partner. Details on the option is also sent to the partner. The following codes apply:
      • "NONE" – no document generated by AMPS.
      • "SAVE-ONLY-ALL" – send to the partner as copy only.
      • "SAVE-AND-SEND-ALL" – send to the partner as a normal invoice, credit note, reminder, etc. 
    • titlePayOptionDocFormatID – contains the identification of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
    • titlePayOptionDocFormatVersion – contains the version of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
    • titlePayOptionDocDestID – a string column that contains the identification of the destination to which documents are sent in the chosen format. The ID selected must exist in the "Payment Option Document Destination" table. 
    • titlePayOptionDocDestType – contains a code identifying how the documents are delivered to this destination. This column cannot be updated via the API. The following codes apply:
      • "SFTP" – the documents are delivered via SFTP to a server and server folder designated by the partner. The documents are delivered in the format specified by the ID. 
      • "REST" – the documents are delivered via REST API calls to a destination URL designated by the partner. The documents are delivered in the format specified by the ID. 
    • titlePayOptionDocDestLocation – contains the folder path or REST URL where the documents are delivered by AMPS. Must contain a valid folder path or REST URL depending on the destination type defined above. This column cannot be updated via the API.
    • titlePayOptionCaptureType – contains a code indicating the method used by AMPS to capture details on the payment requests. The following codes currently apply:
      • "BANK" – payment transaction is captured by AMPS on receipt of payment confirmation from bank, for example as OCR or bank transfers. AMPS will use the generated customer invoice reference number to match the payment received to an invoice. 
      • "CC-ONLINE" – payment transaction is captured by AMPS when ARIA fires an event indicating the completion of the payment. Used only with ARIA managed payment gateways. 
      • "CC-OFFLINE" – payment transaction is captured by AMPS when AMPS receive confirmation (via batch or other interface) from the payment gateway that funds have successfully been transferred. Used only with AMPS managed payment gateways. Confirmation received later via batch or interface file. 
    • titlePayOptionCustInvRefGen – contains a code indicating how AMPS will generate the customer invoice reference number, also known as KID number or OCR number. The following options apply:
      • "NONE" – generate no new reference. Primarily used with credit card transactions.
      • "NEW" – generate new customer invoice reference for each invoice and use this number of match the payment with the invoice. Generated based on the Statement Number suffixed with a check digit. 
      • "EAN" – use the customer invoice reference defined by EAN Requisition number (AVTALEGIRO and EFAKTURA) when the billing group or account was first created. 
    • Payment Option Selection Rule [TitlePayOptionSelectionRule] – a new string column that defines how certain automatic selection rules apply to the payment method, for example when customer signs-up for AVTALEGIRO and is already on EFAKTURA. The following options apply when chosen payment option is neither AVTALEGIRO nor EFAKTURA:
      • "NONE" – is set to "NONE" for payment options other than AVTALEGIRO or EFAKTURA. 

The following options apply when chosen payment option is EFAKTURA:

  • "STANDARD" – this is the automatic selection done when signing up for EFAKTURA electronically via the banks. 
  • "AVT-WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO with notification when already on EFAKTURA. 
  • "AVT-WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO without notification when already on EFAKTURA

The following options apply when chosen payment option is AVTALEGIRO

 

  • "WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO with notification when on any other payment option than EFAKTURA. Can also be used to switch between with and without notification when on AVTALEGIRO already.  
  •     "WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO without notification when on any other payment option than EFAKTURA. Can also be used to switch between with and without notification when on AVTALEGIRO already.

 

  • titlePayOptionDocDist – contains a code that defines how the invoice, credit note, and dunning notices are distributed to the end-customer by the third-party document management system. The parameter is used only if titlePayOptionDocGeneration contains a value other than "NONE". The following options apply:
    • "PARTNER" – the external partner is responsible for selecting the best distribution option for the document. 
    • "EMAIL-PDF" – the external partner will send the invoice, credit note, and dunning notices to the end-customer via email with an PDF attachment.
  • titlePayOptionUnderPayThresh – contains the value that defines the under-payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the under-payment threshold, the action described in "Under Payment Action Inside" is executed for the payment
  • titlePayOptionUnderPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value less "Under Payment Threshold". An example of this is where the invoice is for NOK 1025; the under-payment threshold is set at NOK 50; a payment of NOK 925 through NOK 1025 is within the under-payment threshold. A payment of less than NOK 925 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is within the threshold specified except that partial payment is applied on the invoice, which eventually will go into dunning. 
    • "WRITEOFF" – if the payment is within the value of the invoice and the "Under Payment Threshold", the missing payment is automatically written-off and the remaining payment is recognised in the ERP system. 
  • titlePayOptionOverPayThresh – contains the value that defines the over payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the over-payment threshold, the action described in "Over Payment Action Inside" is executed for the payment. If the payment received is greater than the invoice value plus the over-payment threshold, the action described in "Over Payment Action Outside" is executed for the payment.
  • titlePayOptionManualRefund – contains a code that defines whether manual refunds can be created for billing groups associated with this payment option, and if so, how it can be refunded. The following options exist:
    • "NONE" – manual refunds cannot be registered for subscriptions or payment agreements on the current billing group.  
    • "ORIGINAL" – manual refunds can be created by the CSR, but only specifying the original payment method with which the payment was made, for example if payment was by credit card, then refund must also be on the same credit card. 
    • "ANY" – manual refunds can be created by the CSR using any of the supported means of payment. 
  • titlePayOptionOverPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; a payment of NOK 1025 through NOK 1075 is within the over-payment threshold. A payment of more than NOK 1075 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is within the threshold specified except that full payment is applied on the invoice and any excess payment is placed on the account for future consumption. 
    • "REFUND" – if the payment is within the value of the invoice and the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
  • titlePayOptionOverPayActionOutside – contains a code that defines the action to take if the payment received is greater than the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; A payment of more than NOK 1075 is outside the threshold. The following options exist:
    • "NONE" – no action is taken if payment received is greater than the invoice value plus the "Over-Payment Threshold"
    • "REFUND" – if the payment is greater than the value of the invoice plus the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
  • titlePayOptionReactivateTime – contains a value that indicates the number of days after suspending the subscription due to missing payment, that a payment will automatically reopen the subscription. 0 (Zero) indicates that it will not be reopened.
     

Title Retrieve Pay Options (JSON API)

Endpoint

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

TitleRetrievePayOptionsRequest

The TitleRetrievePayOptionsRequest message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

Sample 1
A sample request used to retrieve a payment option. 
{
"msgAuthDetails": {
    "clientNo": 99,
    "authKey": "",
    "requestDateTime": "2019-10-09",
    "signatureValue": "",
    "ariaAccountID": "",
    "ariaAccountNo": 0,
    "signatureVersion": "",
    "userID": ""
      },
      "titleRetrievePayOptionsCriteria": {
    "requestSource": "WEB",
    "requestAction": "UPDATE"
  }
}

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. 
  • requestDateTime - contains the date and time when the message was built. 
  • 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 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. 
  • userID – contains the user id associated with the account. 
  • signatureVersion – contains the version number to validate the signatureValue. Version is provided to client along with clientNo & authKey.

The individual data elements of titleRetrievePayOptionsCriteria are defined as follows:

  • requestSource – contains a code indicating the source of the request. The source is used to determine what payment options and variants to return. The following codes apply:
    • WEB – the request is from the WEB front-end.
    • CSR – the request is from the CSR platform. 
  • requestAction – contains a code indicating what action the caller is attempting to do. The following codes apply:
    • ANY – the caller has not determined what the action is going to be. 
    • CREATE – the caller wants to create a new billing group / account and requires the list of relevant payment options and variants
    • UPDATE – the caller wants to modify an existing billing group / account and requires the list of relevant payment options and variants. 

TitleRetrievePayOptionsResponse


The TitleRetrievePayOptionsResponse is a JSON formatted response structure returned in response to the TitleRetrievePayOptionsRequest

Sample 1
A sample response:
{
  "resultInfo": {
    "resultCode": 0,
    "resultText": "OK"
  },
  "titleRetrievePayOptionsResponseDetails": {
    "titlePayOptionID": "SamplePayOptionID",
    "titlePayOptionVariant": "SampleVariant",
    "titlePayOptionName": "SampleName",
    "titlePayOptionNameTranslations": [
      {
        "solmRefTransNo": 67167228,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "ut",
            "solmRefTransText": "in minim labore Duis nulla"
          }
        ]
      }
    ],

    "titlePayOptionDesc": "pariatur",
    "titlePayOptionDescTranslations": [
      {
        "solmRefTransNo": -58291483,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "occaecat ad molli",
            "solmRefTransText": "nisi sit"
          }
        ]
      }
    ],
    "titlePayOptionVariantName": "cupidatat in",
    "titlePayOptionVariantNameTranslations": [
    {
        "solmRefTransNo": -78950814,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "sed ut l",
            "solmRefTransText": "anim exercitation dolore ullamco nulla"
          }
        ]
      }
    ],
    "titlePayOptionVariantDesc": "ut nulla Ut",
    "titlePayOptionVariantDescTranslations": [
      {
        "solmRefTransNo": -36289122,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "ut",
            "solmRefTransText": "laboris voluptate consectetur sint"
          }
        ]
      }
    ],
    "titlePayOptionNew": "ANY",
    "titlePayOptionNewDflt": true,
    "titlePayOptionUpdate": "CSR",
    "TitlePayOptionUpdateDflt": true,
    "titlePayOptionBillTiming": "ARIA",
    "titlePayOptionBillTimingCutoff": 4,
    "titlePayOptionGatewayType": "NONE",
    "titlePayOptionGatewayID": "adipisicing consequat Duis do velit",
    "titlePayOptionGatewayColl": "ALL",
    "titlePayOptionDocInitialGen": "NONE",
    "titlePayOptionDocPartnerGen": "SAVE-ONLY-ALL",
    "titlePayOptionDocFormatID": "Ut sit voluptate",
    "titlePayOptionDocFormatVersion": "non sunt",
    "titlePayOptionDocDestID": "sunt",
    "titlePayOptionDocDestType": "REST",
    "titlePayOptionDocDestLocation": "sunt do tempor commodo",
    "titlePayOptionCaptureType": "BANK",
    "titlePayOptionCustInvRefGen": "EAN",
    "TitlePayOptionSelectionRule": "WITH",
    "titlePayOptionDocDist": "EMAIL-PDF",
    "titlePayOptionUnderPayThresh": 50,
    "titlePayOptionUnderPayActionInside": "NONE",
    "titlePayOptionOverPayThresh": 100,
    "titlePayOptionManualRefund": "ORIGINAL",
    "titlePayOptionOverPayActionInside": "REFUND",
    "titlePayOptionOverPayActionOutside": "REFUND",
    "titlePayOptionReactivateTime": 10
  }

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. 


Thee individual data elements of titleRetrievePayOptionsResponseDetails are defined as follows

  • titlePayOptionID – contains the identification of the payment option for which information is returned.
  • titlePayOptionVariant – contains the identification of the payment variant for which information is returned. 
  • titlePayOptionName – contains the name of the payment option for which information is returned.
  • titlePayOptionNameTranslations – contains the translations related to the payment option name. 
    • solmRefTransNo – contains the identification of the translation for this payment option name. 
    • solmTranslationEntry – an array containing an element for each locale the payment option name is returned in. 
      • solmLocaleID – contains the ID of the locale in which the payment option name is returned.
      • solmRefTransText– contains the name of the payment option name in the locale (language) described by solmLocaleID. 
  • titlePayOptionDesc – contains the description of the payment option for which information is returned.
  • titlePayOptionDescTranslations – contains the translations related to the payment option description. 
    • solmRefTransNo – contains the identification of the translation for this payment option description. 
    • solmTranslationEntry – an array containing an element for each locale the payment option description is returned in. 
      • solmLocaleID – contains the ID of the locale in which the payment option description is returned.
      • solmRefTransText– contains the name of the payment option description in the locale (language) described by solmLocaleID
  • titlePayOptionVariantName – contains the name of the payment option variant for which information is returned.
  • titlePayOptionVariantNameTranslations – contains the translations related to the payment option variant name. 
    • solmRefTransNo – contains the identification of the translation for this payment option variant name. 
    • solmTranslationEntry – an array containing an element for each locale the payment option variant name is returned in. 
      • solmLocaleID – contains the ID of the locale in which the payment option variant name is returned.
      • solmRefTransText– contains the name of the payment option variant name in the locale (language) described by solmLocaleID
  • titlePayOptionVariantDesc – contains the description of the payment option variant for which information is returned.
  • titlePayOptionVariantDescTranslations – contains the translations related to the payment option variant description. 
    • solmRefTransNo – contains the identification of the translation for this payment option variant description. 
    • solmTranslationEntry – an array containing an element for each locale the payment option variant description is returned in. 
      • solmLocaleID - contains the ID of the locale in which the payment option variant description is returned.
      • solmRefTransText– contains the name of the payment option variant description in the locale (language) described by solmLocaleID
  • titlePayOptionNew – contains a code indicating whether the payment option can be used to create new accounts and/or billing groups. The following options apply:
    • "WEB" – the payment option can be used to create new accounts and/or billing groups from the WEB only. 
    • "CSR" – the payment option can be used to create new accounts and/or billing groups from the CSR platform only. 
    • "ANY" – the payment option can be used to create new accounts and/or billing groups from either WEB or CSR platforms. 
  • titlePayOptionNewDflt – contains a code that describes whether the payment variant is the default when creating new entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
    • "TRUE" – the payment variant is the default for this payment option.
    • "FALSE" – the payment variant is NOT the default for this payment option. 
  • titlePayOptionUpdate – contains a code indicating whether the payment option can be used to update existing billing groups. The following options apply:
    • "WEB" – the payment option can be used to update billing groups from the WEB only. 
    • "CSR" – the payment option can be used to update billing groups from the CSR platform only. 
    • "ANY" – the payment option can be used to update billing groups from either WEB or CSR platforms. 
  • titlePayOptionUpdateDflt – contains a code describes whether the payment variant is the default when updating existing entities on the current option. Only a single variant can be defined as the default option for a given payment option. The following options apply:
    • "TRUE" – the payment variant is the default for this payment option when performing updates.
    • "FALSE" – the payment variant is NOT the default for this payment option.
  • titlePayOptionBillTiming – contains a code indicating how bill timing is controlled. The following options exist:
    • "ARIA" – the standard Aria functionality for controlling the bill timing is used, i.e. the bill lag days defined in payment terms, billing groups, etc. 
    • "CUTOFF" – the bill timing is calculated based on a cutoff time. AMPS will calculate the appropriate bill lag days to ensure that bills are produced and collected prior to the cutover time in each month. 
  • titlePayOptionBillTimingCutoff – contains the day of the month when the cutoff day is set. Is used only if TitlePayOptionBillTiming contains "CUTOFF". 
  • titlePayOptionGatewayType – contains a code indicating if and how AMPS integrate with the payment gateway. Is used only for CREDITCARD payment variants. The following codes apply: 
    • "NONE" – no payment gateway is in use. 
    • "INTERNAL" – the payment gateway is managed directly by Aria.
    • "EXTERNAL" – the payment gateway is managed outside Aria, for example in Workflow. 
  • titlePayOptionGatewayID – contains the identification of the payment gateway used for this payment option. Used only if the payment option indicates "CREDITCARD" and if the gateway type equals "EXTERNAL" in which case the gateway ID must exist the "Payment Option Gateway" table. Contains "Null" if not used. 
  • titlePayOptionGatewayColl – contains a code that defines how and for what invoices AMPS will be attempting collection funds. Is used only for Gateway Type is "EXTERNAL". The following codes apply: 
    • "ALL" – All invoices will trigger a collection attempt. 
    • "NOT-FIRST" – All invoices, except the first invoice, will trigger a collection attempt.
  • titlePayOptionDocInitialGen – contains a code indicating if, and how, the initial invoice document is generated and sent to the end-customer. The following codes apply:
    • "NONE" – no special treatment is done for the initial invoice
    • "FIRST-DIRECT" – the first invoice produced by Aria will be sent directly to the end-customer via email from Aria. Subsequent invoices will be sent via partners only. 
    • "ALL-DIRECT" – all invoices and financial documents are sent directly to the end-customer via email. Copies may also be sent to the partner, ref. the "Payment Option Document Partner Generation" field. 
  • titlePayOptionDocPartnerGen – contains a code indicating if, and how, documents generated by AMPS are sent to the external document partner. Details on the option is also sent to the partner. The following codes apply:
    • "NONE" – no document generated by AMPS.
    • "SAVE-ONLY-ALL" – send to the partner as copy only.
    • "SAVE-AND-SEND-ALL" – send to the partner as a normal invoice, credit note, reminder, etc. 
  • titlePayOptionDocFormatID – contains the identification of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
  • titlePayOptionDocFormatVersion – contains the version of the format used when transferring document such as invoices, credit notes and reminders to external systems for processing. Is used only if titlePayOptionDocGeneration contains a value other than "NONE", in which case the combination of ID and version must exist the "Payment Option Document Format" table. 
  • titlePayOptionDocDestID – a string column that contains the identification of the destination to which documents are sent in the chosen format. The ID selected must exist in the "Payment Option Document Destination" table. 
  • titlePayOptionDocDestType – contains a code identifying how the documents are delivered to this destination. This column cannot be updated via the API. The following codes apply:
    • "SFTP" – the documents are delivered via SFTP to a server and server folder designated by the partner. The documents are delivered in the format specified by the ID. 
    • "REST" – the documents are delivered via REST API calls to a destination URL designated by the partner. The documents are delivered in the format specified by the ID. 
  • titlePayOptionDocDestLocation – contains the folder path or REST URL where the documents are delivered by AMPS. Must contain a valid folder path or REST URL depending on the destination type defined above. This column cannot be updated via the API.
  • titlePayOptionCaptureType – contains a code indicating the method used by AMPS to capture details on the payment requests. The following codes currently apply:
    • "BANK" – payment transaction is captured by AMPS on receipt of payment confirmation from bank, for example as OCR or bank transfers. AMPS will use the generated customer invoice reference number to match the payment received to an invoice. 
    • "CC-ONLINE" – payment transaction is captured by AMPS when ARIA fires an event indicating the completion of the payment. Used only with ARIA managed payment gateways. 
    • "CC-OFFLINE" – payment transaction is captured by AMPS when AMPS receive confirmation (via batch or other interface) from the payment gateway that funds have successfully been transferred. Used only with AMPS managed payment gateways. Confirmation received later via batch or interface file. 
  • titlePayOptionCustInvRefGen – contains a code indicating how AMPS will generate the customer invoice reference number, also known as KID number or OCR number. The following options apply:
    • "NONE" – generate no new reference. Primarily used with credit card transactions.
    • "NEW" – generate new customer invoice reference for each invoice and use this number of match the payment with the invoice. Generated based on the Statement Number suffixed with a check digit. 
    • "EAN" – use the customer invoice reference defined by EAN Requisition number (AVTALEGIRO and EFAKTURA) when the billing group or account was first created. 
  • Payment Option Selection Rule [TitlePayOptionSelectionRule] – a new string column that defines how certain automatic selection rules apply to the payment method, for example when customer signs-up for AVTALEGIRO and is already on EFAKTURA. The following options apply when chosen payment option is neither AVTALEGIRO nor EFAKTURA:
    • "NONE" – is set to "NONE" for payment options other than AVTALEGIRO or EFAKTURA. 


The following options apply when chosen payment option is EFAKTURA:

  • "STANDARD" – this is the automatic selection done when signing up for EFAKTURA electronically via the banks. 
  • "AVT-WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO with notification when already on EFAKTURA. 
  • "AVT-WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO without notification when already on EFAKTURA.


The following options apply when chosen payment option is AVTALEGIRO

  • "WITH" – this is the automatic selection chosen when signing up for AVTALEGIRO with notification when on any other payment option than EFAKTURA. Can also be used to switch between with and without notification when on AVTALEGIRO already.  
  • "WITHOUT" – this is the automatic selection chosen when signing up for AVTALEGIRO without notification when on any other payment option than EFAKTURA. Can also be used to switch between with and without notification when on AVTALEGIRO already. 
    titlePayOptionDocDist – contains a code that defines how the invoice, credit note, and dunning notices are distributed to the end-customer by the third-party document management system. The parameter is used only if titlePayOptionDocGeneration contains a value other than "NONE". The following options apply:
    • "PARTNER" – the external partner is responsible for selecting the best distribution option for the document. 
    • "EMAIL-PDF" – the external partner will send the invoice, credit note, and dunning notices to the end-customer via email with an PDF attachment.

•    titlePayOptionUnderPayThresh – contains the value that defines the under-payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the under-payment threshold, the action described in "Under Payment Action Inside" is executed for the payment
•    titlePayOptionUnderPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value less "Under Payment Threshold". An example of this is where the invoice is for NOK 1025; the under-payment threshold is set at NOK 50; a payment of NOK 925 through NOK 1025 is within the under-payment threshold. A payment of less than NOK 925 is outside the threshold. The following options exist:
                  "NONE" – no action is taken if payment received is within the threshold specified except that partial payment is applied on the invoice, which eventually will go into dunning. 
                  "WRITEOFF" – if the payment is within the value of the invoice and the "Under Payment Threshold", the missing payment is automatically written-off and the remaining payment is recognized in the ERP system. 
•    titlePayOptionOverPayThresh – contains the value that defines the over payment threshold. If no threshold is provided the attribute must contain 0 (Zero). If the payment received is within the invoice value and the over-payment threshold, the action described in "Over Payment Action Inside" is executed for the payment. If the payment received is greater than the invoice value plus the over-payment threshold, the action described in "Over Payment Action Outside" is executed for the payment.
•    titlePayOptionManualRefund – contains a code that defines whether manual refunds can be created for billing groups associated with this payment option, and if so, how it can be refunded. The following options exist:
                  "NONE" – manual refunds cannot be registered for subscriptions or payment agreements on the current billing group.  
                  "ORIGINAL" – manual refunds can be created by the CSR, but only specifying the original payment method with which the payment was made, for example if payment was by credit card, then refund must also be on the same credit card. 
                  "ANY" – manual refunds can be created by the CSR using any of the supported means of payment. 
•    titlePayOptionOverPayActionInside – contains a code that defines the action to take if the payment received is between the invoice value and the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; a payment of NOK 1025 through NOK 1075 is within the over-payment threshold. A payment of more than NOK 1075 is outside the threshold. The following options exist:
                  "NONE" – no action is taken if payment received is within the threshold specified except that full payment is applied on the invoice and any excess payment is placed on the account for future consumption. 
                  "REFUND" – if the payment is within the value of the invoice and the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
•    titlePayOptionOverPayActionOutside – contains a code that defines the action to take if the payment received is greater than the invoice value plus "Over Payment Threshold". An example of this is where the invoice is for NOK 1025; the over-payment threshold is set at NOK 50; A payment of more than NOK 1075 is outside the threshold. The following options exist:
                  "NONE" – no action is taken if payment received is greater than the invoice value plus the "Over-Payment Threshold"
                   "REFUND" – if the payment is greater than the value of the invoice plus the "Over Payment Threshold", the excess payment is immediately posted as a refund against the customer. 
•    titlePayOptionReactivateTime – contains a value that indicates the number of days after suspending the subscription due to missing payment, that a payment will automatically reopen the subscription. 0 (Zero) indicates that it will not be reopened. 
 

Title Manage Pay Terms (JSON API)

Endpoint

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

TitleRetrievePayOptionsRequest

The TitleManagePayTermsRequest message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

•    Sample 1) Removing an already existing payment term

Sample 1

A sample request used to remove a payment term. 
{
  "msgAuthDetails": {
    "clientNo": 103,
    "authKey": "ABCDEFGHIJKLMNOPQR",
    "requestDateTime": "ABCDEFGHI",
    "signatureValue": "ABCD",
    "signatureVersion": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
    "ariaAccountID": "ABCDEFGHIJKLMNOPQRSTUVW",
    "ariaAccountNo": 70,
    "userID": "ABCDEFGHIJKLMNOPQ"
  },
  "titleManagePayTermsList": {},
  "titleManagePayTermsActionInfo": "ABCDEFGHI",
  "solmTranslationEntry": "ABCDEFGH",
  "titleManagePayTermsInfo": [
    false,
    [
      false,
      527
    ]
  ],
  "titleManagePayOptionsList": [
    {
      "titleManagePayTermsActionInfo": {
        "titleManagePayOptionsAction": -64,
        "titleManagePayTermsAction": "REMOVE"
      },
      "titleManagePayTermsInfo": {
        "titlePayTermID": "ABCDEFGHIJK",
        "titlePayTermName": "ABCDEFGHIJKLMNOPQRSTUVWXY",
        "titlePayTermNameTranslations": {
          "solmRefTransNo": "ABCDEFGHIJKL",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMNOPQR",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC"
            }
          ]
        },
        "titlePayTermDesc": "ABCDEFGHIJKLMNOPQRSTUVW",
        "titlePayTermDescTranslationsc": "ABCDEFGHIJKLMNOP",
        "titlePayBillLagDays": 998,
        "titlePayDaysUntilDue": 695,
        "titlePayDaysUntilDueOption": 948,
        "titlePayTermDescTranslations": {
          "solmRefTransNo": "ABCDEFG",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCD",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQRSTUV"
            }
          ]
        }
      }
    }
  ]
}
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. 
  • requestDateTime - contains the date and time when the message was built. 
  • 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 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. 
  • userID – contains the user id associated with the account. 
  • signatureVersion – contains the version number to validate the signatureValue. Version is provided to client along with clientNo & authKey.
  • titleManagePayOptionsList – defines an array of actions to perform for the Manage Payment Options service. May contain 1 or more entries. Is based on titleManagePayOptionsList structure described later in this section. 
  • titleManagePayTermsList – defines an array of actions to perform for the Manage Payment Terms service. May contain 1 or more entries. Is based on titleManagePayTermsList structure described later in this section. 


The individual data elements of the titleManagePayTermsList structure are defined as follows:

  • titleManagePayTermsList – the overall structure for the definition.
    • titleManagePayTermsActionInfo – defines a structure that hold details on what action the service should perform on the payment terms. The data structure is built using the titleManagePayTermsActionInfo structure defined later in this section. 
    • titleManagePayTermsInfo – defines a structure that hold details on the actual content of the payment terms. The data structure is built using the titleManagePayTermsInfo structure defined later in this section.


The individual data elements of the titleManagePayTermsActionInfo structure are defined as follows:

  • titleManagePayTermsActionInfo – the action control structure describing what action to take. 
  • titleManagePayTermsAction – contains the action to perform. “ADD” adds a new payment term; “MODIFY” modifies an existing payment term while “REMOVE” removes an existing payment term. 


The individual data elements of the titleManagePayTermsInfo structure are defined as follows:

  • titleManagePayTermsInfo – a structure holding the general information on the payment term to be managed. 
    • titlePayTermID – contains the identification of the payment term available in AMPS. The titlePayTermID contains a reference to the details found in TitlePayTerm table. The payment term must also exist in ARIA core. 
    • titlePayTermName – contains the name of the payment term.
    • titlePayTermNameTranslations – contains the translations related to the payment term name. 
      • solmRefTransNo – contains the identification of the translation for this payment term name. 
      • solmTranslationEntry – an array containing an element for each locale the payment term name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment term name is returned.
        • solmRefTransText– contains the name of the payment term name in the locale (language) described by solmLocaleID. 
    • titlePayTermDesc – contains the brief description of the payment term.
    • titlePayTermDescTranslations – contains the translations related to the payment term description. 
      • solmRefTransNo – contains the identification of the translation for this payment term description. 
      • solmTranslationEntry – an array containing an element for each locale the payment term description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment term description is returned.
        • solmRefTransText– contains the name of the payment term description in the locale (language) described by solmLocaleID
    • titlePayBillLagDays – contains the number of bill lag days to apply for the current payment term. May contain either a negative number, zero or a positive number. 
    • titlePayDaysUntilDue – contains the number of days until due, i.e. the number of days from the invoice date until the customer must pay the invoic
    • titlePayDaysUntilDueOption – contains a code indicating how the invoice due date is calculated. The following options exist:
      • 1 – due date is calculated based on the invoice date plus the invoice days until due. 
      • 2 – due date is calculated based on the first date in the next month plus the invoice days until due.

TitleRetrievePayOptionsResponse

The TitleManagePayTermsResponse message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

•    Sample 1) Returns response on whether a new payment term has been added or not. 

Sample 1
A sample response returned when a new pay option is tried to be added. 
{
  "resultInfo": {
    "resultCode": 103,
    "resultText": "ABCDEFGHIJKLMNOPQR"
  },
  "titleManagePayTermsListResponse": [
    {
      "titleManagePayTermsInfoResponse": {
        "actionDirective": "ADD",
        "actionResultInfo": {
          "resultCode": 965,
          "resultText": "ABCDEFGHIJKLMNOPQRSTUVW"
        }
      },
      "titleManagePayTermsInfo": {
        "titlePayTermID": "ABCDEFGHIJKLMNOPQRSTUV",
        "titlePayTermName": "ABCDEFGHIJKLMNOPQRSTUVW",
        "titlePayTermNameTranslations": {
          "solmRefTransNo": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDE",
              "solmRefTransText": "ABCDEFGHIJKL"
            }
          ]
        },
        "titlePayTermDesc": "ABCDEFGHIJKLMNOPQ",
        "titlePayTermDescTranslationsc": true,
        "titlePayBillLagDays": -64,
        "titlePayDaysUntilDue": 184,
        "titlePayDaysUntilDueOption": 215,
        "titlePayTermDescTranslations": {
          "solmRefTransNo": "ABCDEFGHIJKLMNOPQRSTUVWX",
          "solmTranslationEntry": [
            {
              "solmLocaleID": "ABCDEFGHIJKLMNOPQRSTUVWXY",
              "solmRefTransText": "ABCDEFGHIJKLMNOPQR"
            }
          ]
        }
      }
    }
  ]
}
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. 
  • titleManagePayTermsListResponse – an array structure holding the general information on the payment terms that have been processed by the JSON service. The structure is based on the titleManagePayTermsListResponse structure described later in this section. 


The individual data elements of the titleManagePayTermsListResponse structure are defined as follows:

  • titleManagePayTermsListResponse – a structure holding the holding the details of the processing of each payment term found in the request. Consist of the following attributes:
    • titleManagePayTermsInfoResponse – contains the structure defining the outcome of processing for each payment term entry. Is built using the titleManagePayTermsInfoResponse structure. 
    • titleManagePayTermsInfo – contains the structure defining the details on the payment term returned after the operation is complete. Is built using the titleManagePayTermsInfo structure found later in this section.  


The individual data elements of the titleManagePayTermsInfoResponse structure are defined as follows:

  • titleManagePayTermsInfoResponse – a structure holding the holding the details of the processing of each payment term found in the request. Consist of the following attributes:
    • actionDirective – contains the action that has been performed. “ADD” adds a new payment term; “MODIFY” modifies an existing payment term while “REMOVE” removes an existing payment term. 
    • actionResultInfo – contains the outcome of the processing for the given entry in the API call. Is built using the standard resultInfo structure. 


The individual data elements of the titleManagePayTermsInfo structure are defined as follows:

  • titleManagePayTermsInfo – a structure holding the general information on the payment term to be managed. 
    • titlePayTermID – contains the identification of the payment term available in AMPS. The titlePayTermID contains a reference to the details found in TitlePayTerm table. The payment term must also exist in ARIA core. 
    • titlePayTermName – contains the name of the payment term.
    • titlePayTermNameTranslations – contains the translations related to the payment term name. 
      • solmRefTransNo – contains the identification of the translation for this payment term name. 
      • solmTranslationEntry – an array containing an element for each locale the payment term name is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment term name is returned.
        • solmRefTransText– contains the name of the payment term name in the locale (language) described by solmLocaleID
    • titlePayTermDesc – contains the brief description of the payment term.
    • titlePayTermDescTranslations – contains the translations related to the payment term description. 
      • solmRefTransNo – contains the identification of the translation for this payment term description. 
      • solmTranslationEntry – an array containing an element for each locale the payment term description is returned in. 
        • solmLocaleID – contains the ID of the locale in which the payment term description is returned.
        • solmRefTransText– contains the name of the payment term description in the locale (language) described by solmLocaleID. 
    • titlePayBillLagDays – contains the number of bill lag days to apply for the current payment term. May contain either a negative number, zero or a positive number. 
    • titlePayDaysUntilDue – contains the number of days until due, i.e. the number of days from the invoice date until the customer must pay the invoice. 
    • titlePayDaysUntilDueOption – contains a code indicating how the invoice due date is calculated. The following options exist:
      • 1 – due date is calculated based on the invoice date plus the invoice days until due. 
      • 2 – due date is calculated based on the first date in the next month plus the invoice days until due.
         

Title Retrieve Pay Terms (JSON API)

Endpoint

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

TitleRetrievePayTermsRequest

The TitleRetrievePayTermsRequest message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

Sample 1
A sample request used to retrieve payment terms. 
{
"msgAuthDetails": {
    "clientNo": 99,
    "authKey": "",
    "requestDateTime": "2019-10-09",
    "signatureValue": "",
    "ariaAccountID": "",
    "ariaAccountNo": 0,
    "signatureVersion": "",
    "userID": ""
      }
}
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. 
  • requestDateTime - contains the date and time when the message was built. 
  • 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 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. 
  • userID – contains the user id associated with the account. 
  • signatureVersion – contains the version number to validate the signatureValue. Version is provided to client along with clientNo & authKey.
     

TitleRetrievePayTermsResponse

The TitleRetrievePayTermsResponse message is a JSON formatted message used to manage pay options associated with titles. The following example is provided:

Sample 1
A sample response: 

{
  "resultInfo": {
    "resultCode": 0,
    "resultText": "OK"
  },
  "titleRetrievePayTermsResponseDetails": {
    "titlePayTermID": "Term ID",
    "titlePayTermName": "Term Name",
    "titlePayTermNameTranslations": [
      {
        "solmRefTransNo": 64061757,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "Name Locale ID",
            "solmRefTransText": "Name Reference Translation Text"
          }
        ]
      }
    ],
    "titlePayTermDesc": "Pay Term Description",
    "titlePayTermDescTranslations": [
      {
        "solmRefTransNo": 2218767,
        "solmTranslationEntry": [
          {
            "solmLocaleID": "Description Locale ID",
            "solmRefTransText": "Description Reference Translation Text"
          }
        ]
      }
    ],
    "titlePayBillLagDays": 10,
    "titlePayDaysUntilDue": 5,
    "titlePayDaysUntilDueOption": 10
  }
}

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. 


Thee individual data elements of titleRetrievePayTermsResponseDetails are defined as follows:
 

  • title PayTermID – contains the identification of the payment term available in AMPS. The titlePayTermID contains a reference to the details found in TitlePayTerm table. The payment term must also exist in ARIA core. 
  • titlePayTermName – contains the name of the payment term. 
  • titlePayTermNameTranslations – contains the translations related to the payment term name.
    • solmRefTransNo – contains the identification of the translation for this payment term name. 
    • solmTranslationEntry – an array containing an element for each locale the payment term name is returned in. 
      • solmLocaleID – contains the ID of the locale in which the payment term name is returned.
  • solmRefTransText– contains the name of the payment term name in the locale (language) described by solmLocaleID
  • titlePayTermDesc – contains the brief description of the payment term
  • titlePayTermDescTranslations – contains the translations related to the payment term description. 
    • solmRefTransNo – contains the identification of the translation for this payment term description. 
    • solmTranslationEntry – an array containing an element for each locale the payment term description is returned in. 
      • solmLocaleID – contains the ID of the locale in which the payment term description is returned
      • solmRefTransText– contains the name of the payment term description in the locale (language) described by solmLocaleID
  • titlePayBillLagDays – contains the number of bill lag days to apply for the current payment term. May contain either a negative number, zero or a positive number. 
  • titlePayDaysUntilDue – contains the number of days until due, i.e. the number of days from the invoice date until the customer must pay the invoice. 
  • titlePayDaysUntilDueOption – contains a code indicating how the invoice due date is calculated. The following options exist:
    • 1 – due date is calculated based on the invoice date plus the invoice days until due. 
    • 2 – due date is calculated based on the first date in the next month plus the invoice days until due.
       
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.