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



 

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

Interface and Integration Definitions for Document Management

This article applies to:Aria Crescendo

Overview

This document describes the API methods used for Document Management when integrating with the Aria Media and Publishing Suite (AMPS). The Document 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 Document Management functionality.

Document Management

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

Each of the above APIs are described below.

Retrieve Document Text (JSON API)

Endpoint

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

DocmRetrieveTextRequest

The docmRetrieveTextRequest is a JSON formatted request structure used by the caller to retrieve details on a specific set of document texts or all document texts currently registered. 

Sample 1
A sample request used to retrieve a specific set of text for the document type and text group provided.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    " docmRetrieveTextDetailSearch": {
        “specificSearch”: “SPECIFIC”
        "docmDocumentType": "INVOICE",
        "docmTextGroup": "INV-HDR"
    }
}

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

  • specificSearch – contains a code indicating whether all document set texts or only a single document set is to be returned. The following codes apply:
    • ALL” – all texts are returned.
    • SPECIFIC” – only the specified document type and/or text group is returned.
  • docmDocumentType – contains the identification of the document type to be returned. The following codes apply:
    • "INVOICE" – return only the invoice texts.
    • "CREDIT-NOTE" – return only the credit note texts.
    • "DUNNING-NOTICE" – return only the dunning notice texts. 
  • docmTextGroupID – contains the identification of the text group within the document type that should be returned. Cannot be specified if docmDocumentType is empty. 
     

DocmRetrieveTextResponse

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

Sample 1
A sample response showing a several document types and text groups. 
{
    "resultInfo": {
        "resultCode": 0, 
        "resultText": "OK"
    },
    "docmRetrieveTextDocumentList": [
        {
            "docmDocumentType": "INVOICE",
            "docmRetrieveTextGroupList": [
                {
                    "docmTextGroupID": "INV-HDR",
                    "docmRetrieveTextTextList": [
                        {
                            "docmTextNumber": 1,
                            "docmTextValue": "INVOICE",
                            "textValueTranslations": {
                                "solmRefTransNo": 112233,
                                "solmTranslationEntry": [
                                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "INVOICE"},
                                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "INVOICE"}
                                ]
                            },
                            {
                            "docmTextNumber": 2,
                            "docmTextValue": "Invoice Date",
                            "textValueTranslations": {
                                "solmRefTransNo": 112234,
                                "solmTranslationEntry": [
                                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Invoice Date"},
                                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Invoice Date"}
                                ]
                            }
                        }
                    ]
                },
                {
                    "docmTextGroupID": "INV-FTR",
                    "docmRetrieveTextTextList": [
                        {
                            "docmTextNumber": 1,
                            "docmTextValue": "INVOICE",
                            "textValueTranslations": {
                                "solmRefTransNo": 112233,
                                "solmTranslationEntry": [
                                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "INVOICE"},
                                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "INVOICE"}
                                ]
                            }
                        }
                    ]
                }
            ]
        },
        {
            "docmDocumentType": "CREDIT-NOTE",
            "docmRetrieveTextGroupList": [
                {
                    "docmTextGroupID": "CRE-HDR",
                    "docmRetrieveTextTextList": [
                        {
                            "docmTextNumber": 1,
                            "docmTextValue": "CREDIT NOTE",
                            "textValueTranslations": {
                                "solmRefTransNo": 112233,
                                "solmTranslationEntry": [
                                    {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "CREDIT NOTE"},
                                    {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "CREDIT NOTE"}
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

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

  • docmRetrieveTextDocumentList – a structure holding the list of document types returned. 
    • docmDocumentType – contains the identification of the document type returned. The following codes apply:
      • "INVOICE" – return only the invoice texts.
      • "CREDIT-NOTE" – return only the credit note texts.
      • "DUNNING-NOTICE" – return only the dunning notice texts. 
    • docmRetrieveTextGroupList – a structure holding the list of text groups returned for a given document type. 
      • docmTextGroupID – contains the unique identification of the text group returned. 
      • docmRetrieveTextTextList – contains a list of the individual texts for the document type and text group. 
        • docmTextNumber – contains the unique number of the text returned
        • docmTextValue – contains the text returned. This text is not the translation. 
        • textValueTranslations – contains the translations related to the text
          • solmRefTransNo – contains the identification of the translation for this text. 
          • solmTranslationEntry – an array containing an element for each locale the text is returned in. 
            • solmLocaleID – contains the ID of the locale in which the text is returned.
            • solmRefTransText– contains the name of the text in the locale (language) described by solmLocaleID
               

Manage Document Text (JSON API)

Endpoint

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

DocmManageTextRequest

The docmManageTextRequest is a JSON formatted request structure used by the caller to add, update or remove texts for a given document type and text group. When called all texts for the given document type and text group will be updated. 

Sample 1
A sample request used to add texts for a given document type and text group.
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABV-USER"
    },
    "docmManageTextDocumentList": [
        {
            "docmManageTextActionInfo": {
                "docmManageTextAction": "ADD"
            },
            "docmManageTextInfo": {
                "docmDocumentType": "INVOICE",
                "docmTextGroupID": "INV-HDR",
                "docmManageTextTextList": [
                    {
                        "docmTextNumber": 1,
                        "docmTextValue": "INVOICE",
                        "textValueTranslations": {
                            "solmRefTransNo": 0,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "INVOICE"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "INVOICE"}
                            ]
                        },
                        {
                        "docmTextNumber": 2,
                        "docmTextValue": "Invoice Date",
                        "textValueTranslations": {
                            "solmRefTransNo": 0,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Invoice Date"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Invoice Date"}
                            ]
                        }
                    }
                ]
            ]
        }
    ]
}

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

  • docmManageTextActionInfo – a structure holding details on the action to perform.
    • docmManageTextAction – contains a code indicating what action to take:
      • ADD” – all the texts specified are added under the current document type and text group. Any previously defined text will be removed before adding the new text. 
      • MODIFY” – all the texts specified are updated under the current document type and text group. Any previously defined text will be removed before adding the new text.
      • "REMOVE" – all the texts specified under the current document type and text group are removed. 
  • docmManageTextInfo – a structure holding details on the texts to update. 
    • docmDocumentType – contains the identification of the document type to be updated. The following codes apply:
      • "INVOICE" – return only the invoice texts.
      • "CREDIT-NOTE" – return only the credit note texts.
      • "DUNNING-NOTICE" – return only the dunning notice texts. 
    • docmTextGroupID – contains the identification of the text group within the document type that should be updated. 
    • docmManageTextTextList – a structure holding the list of texts to manage. 
      • docmTextNumber – contains the unique number of the text. 
      • docmTextValue – contains the actual text. This text is not the translation. 
      • textValueTranslations – contains the translations related to the text.
        • solmRefTransNo – contains the identification of the translation for this text. 
        • solmTranslationEntry – an array containing an element for each locale the text is returned in. 
          • solmLocaleID – contains the ID of the locale in which the text.
          • solmRefTransText– contains the name of the text in the locale (language) described by solmLocaleID
             

DocmManageTextResponse

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

Sample 1
A sample response showing a single campaign with multiple titles and with restrictions. 
{
    "resultInfo": {
        "resultCode": 0, 
        "resultText": "OK"
    },
    "docmManageTextDocumentListResponse": [
        {
            "docmManageTextActionInfoResponse": {
                "docmManageTextAction": "ADD"
                "resultCode": 0, 
                "resultText": "OK"
            },
            "docmManageTextInfo": {
                "docmDocumentType": "INVOICE",
                "docmTextGroupID": "INV-HDR",
                "docmManageTextTextList": [
                    {
                        "docmTextNumber": 1,
                        "docmTextValue": "INVOICE",
                        "textValueTranslations": {
                            "solmRefTransNo": 0,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "INVOICE"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "INVOICE"}
                            ]
                        },
                        {
                        "docmTextNumber": 2,
                        "docmTextValue": "Invoice Date",
                        "textValueTranslations": {
                            "solmRefTransNo": 0,
                            "solmTranslationEntry": [
                                {"solmLocaleID": "NO-BOKMAL", "solmRefTransText": "Invoice Date"},
                                {"solmLocaleID": "NO-NYNORSK", "solmRefTransText": "Invoice Date"}
                            ]
                        }
                    }
                ]
            ]
        }
    ]
}

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 array elements of docmManageTextDocumentListResponse are defined as follows:

  • docmManageTextActionInfoResponse – a structure holding details on the action performed and the result
    • docmManageTextAction – contains a code indicating what action to take:
      • ADD” – all the texts specified are added under the current document type and text group. Any previously defined text will be removed before adding the new text. 
      • MODIFY” – all the texts specified are updated under the current document type and text group. Any previously defined text will be removed before adding the new text.
      • "REMOVE" – all the texts specified under the current document type and text group are removed. 
  • docmManageTextInfo – a structure holding details on the texts updated. 
    • docmDocumentType – contains the identification of the document type updated. The following codes apply:
      • "INVOICE" – return only the invoice texts.
      • "CREDIT-NOTE" – return only the credit note texts.
      • "DUNNING-NOTICE" – return only the dunning notice texts. 
    • docmTextGroupID – contains the identification of the text group within the document type that should be returned. 
    • docmManageTextTextList – a structure holding the list of texts to manage. 
      • docmTextNumber – contains the unique number of the text.
      • docmTextValue – contains the actual text. This text is not the translation. 
      • textValueTranslations – contains the translations related to the text.
        • solmRefTransNo – contains the identification of the translation for this text. 
        • solmTranslationEntry – an array containing an element for each locale the text is returned in. 
          • solmLocaleID – contains the ID of the locale in which the text.
          • solmRefTransText– contains the name of the text in the locale (language) described by solmLocaleID
             

 

 

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.