Web Services

Version 1

    Administrators can view installed Web Services, render them available or unavailable for use, and manage the IP addresses that access a specific web services.

     

    Find the Web Services page

    On the Administrator Panel, under Building Blocks, click Web Services.

     

    Manage the Web Services internal secret

    This secret is used by the web service framework to validate the security of the web service session between calls. It must be between 6 and 128 characters long. Changes are applied immediately. Any connected Proxy Tools must reconnect before continuing.

    1. Click Manage Web Services.
    2. In the Internal Secret field, make the necessary changes.
    3. Click Submit.

     

    Manage availability

    1. Select the check boxes for the appropriate Web Services.
    2. Point to Availability and click Available or Unavailable.

     

    Manage discoverability

    The Discoverability setting determines whether the Web Services Description Language (WSDL) renders upon request. It does not affect the normal operation of the web service.

    1. Select the check boxes for the appropriate Web Services.
    2. Point to Discoverability and click Make Discoverable or Make Not Discoverable.

     

    Manage logging type

    1. Access a web services's contextual menu and click Edit.
    2. In the Select Logging Type, click Off, Common, or Individual
    3. Click Submit.

     

    Note: The common logging sends information to a single file that contains log information for all the web services that use the common logging type. Individual logging sends information to a specific log file for this web service.

     

    Manage IP filters

    IP filters are a list of individual IP addresses or IP address ranges to block or allow. These filters are applied for all access to this web service. These are applied before any per-proxy-tool filters are applied.

    1. Access a web service's contexual menu and click Edit.
    2. In the IP Filters field, type individual IP addresses or a range of IP addresses. Type one address per line.

      Type BLOCK a.b.c.d to block an IP address or range of addresses.
      Type ALLOW a.b.c.d to allow an IP address or range of addresses.
      Wildcards (*) are allowed in any position of the IP address.
      IP address ranges are specified using a slash as follows: a.b.c.d/e.f.g.h

    3. Click Submit.

     

    Manage web service operations

    Administrators can control the level of access for each operation associated with a web service.

    1. Access a web service's contextual menu and click Operations.
    2. Select the appropriate level of access :
      • Permit Any Authorized Access: Select the check boxes for an operation and select this option from the Change Access list. Or select this option in the contextual menu in the Restriction column for the appropriate operation.
      • Permit Tool-Authorized Access: Only web service sessions that were authenticated using the loginTool method are allowed to call the method. Select the check boxes for an operation and select this option from the Change Access list.
      • Block Access: All calls to this method will fail. Select the check boxes for an operation and select this option from the Change Access list. Or select this option in the contextual menu in the Restriction column for the appropriate operation.

     

    View permissions

    Access a web service's contextual menu and click Permissions. To learn more, go to http://www.blackboard.com/Support/Extensions.aspx.

     

    Download documentation

    Access a web service's contextual menu and click Download Documentation. Click OK to download a ZIP file containing the javadocs for this web service.

    Note: This documentation is in the javadoc format for the sake of convenience. The javadocs are provided to describe logical operations and arguments, not to declare an exact method of coding. Client programs can be written in any WSDL enabled language. Use the language-specific syntax to invoke the methods based on the WSDL contract.