Previous icon

Next icon

Creating web service methods

To create a web service method:

  1. Select System > Web Service Maintenance from the SynWeb main menu.

    The Web Service List window is displayed.

    Web Service List (synweb, populated)

  2. Click Create New Web Service button (synweb).

    The Web Service view of the Create Web Service Method window is displayed.

    Create Web Service Method window - Web Service (synweb, populated)

  3. Type in the Method Name, and a Summary of the method.

    Note: Web service names should start with a U. For example, UGetStudentDetails.

  4. Click Next button (synweb).

    The Version view of the Create Web Service Method window is displayed.

    Create Web Service Method window - Version (synweb, populated)

  5. Type the Version number.

    Note: Each version of a web service method must have a unique version number.

  6. Select the Synergetic database the web service method connects to in the Database Name field.
  7. Select the Stored Procedure from the database the web service method uses.
  8. Add a Version Comment to note any changes you have made to the details in this version.
  9. Click Next button (synweb).

    The Parameters view of the Create Web Service Method window is displayed.

    Create Web Service Method window - Parameters (synweb, populated)

  10. Select the fields the web service method uses as parameters.
  11. Type in a Default value to be used when no value is passed to the web service method.
  12. Type in a Description to indicate why the parameter is required.
  13. Select Read Only if no value but the default should be passed to the web service method.
  14. Click Next button (synweb).

    The Output view of the Create Web Service Method window is displayed.

    Create Web Service Method window - Output (synweb, populated)

  15. Select the database columns that the web service method returns.
  16. Click Next button (synweb).

    Review the web service method and either click:

    The web service method is displayed in the Web Service List window. See Web Service List window.

Last modified: 23/09/2014 5:11:44 PM

See Also

Configuring custom web services

Requesting authorisation from Synergetic

Testing web service methods

Web Service List window

© 2016 Synergetic Management Systems. Published 19 September 2016.

Top of page