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

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /rules/{ruleId}
  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. name

       

      1. enabeled

       

      1. type

       

      1. description

       

      1. permissions

       

      1. hatewayAware

       

      1. authorizationChecked

       

      1. internal

       

      1. pstnPrefixOptional

       

      1. longDistancePrefixOptional

       

      1. externalLen

       

      1. optionalPrefix

       

      1. emergencyNumber

       

      1. afterHoursAttendantEnabled

       

      1. enableLiveAttendant

       

    1. Specific Response Codes: N/A
    2. HTTP Method: GET
    3. View the description for the specified schedule ID.
          1. Example: XML format
    4. <Rules>
    5. <Rule>
    6. <id>1</id>
    7. <name>Emergency</name>
    8. <enabled>false</enabled>
    9. <type>Emergency</type>
    10. <description>Emergency dialing plan</description>
    11. <permissions />
    12. <gatewayAware>true</gatewayAware>
    13. <authorizationChecked>true</authorizationChecked>
    14. <internal>false</internal>
    15. <pstnPrefixOptional>false</pstnPrefixOptional>
    16. <longDistancePrefixOptional>false</longDistancePrefixOptional>
    17. <externalLen>0</externalLen>
    18. <optionalPrefix>9</optionalPrefix>
    19. <emergencyNumber>911</emergencyNumber>
    20. <afterHoursAttendantEnabled>false</afterHoursAttendantEnabled>
    21. <enableLiveAttendant>false</enableLiveAttendant>
    22. </Rule>
    23. <Rule>
    24. <id>2</id>
    25. <name>International</name>
    26. <enabled>false</enabled>
    27. <type>Long_Distance</type>
    28. <description>International dialing</description>
    29. <permissions />
    30. <gatewayAware>true</gatewayAware>
    31. <authorizationChecked>true</authorizationChecked>
    32. <internal>false</internal>
    33. <pstnPrefix />
    34. <pstnPrefixOptional>false</pstnPrefixOptional>
    35. <longDistancePrefix>011</longDistancePrefix>
    36. <longDistancePrefixOptional>false</longDistancePrefixOptional>
    37. <areaCodes />
    38. <externalLen>-1</externalLen>
    39. <afterHoursAttendantEnabled>false</afterHoursAttendantEnabled>
    40. <enableLiveAttendant>false</enableLiveAttendant>
    41. </Rule>
    42. </Rules>
      1. JSON format

    {

    Wiki Markup
    rules: \[8\]


    0: {
    id: 1
    name: "Emergency"
    enabled: false
    type: "Emergency"
    description: "Emergency dialing plan"
    scheduleId: null
    permissions: {

    Wiki Markup
    names: \[0\]


    }-
    gatewayAware: true
    authorizationChecked: true
    internal: false
    mediaServerHostname: null
    mediaServerType: null
    dialPatterns: null
    callPattern: null
    pstnPrefix: null
    pstnPrefixOptional: false
    longDistancePrefix: null
    longDistancePrefixOptional: false
    areaCodes: null
    externalLen: 0
    optionalPrefix: "9"
    emergencyNumber: "911"
    afterHoursAttendant: null
    afterHoursAttendantEnabled: false
    holidayAttendant: null
    workingTimeAttendant: null
    holidayAttendantPeriods: null
    workingTimeAttendantPeriods: null
    extension: null
    attendantAliases: null
    did: null
    enableLiveAttendant: false
    }-
    1: {
    id: 2
    name: "International"
    enabled: false
    type: "Long_Distance"
    description: "International dialing"
    scheduleId: null
    permissions: {

    Wiki Markup
    names: \[0\]


    }-
    gatewayAware: true
    authorizationChecked: true
    internal: false
    mediaServerHostname: null
    mediaServerType: null
    dialPatterns: null
    callPattern: null
    pstnPrefix: ""
    pstnPrefixOptional: false
    longDistancePrefix: "011"
    longDistancePrefixOptional: false
    areaCodes: ""
    externalLen: -1
    optionalPrefix: null
    emergencyNumber: null
    afterHoursAttendant: null
    afterHoursAttendantEnabled: false
    holidayAttendant: null
    workingTimeAttendant: null
    holidayAttendantPeriods: null
    workingTimeAttendantPeriods: null
    extension: null
    attendantAliases: null
    did: null
    enableLiveAttendant: false
    }-
    2: {
    id: 3
    name: "Local"
    enabled: false
    type: "Long_Distance"
    description: "Local dialing"
    scheduleId: null
    permissions: {

    Wiki Markup
    names: \[0\]


    }-
    gatewayAware: true
    authorizationChecked: true
    internal: false
    mediaServerHostname: null
    mediaServerType: null
    dialPatterns: null
    callPattern: null
    pstnPrefix: "9"
    pstnPrefixOptional: false
    longDistancePrefix: ""
    longDistancePrefixOptional: true
    areaCodes: ""
    externalLen: 7
    optionalPrefix: null
    emergencyNumber: null
    afterHoursAttendant: null
    afterHoursAttendantEnabled: false
    holidayAttendant: null
    workingTimeAttendant: null
    holidayAttendantPeriods: null
    workingTimeAttendantPeriods: null
    extension: null
    attendantAliases: null
    did: null
    enableLiveAttendant: false
    }
    }

    1. HTTP Method: PUT
    2. Update the description for the specified rule.
    3. HTTP Method: POST
    4. Create a new rule.
    5. HTTP Method: DELETE
        1. Delete the specified rule.
    6. Unsupported HTTP Method: N/A