The Administration Service provides administrative operations

Click here for the Service Description WSDL and Annotated XSDs

 

Recent Updates:

  • NEW in v2.0.100 - 11/01/2017
    • Update to support new backend framework. No API changes are being made at this time

  • NEW in v2.0.90
  • NEW 02/2015: Support for Multiple Operating Authority and Hierarchical Reporting Groups
    • Terminal Setting configurations(s)
    • Authority Group Membership management

    • Existing ReportingGroup_GetAll operation will automatically include Hierarchical Reporting Groups and Membership (if enabled)

      • The ID of a Hierarchical reporting group will be comprised using "Hi word, Lo word": (CompanyId * 2^16) + TerminalId
        This will produce result where:
        • Value does not complete with existing Custom Reporting Groups
        • Value is a positive integer (does not require any change to Vendor software)
        • Value is easily/accurately encoded and decoded to/from HiLo value
        • CompanyId has a ceiling of 32768 (set at 30k to provide a buffer if needed in the future)
        • TerminalId has a ceiling of 65535 (set at 60k to provide a buffer if needed in the future)

          Examples:
          1. A Company Level Hierarchical Reporting Group:
            CompanyId = 201
            CompanyName = BurgerKing
            ======================================
            HierarchicalReportingGroupId = 13172736
            HierarchicalReportingGroupName = "BurgerKing" (Company Name Only)

          2. A Terminal Level Hierarchical Reporting Group:
            CompanyId = 201
            CompanyName = BurgerKing
            TerminalId = 54
            TerminalName = Denver102
            ======================================
            HierarchicalReportingGroupId = 13172790
            HierarchicalReportingGroupName = "BurgerKing - Denver102"

        • Existing structure is not affected:

API Examples