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.