Circ API

• 1. Does the user name in the CIRC API need to be a valid user in the database? Default Value: No This setting determines whether the username provided in the CircAPI has to be a valid user recorded in the database. Set the value to Yes if it has to be a valid username in the database; otherwise, set it to No.

• 2. Should the CIRC API require a valid access key be passed to it? Default Value: Yes If set to Yes, user has to provide the access key to obtain a response from the CircAPI. Set the value to No to avoid providing the access key.

• 3. Should starts via the CircAPI be suspended? Default Value: N(o) This setting determines whether a new subscription can be started using the CircAPI. If the value is set to Y(es), new starts will not be created through CircAPI.

• 4. What is the default reason code for permanent stop from the CircAPI? Enter the default reason code that should be used when creating Permanent Stop through the CircAPI.

• 5. What is the default reason code for Delivery Address Change from Circ API? Enter the default reason code that should be used when creating Delivery Address Change through the CircAPI.

• 6. What is the default reason code for Billing Address Change from Circ API? Enter the default reason code that should be used when creating Permanent Stop through the CircAPI.

• 7. What is the default source code for transactions Created from Circ API? Enter the default source code that should be used for transactions created through the CircAPI.

• 8. In CircAPI Should a sub-source be created, if the sub-source does not exist in the database? Default Value: No This setting determines whether a new SubSource record is to be created if the value in the CircAPI does not exist in NCS Circ Setup. Set the value to Yes to create a new SubSource record; otherwise, set it to No.

• 9. What is the default format for date type input and output parameters received and sent in Circ and Micro APIs?

  Default Value: mdy (mm/dd/yyyy)

  This setting determines the date format used for input and output parameters in the CircAPI and MicroAPIs. The format defined in this Business Rule determines the following behaviour:

  • Date fields returned in CircAPI responses are formatted according to the value specified in this Business Rule.

  • Date type input parameter fields in CircAPI and MicroAPIs accept only the date format specified in this Business Rule. If a date is provided in a format other than the one defined in this setting, the API returns an error.

• 10. What is the default username for the transactions created from Micro API?

  Default Value: MG2

  This setting determines the default username that will be assigned to transactions created through the MicroAPIs. When a transaction is created using the MicroAPIs, the value defined in this Business Rule is displayed in the CreateUser and ModifyUser fields under the Create/Modify tab (upper-right table) on the Customer Service screen.

• 11. Should Expire Date and End Grace Date be sent separately in the response? Default Value: No This setting determines how the Expire Date is returned in the FindSubscription (subocc) CircAPI response when a subscription is in grace. It controls whether the response includes a separate End Grace Date field, or whether the Expire Date field continues to return the grace period end date.

  Value
  No	When a subscriber is in grace, the Expire Date returned in the CircAPI response will be the End Grace Date. The End Grace Date field is not returned separately.
  Yes	The CircAPI response returns the original Expire Date (the first date of grace). A separate End Grace Date field is also included, indicating the date on which the grace period expires.

• 12. What is the public URL to access the invoice PDFs?

  Default Value: Blank

  This setting specifies the public URL path used to access invoice PDF files generated by the system.

  Enter the base URL where the invoice PDFs are hosted. For example: https://www.example.com/renewals/

  When retrieving invoice details, the system uses the URL defined in this Business Rule and appends the invoice file name to construct the full link used to access the invoice PDF.

  Example:

  Component	Example
  Public URL	https://www.example.com/renewals/
  Invoice file name	Renewal-DM-59917-04222024.pdf
  Full invoice URL	https://www.example.com/renewals/Renewal-DM-59917-04222024.pdf

  If this Business Rule is left blank, the system will not generate a public URL for accessing invoice PDFs.