Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

APIs in the Diagnose section are meant to extract information from the system about its use or performance.
Three types of API can help you retrive system information:

  • CDR REST API
  • System Service SOAP API
  • OpenFire APIs

Starting with V14.10, servers related data can also be viewed or modified through REST APIs.

Anchor
__RefHeading__105963_958082936
__RefHeading__105963_958082936

Anchor
__RefHeading__23489_1837784615
__RefHeading__23489_1837784615
Call details records (CDR)

SipX Call Detail Records (CDR) Log is a RESTLET plugin which provides a resource whereby one can obtain the Call Logs for a particular user. Records are sorted by start date in descending order. Regarding security and ports, the same rules apply as for callcontroller described above
It is bundled as a JAR package file and is loaded by the sipXrest container on initialization. It is invoked by the GET HTTP method to a specific URL.
The general form of the URL when call is issued from internal cluster is:
http://<sipxrest_node_host>:6667/cdr/user?fromdate=yyyymmdd&limit=<max # of records to return>
The general form of the URL when call is issued from outside the cluster is:
https://<web_admin_host>/sipxconfig/rest/my/redirect/cdr/user?fromdate=yyyymmdd&limit=<max # of records to return>
URL Parameters:

Property

Description

fromdate

start date from which call records will be retrieved.

limit

maximum number of call log records to return.

Examples:
Using curl, you would initiate a query for the specified user calling records
curl -k --digest -X GET -u 200:123 https://192.168.1.104/sipxconfig/rest/my/redirect/cdr/200?limit=5
It returns first five calling records for the user 200. The call is secured and DIGEST authentication is applied. As wanted, you can perform basic authentication or authenticate against LDAP.
Sample response as follows:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Results>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:1201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-16 09:08:57.713</start_time>
<duration>0 years 0 mons -2 days -23 hours -59 mins -35.811 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"Alejandro 201" <sip:501@domain.com></caller_aor>
<callee_aor>"Buddy 200" <sip:200@external200201.com></callee_aor>
<callee_contact><sip:200@192.168.3.2:15060></callee_contact>
<start_time>2011-01-15 14:14:11.853</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 4.231 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-13 09:08:57.713</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 24.189 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"asd"<sip:201@domain.com></caller_aor>
<callee_aor>"200"<sip:200@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:08:08.724</start_time>
<duration>0 years 0 mons 0 days 0 hours 1 mins 28.431 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:06:15.806</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 31.454 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
</Results>

Anchor
__RefHeading__105965_958082936
__RefHeading__105965_958082936
Retrieve user call logs

Resource URI: cdr/{user}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

fromdate

Start date from which call records will be retrieved.

limit

Maximum number of call log records to return.

Specific Response Codes: N/A
HTTP Method: GET
Get the current call state for any ongoing call between callingUser and calledUser.
Examples: XML format
<Results>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:1201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-16 09:08:57.713</start_time>
<duration>0 years 0 mons -2 days -23 hours -59 mins -35.811 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"Alejandro 201" <sip:501@domain.com></caller_aor>
<callee_aor>"Buddy 200" <sip:200@external200201.com></callee_aor>
<callee_contact><sip:200@192.168.3.2:15060></callee_contact>
<start_time>2011-01-15 14:14:11.853</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 4.231 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-13 09:08:57.713</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 24.189 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"asd"<sip:201@domain.com></caller_aor>
<callee_aor>"200"<sip:200@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:08:08.724</start_time>
<duration>0 years 0 mons 0 days 0 hours 1 mins 28.431 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:06:15.806</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 31.454 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
</Results>
Return Values: list with information on the user ID
Unsupported HTTP Method: POST, PUT, DELETE

Anchor
__RefHeading__29944_153127158
__RefHeading__29944_153127158
View CDR settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /cdrs/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
      1. type

       

      1. entry

       

      1. key

       

    1. Specific Response Codes: N/A
    2. HTTP Method: GET
    3. Retrieves a list with all the CDR settings in the system.
          1. Example: XML format
    4. <Settings>
    5. <Setting>
    6. <path>callresolver/SIP_CALLRESOLVER_LOG_LEVEL</path>
    7. <type>enum</type>
    8. <options>
    9. <entry>
    10. <key>NOTICE</key>
    11. </entry>
    12. <entry>
    13. <key>CRIT</key>
    14. </entry>
    15. <entry>
    16. <key>EMERG</key>
    17. </entry>
    18. <entry>
    19. <key>WARNING</key>
    20. </entry>
    21. <entry>
    22. <key>ERR</key>
    23. </entry>
    24. <entry>
    25. <key>INFO</key>
    26. </entry>
    27. <entry>
    28. <key>ALERT</key>
    29. </entry>
    30. <entry>
    31. <key>DEBUG</key>
    32. </entry>
    33. </options>
    34. <value>NOTICE</value>
    35. <defaultValue>NOTICE</defaultValue>
    36. <label>Logging Level</label>
    37. <description>Creating Call Detail Records (CDRs) and monitoring active calls.</description>
    38. </Setting>
    39. <Setting>
    40. <path>callresolver/SIP_CALLRESOLVER_PURGE</path>
    41. <type>boolean</type>
    42. <value>ENABLE</value>
    43. <defaultValue>ENABLE</defaultValue>
    44. <label>Purge aged records daily</label>
    45. <description>Schedule a daily purge of the CDR database and delete records older than specified below.</description>
    46. </Setting>
    47. <Setting>
    48. <path>callresolver/SIP_CALLRESOLVER_PURGE_AGE_CDR</path>
    49. <type>integer</type>
    50. <value>185</value>
    51. <defaultValue>185</defaultValue>
    52. <label>Purge age for CDRs</label>
    53. <description>If daily purging is enabled, then remove CDRs older than this (in days).</description>
    54. </Setting>
    55. <Setting>
    56. <path>callresolver/SIP_CALLRESOLVER_PURGE_AGE_CSE</path>
    57. <type>integer</type>
    58. <value>7</value>
    59. <defaultValue>7</defaultValue>
    60. <label>Purge age for CSEs</label>
    61. <description>Call State Events (CSEs) are collected in different places in the system and are used to compute system-wide CDRs. Once the CDRs are created, CSEs are no longer needed. They are deleted from the database (if CDR purging is enabled) after the number of days specified here.</description>
    62. </Setting>
    63. <Setting>
    64. <path>callresolver/SIP_CALLRESOLVER_CSE_POLLING_INTERVAL</path>
    65. <type>integer</type>
    66. <value>10</value>
    67. <defaultValue>10</defaultValue>
    68. <label>CSE polling interval</label>
    69. </Setting>
    70. <Setting>
    71. <path>callresolver/SIP_CALLRESOLVER_CALL_DIRECTION</path>
    72. <type>boolean</type>
    73. <value>DISABLE</value>
    74. <defaultValue>DISABLE</defaultValue>
    75. <label>Call direction</label>
    76. <description>Compute call direction. Call direction labels calls as incoming, outgoing, or intra-network based on whether the call came from a PSTN gateway, went to a PSTN gateway, or neither, respectively.</description>
    77. </Setting>
    78. <Setting>
    79. <path>callresolver/SIP_CALLRESOLVER_AGENT_PORT</path>
    80. <type>integer</type>
    81. <value>8130</value>
    82. <defaultValue>8130</defaultValue>
    83. <label>Agent Port</label>
    84. </Setting>
    85. <Setting>
    86. <path>callresolver/SIP_CALLRESOLVER_CSE_QUEUE_SIZE</path>
    87. <type>integer</type>
    88. <value>2500</value>
    89. <defaultValue>2500</defaultValue>
    90. <label>CSE Queue size</label>
    91. </Setting>
    92. <Setting>
    93. <path>callresolver/SIP_CALLRESOLVER_CDR_QUEUE_SIZE</path>
    94. <type>integer</type>
    95. <value>1000</value>
    96. <defaultValue>1000</defaultValue>
    97. <label>CDR Queue size</label>
    98. </Setting>
    99. <Setting>
    100. <path>callresolver/SIP_CALLRESOLVER_MAX_CALL_LEN</path>
    101. <type>integer</type>
    102. <value>28800</value>
    103. <defaultValue>28800</defaultValue>
    104. <label>Maximum call length</label>
    105. </Setting>
    106. <Setting>
    107. <path>callresolver/SIP_CALLRESOLVER_MAX_RINGING_CALL_LEN</path>
    108. <type>integer</type>
    109. <value>120</value>
    110. <defaultValue>120</defaultValue>
    111. <label>Maximum Ringing call length</label>
    112. </Setting>
    113. <Setting>
    114. <path>callresolver/SIP_CALLRESOLVER_MIN_CLEANUP_INTERVAL</path>
    115. <type>integer</type>
    116. <value>300</value>
    117. <defaultValue>300</defaultValue>
    118. <label>Minimum cleanup interval</label>
    119. </Setting>
    120. <Setting>
    121. <path>callresolver/SIP_CALLRESOLVER_REMOTE_ACCESS</path>
    122. <type>string</type>
    123. <label>Remote Access Address</label>
    124. <description>IP Address of remote device(s) that will be granted access to the CDR database. Wildcards (ie. *) can be used in any of the last 3 octects to indicate the full range of addresses. Return the value to default(blank) will turn off remote database access.</description>
    125. </Setting>
    126. </Settings>
      1. JSON format
    127. !!!
    128. Unsupported HTTP Method: PUT, POST, DELETE

    Anchor
    __RefHeading__29946_153127158
    __RefHeading__29946_153127158
    View or modify CDR settings

    1. Available in 14 starting with 14.10
    2. Resource URI: /cdrs/settings/{path}
    3. Default Resource Properties:
    4. The resource is represented by the following properties when the GET request is performed:
      1. Property
      1. Description
      1. path
        1. type

         

        1. value

         

        1. defaultValue

         

        1. label

         

        1. description

         

      1. Specific Response Codes: N/A
      2. HTTP Method: GET
      3. Retrieves CDR options for the setting form the specified path.
            1. Example: XML format
      4. <Setting>
      5. <path>callresolver/SIP_CALLRESOLVER_PURGE_AGE_CSE</path>
      6. <type>integer</type>
      7. <value>7</value>
      8. <defaultValue>7</defaultValue>
      9. <label>Purge age for CSEs</label>
      10. <description>Call State Events (CSEs) are collected in different places in the system and are used to compute system-wide CDRs. Once the CDRs are created, CSEs are no longer needed. They are deleted from the database (if CDR purging is enabled) after the number of days specified here.</description>
      11. </Setting>
      12. Unsupported HTTP Method: POST, PUT, DELETE


      Anchor
      __RefHeading__29948_153127158
      __RefHeading__29948_153127158
      View active all CDRs

      1. Available in 14 starting with 14.10
      2. Resource URI: /cdrs/active
      3. Default Resource Properties:
      4. The resource is represented by the following properties when the GET request is performed:
        1. Property
        1. Description
        1. callee
          1. calleeAor

           

          1. caller

           

          1. duration

           

          1. recipient

           

          1. startAt

           

          1. termination

           

        1. Specific Response Codes: N/A
        2. HTTP Method: GET
        3. Retrieves a list with all the active CDRs in the system.
              1. Example: XML format
        4. <Cdrs>
        5. <Cdr>
        6. <callee>400</callee>
        7. <calleeAor><sip:400@dluca.ezuce.ro;user=phone></calleeAor>
        8. <caller>200</caller>
        9. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        10. <duration>00:00:29</duration>
        11. <recipient>400</recipient>
        12. <startAt>9/12/14 3:32 PM</startAt>
        13. <termination>IN_PROGRESS</termination>
        14. </Cdr>
        15. </Cdrs>
          1. JSON format
        16. {
        17. cdrs:
        18. {
        19. startTime: 1410525150000
        20. caller: "200"
        21. callee: "400"
        22. startAt: "9/12/14 3:32 PM"
        23. connectAt: null
        24. duration: "00:00:13"
        25. callerAor: ""200" <sip:200@dluca.ezuce.ro>"
        26. calleeAor: "<sip:400@dluca.ezuce.ro;user=phone>"
        27. recipient: "400"
        28. termination: "IN_PROGRESS"
        29. callId: null
        30. }-
        31. -
        32. }
        33. Unsupported HTTP Method: PUT, POST, DELETE


        Anchor
        __RefHeading__29950_153127158
        __RefHeading__29950_153127158
        View CDRs history

        1. Available in 14 starting with 14.10
        2. Resource URI: /cdrs/history
        3. Default Resource Properties:
        4. The resource is represented by the following properties when the GET request is performed:
          1. Property
          1. Description

                 

              1. Filtering Parameters:
                1. Parameter
                1. Description
                1. fromDate
                1. Optional. The beginning point in the date range
              2. used to retrieve the history. The format is
              3. yyyyMMddHHmm. If not specified, the date
              4. defaults to yesterday.|
                1. toDate
                1. Optional. The ending point in the date range
              5. used to retrieve the history. The format is
              6. yyyyMMddHHmm. If not specified, the date
              7. defaults to now.|
                1. from
                  1. to

                   

                  1. limit

                  Maximum number of rows with results.

                  1. offset

                   

                  1. orderBy

                  Determines how the results are ordered. Options are:

                • caller
                • callee
                • startTime
                • duration
                • termination|
                1. Specific Response Codes: N/A
                2. HTTP Method: GET
                3. Retrieves the history for all the CDRs in the system that match the filtering parameters.
                      1. Example: XML format
                      2. <Cdrs>
                      3. <Cdr>
                      4. <callId>df01bebf-a9246135-3b09f217@10.5.0.3</callId>
                      5. <callee>300</callee>
                      6. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
                      7. <caller>200</caller>
                      8. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      9. <duration>00:00:00</duration>
                      10. <startAt>9/12/14 3:30 PM</startAt>
                      11. <termination>ABANDONED</termination>
                      12. </Cdr>
                      13. <Cdr>
                      14. <callId>8a9fbbaf-cc747405-b95b7e87@10.5.0.3</callId>
                      15. <callee>400</callee>
                      16. <calleeAor><sip:400@dluca.ezuce.ro;user=phone></calleeAor>
                      17. <caller>200</caller>
                      18. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      19. <connectAt>9/12/14 12:32 PM</connectAt>
                      20. <duration>00:21:05</duration>
                      21. <recipient>400</recipient>
                      22. <startAt>9/12/14 3:32 PM</startAt>
                      23. <termination>COMPLETED</termination>
                      24. </Cdr>
                      25. <Cdr>
                      26. <callId>ebf13b4f-ff161ae5-9261eb27@10.5.0.3</callId>
                      27. <callee>333</callee>
                      28. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
                      29. <caller>200</caller>
                      30. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      31. <duration>00:00:00</duration>
                      32. <startAt>9/12/14 3:54 PM</startAt>
                      33. <termination>FAILED</termination>
                      34. </Cdr>
                      35. <Cdr>
                      36. <callId>fe09178d-9a6adb1f-71d18e55@10.5.0.3</callId>
                      37. <callee>300</callee>
                      38. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
                      39. <caller>200</caller>
                      40. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      41. <connectAt>9/12/14 12:55 PM</connectAt>
                      42. <duration>00:00:16</duration>
                      43. <recipient>300</recipient>
                      44. <startAt>9/12/14 3:54 PM</startAt>
                      45. <termination>TRANSFER</termination>
                      46. </Cdr>
                      47. <Cdr>
                      48. <callId>b7e025d7-88a40c7d-ca5fd5ef@10.5.0.3</callId>
                      49. <callee>300</callee>
                      50. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
                      51. <caller>200</caller>
                      52. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      53. <duration>00:00:00</duration>
                      54. <startAt>9/12/14 3:56 PM</startAt>
                      55. <termination>FAILED</termination>
                      56. </Cdr>
                      57. <Cdr>
                      58. <callId>d8458d6f-6a11d945-137e47@10.5.0.3</callId>
                      59. <callee>333</callee>
                      60. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
                      61. <caller>200</caller>
                      62. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      63. <connectAt>9/12/14 12:57 PM</connectAt>
                      64. <duration>00:00:15</duration>
                      65. <recipient>333</recipient>
                      66. <startAt>9/12/14 3:57 PM</startAt>
                      67. <termination>COMPLETED</termination>
                      68. </Cdr>
                      69. <Cdr>
                      70. <callId>8f14f1e3-404ddc94-f041937@10.5.0.2</callId>
                      71. <callee>*4333</callee>
                      72. <calleeAor><sip:*4333@dluca.ezuce.ro;user=phone></calleeAor>
                      73. <caller>400</caller>
                      74. <callerAor>"400" <sip:400@dluca.ezuce.ro></callerAor>
                      75. <duration>00:00:00</duration>
                      76. <startAt>9/12/14 3:58 PM</startAt>
                      77. <termination>FAILED</termination>
                      78. </Cdr>
                      79. <Cdr>
                      80. <callId>8510150f-b8f09825-53c732e7@10.5.0.3</callId>
                      81. <callee>300</callee>
                      82. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
                      83. <caller>200</caller>
                      84. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      85. <duration>00:00:00</duration>
                      86. <startAt>9/12/14 4:07 PM</startAt>
                      87. <termination>FAILED</termination>
                      88. </Cdr>
                      89. <Cdr>
                      90. <callId>89ad82ff-f22d3df5-38b93857@10.5.0.3</callId>
                      91. <callee>300</callee>
                      92. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
                      93. <caller>200</caller>
                      94. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
                      95. <connectAt>9/12/14 1:09 PM</connectAt>
                      96. <duration>00:01:05</duration>
                      97. <recipient>300</recipient>
                      98. <startAt>9/12/14 4:09 PM</startAt>
                      99. <termination>TRANSFER</termination>
                      100. </Cdr>
                      101. <Cdr>
                      102. <callId>11bffdd3-f7bb6a95-ae713073@10.5.0.4</callId>
                      103. <callee>333</callee>
                      104. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
                      105. <caller>300</caller>
                      106. <callerAor>"300" <sip:300@dluca.ezuce.ro></callerAor>
                      107. <duration>00:00:00</duration>
                      108. <startAt>9/12/14 4:10 PM</startAt>
                      109. <termination>FAILED</termination>
                      110. </Cdr>
                      111. <Cdr>
                      112. <callId>60c91777-98d2a490-4e1dcaeb@10.5.0.2</callId>
                      113. <callee>*4333</callee>
                      114. <calleeAor><sip:*4333@dluca.ezuce.ro;user=phone></calleeAor>
                      115. <caller>400</caller>
                      116. <callerAor>"400" <sip:400@dluca.ezuce.ro></callerAor>
                      117. <connectAt>9/12/14 1:12 PM</connectAt>
                      118. <duration>00:00:09</duration>
                      119. <recipient>*4333</recipient>
                      120. <startAt>9/12/14 4:12 PM</startAt>
                      121. <termination>COMPLETED</termination>
                      122. </Cdr>
                      123. </Cdrs>

                JSON format
                {
                cdrs:
                0: {
                startTime: 1410525010684
                caller: "200"
                callee: "300"
                startAt: "9/12/14 3:30 PM"
                connectAt: null
                duration: "00:00:00"
                callerAor: ""200" <sip:200@dluca.ezuce.ro>"
                calleeAor: "<sip:300@dluca.ezuce.ro;user=phone>"
                recipient: null
                termination: "ABANDONED"
                callId: "df01bebf-a9246135-3b09f217@10.5.0.3"
                }-
                {
                startTime: 1410525150483
                caller: "200"
                callee: "400"
                startAt: "9/12/14 3:32 PM"
                connectAt: "9/12/14 12:32 PM"
                duration: "00:21:05"
                callerAor: ""200" <sip:200@dluca.ezuce.ro>"
                calleeAor: "<sip:400@dluca.ezuce.ro;user=phone>"
                recipient: "400"
                termination: "COMPLETED"
                callId: "8a9fbbaf-cc747405-b95b7e87@10.5.0.3"
                }-
                {
                startTime: 1410526446565
                caller: "200"
                callee: "333"
                startAt: "9/12/14 3:54 PM"
                connectAt: null
                duration: "00:00:00"
                callerAor: ""200" <sip:200@dluca.ezuce.ro>"
                calleeAor: "<sip:333@dluca.ezuce.ro;user=phone>"
                recipient: null
                termination: "FAILED"
                callId: "ebf13b4f-ff161ae5-9261eb27@10.5.0.3"
                }-
                {
                startTime: 1410526499280
                caller: "200"
                callee: "300"
                startAt: "9/12/14 3:54 PM"
                connectAt: "9/12/14 12:55 PM"
                duration: "00:00:16"
                callerAor: ""200" <sip:200@dluca.ezuce.ro>"
                calleeAor: "<sip:300@dluca.ezuce.ro;user=phone>"
                recipient: "300"
                termination: "TRANSFER"
                callId: "fe09178d-9a6adb1f-71d18e55@10.5.0.3"
                }
                }

                1. Unsupported HTTP Method: PUT, POST, DELETE


                Anchor
                __RefHeading__29952_153127158
                __RefHeading__29952_153127158
                View active CDRs for a user ID

                1. Available in 14 starting with 14.10
                2. Resource URI: /cdrs/user/{userId}/active
                3. Default Resource Properties:
                4. The resource is represented by the following properties when the GET request is performed:
                  1. Property
                  1. Description

                         

                      1. Specific Response Codes: N/A
                      2. HTTP Method: GET
                      3. Retrieves a list with the active CDRs for the specified user ID, user name or alias.
                      4. Unsupported HTTP Method: PUT, POST, DELETE

                      Anchor
                      __RefHeading__29954_153127158
                      __RefHeading__29954_153127158
                      View CDRs history for a user ID

                      1. Available in 14 starting with 14.10
                      2. Resource URI: /cdrs/user/{userId}/history
                      3. Default Resource Properties:
                      4. The resource is represented by the following properties when the GET request is performed:
                        1. Property
                        1. Description

                               

                            1. Filtering Parameters:
                              1. Parameter
                              1. Description
                              1. fromDate
                              1. Optional. The beginning point in the date range
                            2. used to retrieve the history. The format is
                            3. yyyyMMddHHmm. If not specified, the date
                            4. defaults to yesterday.|
                              1. toDate
                              1. Optional. The ending point in the date range
                            5. used to retrieve the history. The format is
                            6. yyyyMMddHHmm. If not specified, the date
                            7. defaults to now.|
                              1. from
                                1. to

                                 

                                1. limit

                                Maximum number of results.

                                1. offset

                                 

                                1. orderBy

                                Determines how the results are ordered. Options are:

                              • caller
                              • callee
                              • startTime
                              • duration
                              • termination|
                              1. Specific Response Codes: N/A
                              2. HTTP Method: GET
                              3. Retrieves the history for the CDRs corresponding to the specified user ID, user name or alias.
                                    1. Example:


                              1. Unsupported HTTP Method: PUT, POST, DELETE

                              Anchor
                              __RefHeading__29956_153127158
                              __RefHeading__29956_153127158
                              Download report for all CDRs

                              1. Available in 14 starting with 14.10
                              2. Resource URI: /cdrs/reports/cdr-table
                              3. Default Resource Properties:
                              4. The resource is represented by the following properties when the GET request is performed:
                                1. Property
                                1. Description

                                       

                                    1. Filtering Parameters:
                                      1. Parameter
                                      1. Description
                                      1. fromDate
                                      1. Optional. The beginning point in the date range
                                    2. used to retrieve the history. The format is
                                    3. yyyyMMddHHmm. If not specified, the date
                                    4. defaults to yesterday.|
                                      1. toDate
                                      1. Optional. The ending point in the date range
                                    5. used to retrieve the history. The format is
                                    6. yyyyMMddHHmm. If not specified, the date
                                    7. defaults to now.|
                                      1. from
                                        1. to
                                          1. limit
                                          1. Maximum number of results.
                                          1. offset
                                            1. orderBy
                                            1. Determines how the results are ordered. Options are:
                                          • caller
                                          • callee
                                          • startTime
                                          • duration
                                          • termination|
                                          1. Specific Response Codes: N/A
                                          2. HTTP Method: GET
                                          3. Downloads a report in the PDF format.
                                                1. Example: N/A
                                          4. Unsupported HTTP Method: PUT, POST, DELETE

                                          Anchor
                                          __RefHeading__30092_153127158
                                          __RefHeading__30092_153127158
                                          Download report for CDRs for a user ID

                                          1. Available in 14 starting with 14.10
                                          2. Resource URI: /cdrs/user/{userId}/reports/cdr-table
                                          3. Default Resource Properties: N/A
                                          4. Filtering Parameters:
                                            1. Parameter
                                            1. Description
                                            1. fromDate
                                            1. Optional. The beginning point in the date range. The format is yyyyMMddHHmm. If not specified, the date defaults to yesterday.
                                            1. toDate
                                            1. Optional. The ending point in the date range. The format is yyyyMMddHHmm. If not specified, the date defaults to now.
                                            1. from
                                              1. to
                                                1. limit
                                                1. Maximum number of results?
                                                1. offset
                                                  1. orderBy
                                                  1. Determines how the results are ordered. Options are:
                                                • caller
                                                • callee
                                                • startTime
                                                • duration
                                                • termination|
                                                1. Specific Response Codes: N/A
                                                2. HTTP Method: GET
                                                3. Downloads a report in the PDF format for the specified user ID, user name or alias.
                                                      1. Example: N/A
                                                4. Unsupported HTTP Method: PUT, POST, DELETE


                                                Anchor
                                                __RefHeading__105772_958082936
                                                __RefHeading__105772_958082936
                                                System service

                                                The System Web Service supported are SOAP based services. This service use the Web Service Definition Language (WSDL) to define the interface supported.
                                                URI: https://<host name or address>/sipxconfig/services/SystemService
                                                WSDL:
                                                <wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                                                - <!--
                                                WSDL created by Apache Axis version: 1.4
                                                Built on Apr 22, 2006 (06:55:48 PDT)
                                                -->
                                                <wsdl:types>
                                                <schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
                                                <complexType name="Domain">
                                                <sequence>
                                                <element name="name" type="xsd:string" />
                                                <element name="realm" type="xsd:string" />
                                                <element maxOccurs="unbounded" minOccurs="0" name="aliases" type="xsd:string" />
                                                </sequence>
                                                </complexType>
                                                <complexType name="SystemInfo">
                                                <sequence>
                                                <element name="domain" type="impl:Domain" />
                                                </sequence>
                                                </complexType>
                                                <element name="SystemInfo" type="impl:SystemInfo" />
                                                </schema>
                                                </wsdl:types>
                                                <wsdl:message name="systemInfoRequest" />
                                                <wsdl:message name="systemInfoResponse">
                                                <wsdl:part element="impl:SystemInfo" name="SystemInfo" />
                                                </wsdl:message>
                                                <wsdl:portType name="SystemService">
                                                <wsdl:operation name="systemInfo">
                                                <wsdl:input message="impl:systemInfoRequest" name="systemInfoRequest" />
                                                <wsdl:output message="impl:systemInfoResponse" name="systemInfoResponse" />
                                                </wsdl:operation>
                                                </wsdl:portType>
                                                <wsdl:binding name="SystemServiceSoapBinding" type="impl:SystemService">
                                                <wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
                                                <wsdl:operation name="systemInfo">
                                                <wsdlsoap:operation soapAction="" />
                                                <wsdl:input name="systemInfoRequest">
                                                <wsdlsoap:body use="literal" />
                                                </wsdl:input>
                                                <wsdl:output name="systemInfoResponse">
                                                <wsdlsoap:body use="literal" />
                                                </wsdl:output>
                                                </wsdl:operation>
                                                </wsdl:binding>
                                                <wsdl:service name="ConfigImplService">
                                                <wsdl:port binding="impl:SystemServiceSoapBinding" name="SystemService">
                                                <wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/SystemService" />
                                                </wsdl:port>
                                                </wsdl:service>
                                                </wsdl:definitions>

                                                Anchor
                                                __RefHeading__105774_958082936
                                                __RefHeading__105774_958082936
                                                View system information

                                                Name: systemInfo
                                                Description: Query to provide minimal information about the system.
                                                Input parameters: None
                                                Output parameters:

                                                Name

                                                Value Type

                                                Description

                                                name

                                                string

                                                System name.

                                                realm

                                                string

                                                Domain of the system.

                                                Example: Remove all Call Groups (example: Hunt Groups), Park Orbits and Permissions defined.

                                                Request

                                                <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
                                                <soapenv:Header/>
                                                <soapenv:Body>
                                                <con:ResetServices>
                                                <!-Optional:->
                                                <callGroup>true</callGroup>
                                                <!-Optional:->
                                                <parkOrbit>true</parkOrbit>
                                                <!-Optional:->
                                                <permission>true</permission>
                                                </con:ResetServices>
                                                </soapenv:Body>
                                                </soapenv:Envelope>

                                                Response

                                                N/A


                                                Anchor
                                                __RefHeading__105914_958082936
                                                __RefHeading__105914_958082936
                                                OpenFire

                                                There is currently one XMLRPC APIs available from the sipXopenfire plugin.

                                                Anchor
                                                __RefHeading__105916_958082936
                                                __RefHeading__105916_958082936
                                                Unified presence

                                                XML-RPC presence java clients provided by sipxecs (sipXopenfire project) can be used using the SHARED_SECRET
                                                NOTE: Calls are secured using BASIC Authentication
                                                Example using curl CLI tool to get presence information

                                                Anchor
                                                __RefHeading__105918_958082936
                                                __RefHeading__105918_958082936
                                                Get presence information

                                                Method name: getUnifiedPresenceInfo
                                                Description: This method returns XMPP information being given the sip extension, as described below.
                                                Step 1. Create a file called get-presence.xml with content, replace 200 with the SIP user ID you wish to get presence information on:
                                                <methodCall>
                                                <methodName>presenceServer.getUnifiedPresenceInfo</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>2011</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>
                                                Step 2. Then run this command, replacing mypbx.example.com with the FQDN of your sipXecs system:
                                                curl {color}
                                                -H "Content-Type: application/xml" {color}
                                                -X POST {color}
                                                --data-binary @get-presence.xml {color}
                                                http://<user>:<password>@mypbx.example.com:9094/plugins/sipx-openfire-presence/status

                                                Response example:
                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>custom-presence-message</name>
                                                <value></value>
                                                </member>
                                                <member>
                                                <name>sip-id</name>
                                                <value>2011</value>
                                                </member>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                <member>
                                                <name>unified-presence</name>
                                                <value>available-for-both</value>
                                                </member>
                                                <member>
                                                <name>jabber-id</name>
                                                <value>mirceac@openuc.ezuce.com</value>
                                                </member>
                                                <member>
                                                <name>xmpp-presence</name>
                                                <value>AVAILABLE</value>
                                                </member>
                                                <member>
                                                <name>sip-presence</name>
                                                <value>IDLE</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>
                                                </methodResponse>

                                                Anchor
                                                __RefHeading__105920_958082936
                                                __RefHeading__105920_958082936
                                                Get XMPPU user name

                                                Method name: getXMPPUsername
                                                Description: This method returns the xmpp username being given the email address saved in user-portal: contact information page.

                                                XML Request

                                                <methodCall>
                                                <methodName>presenceServer.getXmppUsername</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac@ezuce.com</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>sip-id</name>
                                                <value>mirceac</value>
                                                </member>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>


                                                Anchor
                                                __RefHeading__105922_958082936
                                                __RefHeading__105922_958082936
                                                Get presence state

                                                Method name: getPresenceState
                                                Description: This method returns the presence state being given the XMPP ID. The string representation of the presence might be: AVAILABLE, AWAY, BUSY, OFFLINE, CHAT, EXTENDED_AWAY.

                                                XML Request

                                                <methodCall>
                                                <methodName>presenceServer.getPresenceState</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                </params>

                                                Response

                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                <member>
                                                <name>xmpp-presence</name>
                                                <value>AVAILABLE</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>
                                                </methodResponse>
                                                </methodCall>


                                                Anchor
                                                __RefHeading__105924_958082936
                                                __RefHeading__105924_958082936
                                                Set presence state

                                                Method name: setPresenceState
                                                Description: This method changes the presence state of the given XMPP user id The xmppPresenceAsString parameter can have the following String representations: AVAILABLE, AWAY, BUSY, OFFLINE, CHAT, EXTENDED_AWAY.

                                                XML Request

                                                ? (String xmppUsername, String xmppPresenceAsString)?
                                                XML to send:
                                                <methodCall>
                                                <methodName>presenceServer.setPresenceState</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                <param>
                                                <value>
                                                <string>AWAY</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                ? (String xmppUsername, String xmppPresenceAsString)?
                                                XML to send:
                                                <methodCall>
                                                <methodName>presenceServer.setPresenceState</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                <param>
                                                <value>
                                                <string>AWAY</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>


                                                If you now call the getPresenceState method it will show you AWAY as xmpp-presence value

                                                Anchor
                                                __RefHeading__105926_958082936
                                                __RefHeading__105926_958082936
                                                Set presence status

                                                Method name: setPresenceStatus
                                                Description: This method sets the given status message of the given XMPP user ID.
                                                (String id, String status)

                                                XML Request

                                                <methodCall>
                                                <methodName>presenceServer.setPresenceStatus</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                <param>
                                                <value>
                                                <string>Here</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>
                                                </methodResponse>



                                                Anchor
                                                __RefHeading__105928_958082936
                                                __RefHeading__105928_958082936
                                                Get presence status

                                                Method name: getPresenceStatus
                                                Description: This method returns the presence status message of the given XMPP user ID.
                                                public Map getPresenceStatus(String id)

                                                XML Request

                                                <methodCall>
                                                <methodName>presenceServer.getPresenceStatus</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>custom-presence-message</name>
                                                <value>Here</value>
                                                </member>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>
                                                </methodResponse>


                                                Anchor
                                                __RefHeading__105930_958082936
                                                __RefHeading__105930_958082936
                                                Ping

                                                Method name: setPresenceState
                                                Description: This method verifies if the XMPP server is running.
                                                (String originatorName)

                                                XML Request

                                                <methodCall>
                                                <methodName>presenceServer.ping</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
                                                <params>
                                                <param>
                                                <value>
                                                <struct>
                                                <member>
                                                <name>status-code</name>
                                                <value>ok</value>
                                                </member>
                                                <member>
                                                <name>instance-handle</name>
                                                <value>of:821711375117195347</value>
                                                </member>
                                                </struct>
                                                </value>
                                                </param>
                                                </params>
                                                </methodResponse>


                                                Anchor
                                                __RefHeading__105932_958082936
                                                __RefHeading__105932_958082936
                                                Register presence monitor

                                                Method name: registerPresenceMonitor
                                                Description: This method registers a listener to be notified when the presence changes.
                                                (String protocol, String serverUrl )

                                                XML Request

                                                ? (String xmppUsername, String xmppPresenceAsString)?
                                                XML to send:
                                                <methodCall>
                                                <methodName>presenceServer.setPresenceState</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                <param>
                                                <value>
                                                <string>AWAY</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>

                                                Response

                                                ? (String xmppUsername, String xmppPresenceAsString)?
                                                XML to send:
                                                <methodCall>
                                                <methodName>presenceServer.setPresenceState</methodName>
                                                <params>
                                                <param>
                                                <value>
                                                <string>mirceac</string>
                                                </value>
                                                </param>
                                                <param>
                                                <value>
                                                <string>AWAY</string>
                                                </value>
                                                </param>
                                                </params>
                                                </methodCall>



                                                Anchor
                                                __RefHeading__41776_184643744
                                                __RefHeading__41776_184643744
                                                Servers

                                                Anchor
                                                __RefHeading__115666_153127158
                                                __RefHeading__115666_153127158
                                                View or add new nodes

                                                1. Resource URI: /servers
                                                2. Default Resource Properties:
                                                3. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. id
                                                  1. Server unique identification number.
                                                  1. host

                                                  Name of the host server.

                                                  1. ip

                                                  The IP address.

                                                  1. primary

                                                  Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

                                                  1. registered

                                                  Displays True if it is a registered server or False if it's not.

                                                  1. description

                                                  Short description provided by the user.

                                                4. Specific Response Codes: N/A
                                                5. HTTP Method: GET
                                                6. Retrieves all configured nodes.
                                                      1. Example: XML format
                                                7. <Servers>
                                                8. <Server>
                                                9. <id>1</id>
                                                10. <host>openuc_1410.ezuce.ro</host>
                                                11. <ip>195.167.1.323</ip>
                                                12. <primary>true</primary>
                                                13. <registered>true</registered>
                                                14. <description>Primary</description>
                                                15. </Server>
                                                16. <Server>
                                                17. <id>2</id>
                                                18. <host>openuc_1410.ezuce.ro</host>
                                                19. <ip>192.492.3.850</ip>
                                                20. <primary>true</primary>
                                                21. <registered>true</registered>
                                                22. <description>secondary</description>
                                                23. </Server>
                                                24. </Servers>
                                                  1. JSON format
                                                25. {
                                                26. Wiki Markup
                                                  servers: \[2\]

                                                27. {
                                                  1. primary: true
                                                28. description: "Primary"
                                                29. host: "openuc_1410.ezuce.ro"
                                                30. id: 1
                                                31. registered: true
                                                      1. ip: "195.167.1.323"
                                                32. {
                                                33. primary: false
                                                34. description: "secondary"
                                                35. host: "openuc_1410.ezuce.ro"
                                                36. id: 2
                                                37. registered: true
                                                38. ip: "192.492.3.850"
                                                39. }-
                                                40. -
                                                41. }
                                                42. HTTP Method: POST
                                                  1. Configures a new node.
                                                43. Unsupported HTTP Method: PUT, DELETE


                                                Anchor
                                                __RefHeading__115668_153127158
                                                __RefHeading__115668_153127158
                                                View or modify nodes for an internal ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. id
                                                  1. Server ID.
                                                  1. host

                                                  Name of the host server.

                                                  1. ip

                                                  The IP address.

                                                  1. primary

                                                  Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

                                                  1. registered

                                                  Displays True if it is a registered server or False if it's not.

                                                  1. description

                                                  Short description provided by the user.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieves nodes for the specified internal ID or host name.
                                                      1. Example: XML format
                                                8. <Server>
                                                9. <id>1</id>
                                                10. <host>openuc_1410.ezuce.ro</host>
                                                11. <ip>195.167.1.323</ip>
                                                12. <primary>true</primary>
                                                13. <registered>true</registered>
                                                14. <description>Primary</description>
                                                15. </Server>
                                                  1. JSON format
                                                16. {
                                                  1. primary: true
                                                17. description: "Primary"
                                                18. host: "openuc_1410.ezuce.ro"
                                                19. id: 1
                                                20. registered: true
                                                      1. ip: "195.167.1.323"
                                                21. {
                                                22. HTTP Method: PUT
                                                  1. Creates a new node node for the specified internal ID or host name.
                                                23. HTTP Method: DELETE
                                                  1. Deletes the node node for the specified internal ID or host name.
                                                24. Unsupported HTTP Method: POST


                                                Anchor
                                                __RefHeading__115670_153127158
                                                __RefHeading__115670_153127158
                                                View node features for an internal ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/features
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                    1. Name of the feature.
                                                    1. bundle

                                                  Name of the bundle taht contains the feature.

                                                    1. type

                                                  Feature type.

                                                    1. enabeled

                                                  Displays True if it is a registered server or False if it's not.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieves nodes for the specified internal ID or host name.
                                                      1. Example: XML format
                                                8. <Features>
                                                9. <features>
                                                10. <name>reports</name>
                                                11. <bundle>core</bundle>
                                                12. <type>location</type>
                                                13. <enabled>false</enabled>
                                                14. </features>
                                                15. <features>
                                                16. <name>dhcpd</name>
                                                17. <bundle>core</bundle>
                                                18. <type>location</type>
                                                19. <enabled>false</enabled>
                                                20. </features>
                                                21. <features>
                                                22. <name>sipxdns</name>
                                                23. <bundle>core</bundle>
                                                24. <type>location</type>
                                                25. <enabled>true</enabled>
                                                26. </features>
                                                27. <features>
                                                28. <name>event</name>
                                                29. <bundle>core</bundle>
                                                30. <type>location</type>
                                                31. <enabled>false</enabled>
                                                32. </features>
                                                33. <features>
                                                34. <name>freeSwitch</name>
                                                35. <bundle>coreTelephony</bundle>
                                                36. <type>location</type>
                                                37. <enabled>false</enabled>
                                                38. </features>
                                                39. <features>
                                                40. <name>authCode</name>
                                                41. <bundle>coreTelephony</bundle>
                                                42. <type>location</type>
                                                43. <enabled>false</enabled>
                                                44. </features>
                                                45. <features>
                                                46. <name>recording</name>
                                                47. <bundle>coreTelephony</bundle>
                                                48. <type>location</type>
                                                49. <enabled>false</enabled>
                                                50. </features>
                                                51. <features>
                                                52. <name>redis</name>
                                                53. <bundle>coreTelephony</bundle>
                                                54. <type>location</type>
                                                55. <enabled>false</enabled>
                                                56. </features>
                                                57. <features>
                                                58. <name>ivr</name>
                                                59. <bundle>coreTelephony</bundle>
                                                60. <type>location</type>
                                                61. <enabled>false</enabled>
                                                62. </features>
                                                63. <features>
                                                64. <name>moh</name>
                                                65. <bundle>coreTelephony</bundle>
                                                66. <type>location</type>
                                                67. <enabled>false</enabled>
                                                68. </features>
                                                69. <features>
                                                70. <name>park</name>
                                                71. <bundle>coreTelephony</bundle>
                                                72. <type>location</type>
                                                73. <enabled>false</enabled>
                                                74. </features>
                                                75. <features>
                                                76. <name>sbcBridge</name>
                                                77. <bundle>coreTelephony</bundle>
                                                78. <type>location</type>
                                                79. <enabled>false</enabled>
                                                80. </features>
                                                81. <features>
                                                82. <name>registrar</name>
                                                83. <bundle>coreTelephony</bundle>
                                                84. <type>location</type>
                                                85. <enabled>false</enabled>
                                                86. </features>
                                                87. <features>
                                                88. <name>sipxcdr</name>
                                                89. <bundle>coreTelephony</bundle>
                                                90. <type>location</type>
                                                91. <enabled>false</enabled>
                                                92. </features>
                                                93. <features>
                                                94. <name>openuc-saa</name>
                                                95. <bundle>coreTelephony</bundle>
                                                96. <type>location</type>
                                                97. <enabled>false</enabled>
                                                98. </features>
                                                99. <features>
                                                100. <name>sipxsqa</name>
                                                101. <bundle>coreTelephony</bundle>
                                                102. <type>location</type>
                                                103. <enabled>false</enabled>
                                                104. </features>
                                                105. <features>
                                                106. <name>callqueue</name>
                                                107. <bundle>coreTelephony</bundle>
                                                108. <type>location</type>
                                                109. <enabled>false</enabled>
                                                110. </features>
                                                111. <features>
                                                112. <name>mwi</name>
                                                113. <bundle>coreTelephony</bundle>
                                                114. <type>location</type>
                                                115. <enabled>false</enabled>
                                                116. </features>
                                                117. <features>
                                                118. <name>homer_web</name>
                                                119. <bundle>coreTelephony</bundle>
                                                120. <type>location</type>
                                                121. <enabled>false</enabled>
                                                122. </features>
                                                123. <features>
                                                124. <name>page</name>
                                                125. <bundle>coreTelephony</bundle>
                                                126. <type>location</type>
                                                127. <enabled>false</enabled>
                                                128. </features>
                                                129. <features>
                                                130. <name>proxy</name>
                                                131. <bundle>coreTelephony</bundle>
                                                132. <type>location</type>
                                                133. <enabled>false</enabled>
                                                134. </features>
                                                135. <features>
                                                136. <name>sipxsss</name>
                                                137. <bundle>coreTelephony</bundle>
                                                138. <type>location</type>
                                                139. <enabled>false</enabled>
                                                140. </features>
                                                141. <features>
                                                142. <name>restServer</name>
                                                143. <bundle>coreTelephony</bundle>
                                                144. <type>location</type>
                                                145. <enabled>false</enabled>
                                                146. </features>
                                                147. <features>
                                                148. <name>conference</name>
                                                149. <bundle>coreTelephony</bundle>
                                                150. <type>location</type>
                                                151. <enabled>false</enabled>
                                                152. </features>
                                                153. <features>
                                                154. <name>homer_capture</name>
                                                155. <bundle>coreTelephony</bundle>
                                                156. <type>location</type>
                                                157. <enabled>false</enabled>
                                                158. </features>
                                                159. <features>
                                                160. <name>mysql</name>
                                                161. <bundle>coreTelephony</bundle>
                                                162. <type>location</type>
                                                163. <enabled>false</enabled>
                                                164. </features>
                                                165. <features>
                                                166. <name>reach</name>
                                                167. <bundle>callCenter</bundle>
                                                168. <type>location</type>
                                                169. <enabled>false</enabled>
                                                170. </features>
                                                171. <features>
                                                172. <name>reach-redis</name>
                                                173. <bundle>callCenter</bundle>
                                                174. <type>location</type>
                                                175. <enabled>false</enabled>
                                                176. </features>
                                                177. <features>
                                                178. <name>instantMessage</name>
                                                179. <bundle>im</bundle>
                                                180. <type>location</type>
                                                181. <enabled>false</enabled>
                                                182. </features>
                                                183. <features>
                                                184. <name>imbot</name>
                                                185. <bundle>im</bundle>
                                                186. <type>location</type>
                                                187. <enabled>false</enabled>
                                                188. </features>
                                                189. <features>
                                                190. <name>dhcpd</name>
                                                191. <bundle>provision</bundle>
                                                192. <type>location</type>
                                                193. <enabled>false</enabled>
                                                194. </features>
                                                195. <features>
                                                196. <name>phonelog</name>
                                                197. <bundle>provision</bundle>
                                                198. <type>location</type>
                                                199. <enabled>false</enabled>
                                                200. </features>
                                                201. <features>
                                                202. <name>hoteling</name>
                                                203. <bundle>provision</bundle>
                                                204. <type>location</type>
                                                205. <enabled>false</enabled>
                                                206. </features>
                                                207. <features>
                                                208. <name>ftp</name>
                                                209. <bundle>provision</bundle>
                                                210. <type>location</type>
                                                211. <enabled>true</enabled>
                                                212. </features>
                                                213. <features>
                                                214. <name>provision</name>
                                                215. <bundle>provision</bundle>
                                                216. <type>location</type>
                                                217. <enabled>false</enabled>
                                                218. </features>
                                                219. <features>
                                                220. <name>tftp</name>
                                                221. <bundle>provision</bundle>
                                                222. <type>location</type>
                                                223. <enabled>true</enabled>
                                                224. </features>
                                                225. </Features>
                                                  1. JSON format
                                                226. {
                                                227. Wiki Markup
                                                  features: \[36\]

                                                228. 0: {
                                                229. bundle: "core"
                                                230. type: "location"
                                                231. enabled: false
                                                232. name: "reports"
                                                233. }-
                                                234. 1: {
                                                235. bundle: "core"
                                                236. type: "location"
                                                237. enabled: false
                                                238. name: "dhcpd"
                                                239. }-
                                                240. 2: {
                                                241. bundle: "core"
                                                242. type: "location"
                                                243. enabled: true
                                                244. name: "sipxdns"
                                                245. }-
                                                246. 3: {
                                                247. bundle: "core"
                                                248. type: "location"
                                                249. enabled: false
                                                250. name: "event"
                                                251. }-
                                                252. 4: {
                                                253. bundle: "coreTelephony"
                                                254. type: "location"
                                                255. enabled: false
                                                256. name: "freeSwitch"
                                                257. }-
                                                258. 5: {
                                                259. bundle: "coreTelephony"
                                                260. type: "location"
                                                261. enabled: false
                                                262. name: "authCode"
                                                263. }-
                                                264. 6: {
                                                265. bundle: "coreTelephony"
                                                266. type: "location"
                                                267. enabled: false
                                                268. name: "recording"
                                                269. }-
                                                270. 7: {
                                                271. bundle: "coreTelephony"
                                                272. type: "location"
                                                273. enabled: false
                                                274. name: "redis"
                                                275. }-
                                                276. 8: {
                                                277. bundle: "coreTelephony"
                                                278. type: "location"
                                                279. enabled: false
                                                280. name: "ivr"
                                                281. }-
                                                282. 9: {
                                                283. bundle: "coreTelephony"
                                                284. type: "location"
                                                285. enabled: false
                                                286. name: "moh"
                                                287. }-
                                                288. 10: {
                                                289. bundle: "coreTelephony"
                                                290. type: "location"
                                                291. enabled: false
                                                292. name: "park"
                                                293. }-
                                                294. 11: {
                                                295. bundle: "coreTelephony"
                                                296. type: "location"
                                                297. enabled: false
                                                298. name: "sbcBridge"
                                                299. }-
                                                300. 12: {
                                                301. bundle: "coreTelephony"
                                                302. type: "location"
                                                303. enabled: false
                                                304. name: "registrar"
                                                305. }-
                                                306. 13: {
                                                307. bundle: "coreTelephony"
                                                308. type: "location"
                                                309. enabled: false
                                                310. name: "sipxcdr"
                                                311. }-
                                                312. 14: {
                                                313. bundle: "coreTelephony"
                                                314. type: "location"
                                                315. enabled: false
                                                316. name: "openuc-saa"
                                                317. }-
                                                318. 15: {
                                                319. bundle: "coreTelephony"
                                                320. type: "location"
                                                321. enabled: false
                                                322. name: "sipxsqa"
                                                323. }-
                                                324. 16: {
                                                325. bundle: "coreTelephony"
                                                326. type: "location"
                                                327. enabled: false
                                                328. name: "callqueue"
                                                329. }-
                                                330. 17: {
                                                331. bundle: "coreTelephony"
                                                332. type: "location"
                                                333. enabled: false
                                                334. name: "mwi"
                                                335. }-
                                                336. 18: {
                                                337. bundle: "coreTelephony"
                                                338. type: "location"
                                                339. enabled: false
                                                340. name: "homer_web"
                                                341. }-
                                                342. 19: {
                                                343. bundle: "coreTelephony"
                                                344. type: "location"
                                                345. enabled: false
                                                346. name: "page"
                                                347. }-
                                                348. 20: {
                                                349. bundle: "coreTelephony"
                                                350. type: "location"
                                                351. enabled: false
                                                352. name: "proxy"
                                                353. }-
                                                354. 21: {
                                                355. bundle: "coreTelephony"
                                                356. type: "location"
                                                357. enabled: false
                                                358. name: "sipxsss"
                                                359. }-
                                                360. 22: {
                                                361. bundle: "coreTelephony"
                                                362. type: "location"
                                                363. enabled: false
                                                364. name: "restServer"
                                                365. }-
                                                366. 23: {
                                                367. bundle: "coreTelephony"
                                                368. type: "location"
                                                369. enabled: false
                                                370. name: "conference"
                                                371. }-
                                                372. 24: {
                                                373. bundle: "coreTelephony"
                                                374. type: "location"
                                                375. enabled: false
                                                376. name: "homer_capture"
                                                377. }-
                                                378. 25: {
                                                379. bundle: "coreTelephony"
                                                380. type: "location"
                                                381. enabled: false
                                                382. name: "mysql"
                                                383. }-
                                                384. 26: {
                                                385. bundle: "callCenter"
                                                386. type: "location"
                                                387. enabled: false
                                                388. name: "reach"
                                                389. }-
                                                390. 27: {
                                                391. bundle: "callCenter"
                                                392. type: "location"
                                                393. enabled: false
                                                394. name: "reach-redis"
                                                395. }-
                                                396. 28: {
                                                397. bundle: "im"
                                                398. type: "location"
                                                399. enabled: false
                                                400. name: "instantMessage"
                                                401. }-
                                                402. 29: {
                                                403. bundle: "im"
                                                404. type: "location"
                                                405. enabled: false
                                                406. name: "imbot"
                                                407. }-
                                                408. 30: {
                                                409. bundle: "provision"
                                                410. type: "location"
                                                411. enabled: false
                                                412. name: "dhcpd"
                                                413. }-
                                                414. 31: {
                                                415. bundle: "provision"
                                                416. type: "location"
                                                417. enabled: false
                                                418. name: "phonelog"
                                                419. }-
                                                420. 32: {
                                                421. bundle: "provision"
                                                422. type: "location"
                                                423. enabled: false
                                                424. name: "hoteling"
                                                425. }-
                                                426. 33: {
                                                427. bundle: "provision"
                                                428. type: "location"
                                                429. enabled: true
                                                430. name: "ftp"
                                                431. }-
                                                432. 34: {
                                                433. bundle: "provision"
                                                434. type: "location"
                                                435. enabled: false
                                                436. name: "provision"
                                                437. }-
                                                438. 35: {
                                                439. bundle: "provision"
                                                440. type: "location"
                                                441. enabled: true
                                                442. name: "tftp"
                                                443. }-
                                                444. -
                                                445. }
                                                446. Unsupported HTTP Method: POST, PUT, DELETE


                                                Anchor
                                                __RefHeading__115672_153127158
                                                __RefHeading__115672_153127158
                                                Enable/disable the location feature

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/features/{featureId}
                                                3. Default Resource Properties: N/A
                                                4. Specific Response Codes: N/A
                                                5. HTTP Method: DELETE
                                                6. Disable location based feature for the specified node.
                                                7. HTTP Method: POST
                                                    1. Enable location based feature for the specified node.
                                                8. Unsupported HTTP Method: GET, POST


                                                Anchor
                                                __RefHeading__115674_153127158
                                                __RefHeading__115674_153127158
                                                View or delete jobs on all servers

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/jobs
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                  1. Job name.
                                                  1. status

                                                  Job status. Possible values are: Completed or Failed.

                                                  1. start

                                                  Start date of the job.

                                                  1. end

                                                  End date of the job.

                                                  1. server

                                                  The server related information is similar to the one described under /servers/{serverId}.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve jobs on all servers.
                                                      1. Example: XML format
                                                8. <Jobs>
                                                9. <Job>
                                                10. <name>Configuration deployment</name>
                                                11. <status>COMPLETED</status>
                                                12. <start>9/8/14 12:34 PM</start>
                                                13. <end>9/8/14 12:34 PM</end>
                                                14. <server>
                                                15. <id>1</id>
                                                16. <host>o14_10.ezuce.ro</host>
                                                17. <ip>192.234.3.788</ip>
                                                18. <primary>true</primary>
                                                19. <registered>true</registered>
                                                20. <description>Primary</description>
                                                21. </server>
                                                22. <errMsg />
                                                23. </Job>
                                                24. <Job>
                                                25. <name>Configuration generation</name>
                                                26. <status>COMPLETED</status>
                                                27. <start>9/8/14 12:36 PM</start>
                                                28. <end>9/8/14 12:36 PM</end>
                                                29. <errMsg />
                                                30. </Job>
                                                31. <Job>
                                                32. <name>Configuration deployment</name>
                                                33. <status>FAILED</status>
                                                34. <start>9/8/14 12:36 PM</start>
                                                35. <end>9/8/14 12:36 PM</end>
                                                36. <server>
                                                37. <id>1</id>
                                                38. <host>o14_10.ezuce.ro</host>
                                                39. <ip>152.667.1.141</ip>
                                                40. <primary>true</primary>
                                                41. <registered>true</registered>
                                                42. <description>Primary</description>
                                                43. </server>
                                                44. <errMsg />
                                                45. </Job>
                                                46. </Jobs>
                                                  1. JSON format
                                                47. {
                                                48. Wiki Markup
                                                  jobs: \[3\]

                                                49. 0: {
                                                50. errMsg: ""
                                                51. server: {
                                                52. primary: true
                                                53. description: "Primary"
                                                54. host: "o14_10.ezuce.ro"
                                                55. id: 1
                                                56. registered: true
                                                57. ip: "192.234.3.788"
                                                58. }-
                                                59. status: "COMPLETED"
                                                60. start: "9/8/14 12:34 PM"
                                                61. end: "9/8/14 12:34 PM"
                                                62. name: "Configuration deployment"
                                                63. }-
                                                64. 1: {
                                                65. errMsg: ""
                                                66. server: null
                                                67. status: "COMPLETED"
                                                68. start: "9/8/14 12:36 PM"
                                                69. end: "9/8/14 12:36 PM"
                                                70. name: "Configuration generation"
                                                71. }-
                                                72. 2: {
                                                73. errMsg: ""
                                                74. server: {
                                                75. primary: true
                                                76. description: "Primary"
                                                77. host: "o14_10.ezuce.ro"
                                                78. id: 1
                                                79. registered: true
                                                80. ip: "152.667.1.141"
                                                81. }-
                                                82. status: "FAILED"
                                                83. start: "9/8/14 12:36 PM"
                                                84. end: "9/8/14 12:36 PM"
                                                85. name: "Configuration deployment"
                                                86. }-
                                                87. -
                                                88. }
                                                89. HTTP Method: DELETE
                                                90. Delete jobs on all servers.
                                                91. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115676_153127158
                                                __RefHeading__115676_153127158
                                                View or delete completed jobs on all servers

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/jobs/completed
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. job
                                                  1. The jobs related information is similar to the one described under /servers/jobs.
                                                          1. server

                                                  The server related information is similar to the one described under /servers/{serverId}.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve completed jobs on all servers.
                                                      1. Example: XML format
                                                8. <Jobs>
                                                9. <Job>
                                                10. <name>Configuration deployment</name>
                                                11. <status>COMPLETED</status>
                                                12. <start>9/8/14 12:34 PM</start>
                                                13. <end>9/8/14 12:34 PM</end>
                                                14. <server>
                                                15. <id>1</id>
                                                16. <host>o14_10.ezuce.ro</host>
                                                17. <ip>192.234.3.788</ip>
                                                18. <primary>true</primary>
                                                19. <registered>true</registered>
                                                20. <description>Primary</description>
                                                21. </server>
                                                22. <errMsg />
                                                23. </Job>
                                                24. <Job>
                                                25. <name>Configuration generation</name>
                                                26. <status>COMPLETED</status>
                                                27. <start>9/8/14 12:36 PM</start>
                                                28. <end>9/8/14 12:36 PM</end>
                                                29. <errMsg />
                                                30. </Job>
                                                31. <Job>
                                                32. </Jobs>
                                                  1. JSON format
                                                33. {
                                                34. errMsg: ""
                                                35. server: {
                                                36. primary: true
                                                37. description: "Primary"
                                                38. host: "o14_10.ezuce.ro"
                                                39. id: 1
                                                40. registered: true
                                                41. ip: "152.667.1.141"
                                                42. }-
                                                43. status: "FAILED"
                                                44. start: "9/8/14 12:36 PM"
                                                45. end: "9/8/14 12:36 PM"
                                                46. name: "Configuration deployment"
                                                47. }-
                                                48. -
                                                49. }
                                                50. HTTP Method: DELETE
                                                51. Delete completed jobs on all servers.
                                                52. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115678_153127158
                                                __RefHeading__115678_153127158
                                                View or delete failed jobs on all servers

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/jobs/failed
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. job
                                                  1. The jobs related information is similar to the one described under /servers/jobs.
                                                          1. server

                                                  The server related information is similar to the one described under /servers/{serverId}.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve failed jobs on all servers.
                                                      1. Example: XML format
                                                8. <jobs>
                                                9. <Job>
                                                10. <name>Configuration deployment</name>
                                                11. <status>FAILED</status>
                                                12. <start>9/8/14 12:36 PM</start>
                                                13. <end>9/8/14 12:36 PM</end>
                                                14. <server>
                                                15. <id>1</id>
                                                16. <host>o14_10.ezuce.ro</host>
                                                17. <ip>152.667.1.141</ip>
                                                18. <primary>true</primary>
                                                19. <registered>true</registered>
                                                20. <description>Primary</description>
                                                21. </server>
                                                22. <errMsg />
                                                23. </Job>
                                                24. </Jobs>
                                                  1. JSON format
                                                25. {
                                                26. Wiki Markup
                                                  jobs: \[1\]

                                                27. 0: {
                                                28. errMsg: ""
                                                29. server: {
                                                30. primary: true
                                                31. description: "Primary"
                                                32. host: "o14_10.ezuce.ro"
                                                33. id: 1
                                                34. registered: true
                                                35. ip: "192.234.3.788"
                                                36. }-
                                                37. ]
                                                38. HTTP Method: DELETE
                                                39. Delete failed jobs on all servers.
                                                40. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115680_153127158
                                                __RefHeading__115680_153127158
                                                View or delete jobs on an internal ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/jobs
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. job
                                                  1. The jobs related information is similar to the one described under /servers/jobs.
                                                          1. server

                                                  The server related information is similar to the one described under /servers/{serverId}.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve jobs on the specified internal ID or host name.
                                                      1. Example: XML format
                                                8. <Jobs>
                                                9. <Job>
                                                10. <name>IMDB regeneration</name>
                                                11. <status>COMPLETED</status>
                                                12. <start>10/13/14 1:31 PM</start>
                                                13. <end>10/13/14 1:31PM</end>
                                                14. <server><id>1</id>
                                                15. <host>openuc-14-10.example.com</host>
                                                16. <ip>192.168.7.110</ip>
                                                17. <primary>true</primary>
                                                18. <registered>true</registered>
                                                19. <description>Primary</description>
                                                20. </server><errMsg></errMsg>
                                                21. </Job>
                                                22. </Jobs>
                                                  1. JSON format
                                                23. {
                                                24. "Jobs": {
                                                25. "Job": {
                                                26. "name": "IMDB regeneration",
                                                27. "status": "COMPLETED",
                                                28. "start": "10/13/14 1:31 PM",
                                                29. "end": "10/13/14 1:31PM",
                                                30. "server": {
                                                31. "id": "1",
                                                32. "host": "openuc-14-10.example.com",
                                                33. "ip": "192.168.7.110",
                                                34. "primary": "true",
                                                35. "registered": "true",
                                                36. "description": "Primary"
                                                37. }
                                                38. }
                                                39. }
                                                40. }
                                                41. HTTP Method: DELETE
                                                42. Delete jobs on the specified internal ID or host name.
                                                43. Unsupported HTTP Method: POST, PUT

                                                Anchor
                                                __RefHeading__115682_153127158
                                                __RefHeading__115682_153127158
                                                View or delete completed jobs on an internal ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/jobs/completed
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. job
                                                  1. The jobs related information is similar to the one described under /servers/jobs.
                                                          1. server

                                                  The server related information is similar to the one described under /servers/{serverId}.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve completed jobs on the specified internal ID or host name.
                                                      1. Example: XML format

                                                  1. JSON format

                                                8. HTTP Method: DELETE
                                                9. Delete completed jobs on the specified internal ID or host name.
                                                10. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115684_153127158
                                                __RefHeading__115684_153127158
                                                View or delete failed jobs on an internal ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/jobs/failed
                                                3. Default Resource Properties: N/A
                                                4. Specific Response Codes:
                                                  Anchor
                                                  __DdeLink__90675_1030667889
                                                  __DdeLink__90675_1030667889
                                                  N/A
                                                5. HTTP Method: GET
                                                6. Retrieve failed jobs on the specified internal ID or host name.
                                                7. HTTP Method: DELETE
                                                8. Delete failed jobs on the specified internal ID or host name.
                                                9. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115686_153127158
                                                __RefHeading__115686_153127158
                                                View all bundles

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/bundles
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                  1. Bundle name.
                                                  1. globalFeature

                                                  List of global features.

                                                  1. locationFeature

                                                  List of location features.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve bundles.
                                                      1. Example: XML format
                                                8. <Bundles>
                                                9. <Bundle>
                                                10. <name>core</name>
                                                11. <GlobalFeatures>
                                                12. <Feature>snmp</Feature>
                                                13. <Feature>sipxlogwatcher</Feature>
                                                14. <Feature>mail</Feature>
                                                15. <Feature>firewall</Feature>
                                                16. <Feature>ntpd</Feature>
                                                17. <Feature>fail2ban</Feature>
                                                18. <Feature>alarms</Feature>
                                                19. </GlobalFeatures>
                                                20. <LocationFeatures>
                                                21. <Feature>reports</Feature>
                                                22. <Feature>dhcpd</Feature>
                                                23. <Feature>sipxdns</Feature>
                                                24. <Feature>event</Feature>
                                                25. </LocationFeatures>
                                                26. </Bundle>
                                                27. <Bundle>
                                                28. <name>coreTelephony</name>
                                                29. <GlobalFeatures>
                                                30. <Feature>intercom</Feature>
                                                31. </GlobalFeatures>
                                                32. <LocationFeatures>
                                                33. <Feature>freeSwitch</Feature>
                                                34. <Feature>authCode</Feature>
                                                35. <Feature>recording</Feature>
                                                36. <Feature>redis</Feature>
                                                37. <Feature>ivr</Feature>
                                                38. <Feature>moh</Feature>
                                                39. <Feature>park</Feature>
                                                40. <Feature>sbcBridge</Feature>
                                                41. <Feature>registrar</Feature>
                                                42. <Feature>sipxcdr</Feature>
                                                43. <Feature>openuc-saa</Feature>
                                                44. <Feature>sipxsqa</Feature>
                                                45. <Feature>callqueue</Feature>
                                                46. <Feature>mwi</Feature>
                                                47. <Feature>homer_web</Feature>
                                                48. <Feature>page</Feature>
                                                49. <Feature>proxy</Feature>
                                                50. <Feature>sipxsss</Feature>
                                                51. <Feature>restServer</Feature>
                                                52. <Feature>conference</Feature>
                                                53. <Feature>homer_capture</Feature>
                                                54. <Feature>mysql</Feature>
                                                55. </LocationFeatures>
                                                56. </Bundle>
                                                57. <Bundle>
                                                58. <name>callCenter</name>
                                                59. <GlobalFeatures />
                                                60. <LocationFeatures>
                                                61. <Feature>reach</Feature>
                                                62. <Feature>reach-redis</Feature>
                                                63. </LocationFeatures>
                                                64. </Bundle>
                                                65. <Bundle>
                                                66. <name>im</name>
                                                67. <GlobalFeatures />
                                                68. <LocationFeatures>
                                                69. <Feature>instantMessage</Feature>
                                                70. <Feature>imbot</Feature>
                                                71. </LocationFeatures>
                                                72. </Bundle>
                                                73. <Bundle>
                                                74. <name>provision</name>
                                                75. <GlobalFeatures />
                                                76. <LocationFeatures>
                                                77. <Feature>dhcpd</Feature>
                                                78. <Feature>phonelog</Feature>
                                                79. <Feature>hoteling</Feature>
                                                80. <Feature>ftp</Feature>
                                                81. <Feature>provision</Feature>
                                                82. <Feature>tftp</Feature>
                                                83. </LocationFeatures>
                                                84. </Bundle>
                                                85. <Bundle>
                                                86. <name>experimental</name>
                                                87. <GlobalFeatures />
                                                88. <LocationFeatures />
                                                89. </Bundle>
                                                90. </Bundles>
                                                  1. JSON format
                                                91. {
                                                92. Wiki Markup
                                                  bundles: \[6\]

                                                93. 0: {
                                                94. Wiki Markup
                                                  locationFeatures: \[4\]

                                                95. 0: "reports"
                                                96. 1: "dhcpd"
                                                97. 2: "sipxdns"
                                                98. 3: "event"
                                                99. -
                                                100. Wiki Markup
                                                  globalFeatures: \[7\]

                                                101. 0: "snmp"
                                                102. 1: "sipxlogwatcher"
                                                103. 2: "mail"
                                                104. 3: "firewall"
                                                105. 4: "ntpd"
                                                106. 5: "fail2ban"
                                                107. 6: "alarms"
                                                108. -
                                                109. name: "core"
                                                110. }-
                                                111. 1: {
                                                112. Wiki Markup
                                                  locationFeatures: \[22\]

                                                113. 0: "freeSwitch"
                                                114. 1: "authCode"
                                                115. 2: "recording"
                                                116. 3: "redis"
                                                117. 4: "ivr"
                                                118. 5: "moh"
                                                119. 6: "park"
                                                120. 7: "sbcBridge"
                                                121. 8: "registrar"
                                                122. 9: "sipxcdr"
                                                123. 10: "openuc-saa"
                                                124. 11: "sipxsqa"
                                                125. 12: "callqueue"
                                                126. 13: "mwi"
                                                127. 14: "homer_web"
                                                128. 15: "page"
                                                129. 16: "proxy"
                                                130. 17: "sipxsss"
                                                131. 18: "restServer"
                                                132. 19: "conference"
                                                133. 20: "homer_capture"
                                                134. 21: "mysql"
                                                135. -
                                                136. Wiki Markup
                                                  globalFeatures: \[1\]

                                                137. 0: "intercom"
                                                138. -
                                                139. name: "coreTelephony"
                                                140. }-
                                                141. 2: {
                                                142. Wiki Markup
                                                  locationFeatures: \[2\]

                                                143. 0: "reach"
                                                144. 1: "reach-redis"
                                                145. -
                                                146. Wiki Markup
                                                  globalFeatures: \[0\]

                                                147. name: "callCenter"
                                                148. }-
                                                149. 3: {
                                                150. Wiki Markup
                                                  locationFeatures: \[2\]

                                                151. 0: "instantMessage"
                                                152. 1: "imbot"
                                                153. -
                                                154. Wiki Markup
                                                  globalFeatures: \[0\]

                                                155. name: "im"
                                                156. }-
                                                157. 4: {
                                                158. Wiki Markup
                                                  locationFeatures: \[6\]

                                                159. 0: "dhcpd"
                                                160. 1: "phonelog"
                                                161. 2: "hoteling"
                                                162. 3: "ftp"
                                                163. 4: "provision"
                                                164. 5: "tftp"
                                                165. -
                                                166. Wiki Markup
                                                  globalFeatures: \[0\]

                                                167. name: "provision"
                                                168. }-
                                                169. 5: {
                                                170. Wiki Markup
                                                  locationFeatures: \[0\]

                                                171. Wiki Markup
                                                  globalFeatures: \[0\]

                                                172. name: "experimental"
                                                173. }-
                                                174. -
                                                175. }
                                                176. HTTP Method: DELETE
                                                177. Delete bundles.
                                                178. Unsupported HTTP Method: POST, PUT

                                                Anchor
                                                __RefHeading__115688_153127158
                                                __RefHeading__115688_153127158
                                                View features for a bundle ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/bundles/{bundleId}
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                  1. Bundle name.
                                                  1. globalFeature

                                                  List of global features.

                                                  1. locationFeature

                                                  List of location features.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve bundles on the specified bundle ID.
                                                      1. Example: XML format
                                                8. <Bundle>
                                                9. <name>im</name>
                                                10. <GlobalFeatures />
                                                11. <LocationFeatures>
                                                12. <Feature>instantMessage</Feature>
                                                13. <Feature>imbot</Feature>
                                                14. </LocationFeatures>
                                                15. </Bundle>
                                                  1. JSON format
                                                16. {
                                                17. Wiki Markup
                                                  locationFeatures: \[2\]

                                                18. 0: "instantMessage"
                                                19. 1: "imbot"
                                                20. -
                                                21. Wiki Markup
                                                  globalFeatures: \[0\]

                                                22. name: "im"
                                                23. }
                                                24. HTTP Method: DELETE
                                                25. Delete bundles on the specified bundle ID.
                                                26. Unsupported HTTP Method: POST, PUT


                                                Anchor
                                                __RefHeading__115690_153127158
                                                __RefHeading__115690_153127158
                                                View global features

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/features
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                  1. Feature name.
                                                  1. bundle

                                                  The bundle containig the feature.

                                                  1. type

                                                  Feature type.

                                                  1. enabled

                                                  The status of the feature. Displays True if it is enabled or False if it is disabled.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieves list of all global features.
                                                      1. Example: XML format
                                                8. <Features>
                                                9. <features>
                                                10. <name>snmp</name>
                                                11. <bundle>core</bundle>
                                                12. <type>global</type>
                                                13. <enabled>true</enabled>
                                                14. </features>
                                                15. <features>
                                                16. <name>sipxlogwatcher</name>
                                                17. <bundle>core</bundle>
                                                18. <type>global</type>
                                                19. <enabled>true</enabled>
                                                20. </features>
                                                21. <features>
                                                22. <name>reports</name>
                                                23. <bundle>core</bundle>
                                                24. <type>location</type>
                                                25. <enabled>false</enabled>
                                                26. </features>
                                                27. <features>
                                                28. <name>mail</name>
                                                29. <bundle>core</bundle>
                                                30. <type>global</type>
                                                31. <enabled>true</enabled>
                                                32. </features>
                                                33. <features>
                                                34. <name>dhcpd</name>
                                                35. <bundle>core</bundle>
                                                36. <type>location</type>
                                                37. <enabled>false</enabled>
                                                38. </features>
                                                39. <features>
                                                40. <name>provision</name>
                                                41. <bundle>provision</bundle>
                                                42. <type>location</type>
                                                43. <enabled>false</enabled>
                                                44. </features>
                                                45. <features>
                                                46. <name>tftp</name>
                                                47. <bundle>provision</bundle>
                                                48. <type>location</type>
                                                49. <enabled>true</enabled>
                                                50. </features>
                                                51. </Features>
                                                  1. JSON format
                                                52. {
                                                53. Wiki Markup
                                                  features: \[44\]

                                                54. 0: {
                                                55. bundle: "core"
                                                56. type: "global"
                                                57. enabled: true
                                                58. name: "snmp"
                                                59. }-
                                                60. {
                                                61. bundle: "core"
                                                62. type: "global"
                                                63. enabled: true
                                                64. name: "sipxlogwatcher"
                                                65. }-
                                                66. {
                                                67. bundle: "core"
                                                68. type: "location"
                                                69. enabled: false
                                                70. name: "reports"
                                                71. }-
                                                72. {
                                                73. bundle: "core"
                                                74. type: "global"
                                                75. enabled: true
                                                76. name: "mail"
                                                77. }-
                                                78. {
                                                79. bundle: "core"
                                                80. type: "location"
                                                81. enabled: false
                                                82. name: "dhcpd"
                                                83. }-
                                                84. {
                                                85. bundle: "core"
                                                86. type: "global"
                                                87. enabled: true
                                                88. name: "firewall"
                                                89. }
                                                90. {
                                                91. bundle: "provision"
                                                92. type: "location"
                                                93. enabled: false
                                                94. name: "provision"
                                                95. }-
                                                96. {
                                                97. bundle: "provision"
                                                98. type: "location"
                                                99. enabled: true
                                                100. name: "tftp"
                                                101. }-
                                                102. -
                                                103. }
                                                104. Unsupported HTTP Method: POST, PUT, DELETE


                                                Anchor
                                                __RefHeading__115692_153127158
                                                __RefHeading__115692_153127158
                                                Delete or modify a global feature

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/features/{featureId}
                                                3. Default Resource Properties: N/A
                                                4. Specific Response Codes: N/A
                                                5. HTTP Method: DELETE
                                                6. Disables the global feature with the specified ID.
                                                7. HTTP Method:
                                                  Anchor
                                                  __UnoMark__171011_375863062
                                                  __UnoMark__171011_375863062
                                                  POST
                                                8. Enables the global feature with the specified ID.
                                                9. Unsupported HTTP Method: GET, POST


                                                Anchor
                                                __RefHeading__115694_153127158
                                                __RefHeading__115694_153127158
                                                View or delete features for a server ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. id
                                                  1. Unique identification number of the server.
                                                  1. host

                                                  Server host.

                                                  1. ip

                                                  IP address.

                                                  1. primary

                                                  Displays True if the server is primary or False if it is not.

                                                  1. registered

                                                  Displays True if the server is registered or False if it is not.

                                                  1. description

                                                  Short description provided by the user.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Retrieve all the features for the specified ID.
                                                      1. Example: XML format
                                                8. <Server>
                                                9. <id>1</id>
                                                10. <host>openuc14_10.ezuce.ro</host>
                                                11. <ip>195.168.5.171</ip>
                                                12. <primary>true</primary>
                                                13. <registered>true</registered>
                                                14. <description>Primary</description>
                                                15. </Server>
                                                  1. JSON format
                                                16. {
                                                17. host: "openuc14_10.ezuce.ro"
                                                18. id: 1
                                                19. description: "Primary"
                                                20. primary: true
                                                21. registered: true
                                                22. ip: "195.168.5.171"
                                                23. }
                                                24. HTTP Method: DELETE
                                                25. Delete all the features for the specified ID.
                                                26. Unsupported HTTP Method: POST, PUT

                                                Anchor
                                                __RefHeading__115696_153127158
                                                __RefHeading__115696_153127158
                                                Enable or disable location for a server ID

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/{serverId}/features/{featureId}
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description
                                                  1. name
                                                  1. Feature name.
                                                  1. bundle

                                                  The bundle containig the feature.

                                                  1. type

                                                  Feature type.

                                                  1. enabled

                                                  The status of the feature. Displays True if it is enabled or False if it is disabled.

                                                5. Specific Response Codes: N/A
                                                6. HTTP Method: GET
                                                7. Enables the feature with the specified ID.
                                                      1. Example: XML format
                                                8. <feature>
                                                9. <name>reports</name>
                                                10. <bundle>core</bundle>
                                                11. <type>location</type>
                                                12. <enabled>false</enabled>
                                                13. </feature>
                                                  1. JSON format
                                                14. {
                                                15. feature
                                                16. {
                                                17. bundle: "core"
                                                18. type: "location"
                                                19. enabled: false
                                                20. name: "reports"
                                                21. }
                                                22. }
                                                23. HTTP Method: DELETE
                                                24. Disables the feature with the specified ID.
                                                25. Unsupported HTTP Method: POST, PUT

                                                Anchor
                                                __RefHeading__115704_153127158
                                                __RefHeading__115704_153127158
                                                View or modify settings

                                                1. Available in 14 starting with 14.10
                                                2. Resource URI: /servers/setting/{pathToService}
                                                3. Default Resource Properties:
                                                4. The resource is represented by the following properties when the GET request is performed:
                                                  1. Property
                                                  1. Description

                                                         

                                                      1. Specific Response Codes: N/A
                                                      2. HTTP Method: GET
                                                      3. Retrieve the settings from the specified setting path.
                                                      4. HTTP Method: PUT
                                                      5. Modify the setting from the specified setting path.
                                                      6. HTTP Method: DELETE
                                                      7. Delete the setting from the specified setting path.
                                                      8. Unsupported HTTP Method: POST, PUT