Responses

• 200 application/json

  The modules and services information from the server.

  Hide response attributes Show response attributes object

  • modules object Required

    The modules and settings.

    Hide modules attribute Show modules attribute object

    • * array[object] Additional properties

      The settings for a module.

      Hide * attributes Show * attributes object

      • SERVICE_ID_OFFSET integer(int32) Required
      • USE_REPEAT_INVOICE boolean Required
      • USE_PACKAGES boolean Required
      • BILLING_DAYS_OFFSET integer(int32) Required
      • IMGNAME string Required
      • REPEAT_BILLING_METHOD integer(int32) Required
      • DELETE_PENDING_DAYS integer(int32) Required
      • SUSPEND_DAYS integer(int32) Required
      • SUSPEND_WARNING_DAYS integer(int32) Required
      • TITLE string Required
      • MENUNAME string Required
      • EMAIL_FROM string Required
      • TBLNAME string Required
      • TABLE string Required
      • TITLE_FIELD string Required
      • TITLE_FIELD2 string
      • TITLE_FIELD3 string
      • PREFIX string Required
  • services object Required

    The list of service packages.

    Hide services attribute Show services attribute object

    • * array[object] Additional properties

      An individual package tied to one of our services.

      Hide * attributes Show * attributes object

      • services_id integer(int32) Required
      • services_name string Required
      • services_cost integer(int32) Required
      • services_currency string Required
      • services_category integer(int32) Required
      • services_buyable boolean Required
      • services_type integer(int32) Required
      • services_field1 string Required
      • services_field2 string Required
      • services_module string Required
  • serviceTypes object Required

    The listing of service types

    Hide serviceTypes attribute Show serviceTypes attribute object

    • * array[object] Additional properties

      A general grouping of services within a category.

      Hide * attributes Show * attributes object

      • st_id integer(int32) Required
      • st_name string Required
      • st_category integer(int32) Required
      • st_module string Required
  • serviceCategories object Required

    The listing of the categories for the services.

    Hide serviceCategories attribute Show serviceCategories attribute object

    • * array[object] Additional properties

      A Category of Services. This is the broadest grouping within a module.

      Hide * attributes Show * attributes object

      • category_id integer(int32) Required
      • category_name string Required
      • category_tag string Required
      • category_module string Required
• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • code string Required
  • message string Required