Previous icon

Next icon

Web Service List window

You can configure custom web services to interface with aspects of Synergetic using the Web Service List window.

Opening the Web Service List window

Web Service List window key fields and buttons

Buttons

Button

Description

Download Help Document button (synweb)

Download a generated help document of the xml for your web service methods for development.

Synchronise Authorisation button (synweb)

Synchronise the authorisation status of all web service methods. See Requesting authorisation from Synergetic.

Create New Web Service button (synweb)

Create a new web service method. See Creating web service methods.

Grid area fields

Field

Description

Seq

Code identifying the web service method.

Name

Name of the web service method.

Summary

Description of the web service method.

ExpiryDate

Date the authorisation expires.

Active

If Active, this web service can currently integrate with Synergetic.

Grid area buttons

Button

Description

Delete icon (red circle with minus) (synweb)

Delete this web service method.

Service method grid area fields

Each version of a web service method has its own grid entry.

Field

Description

Seq

Code identifying the web service method.

Version No

The version of the web service method.

Database Name

Name of the database the web service method accesses.

Stored Procedure

Name of the stored procedure the web service method accesses.

Output Columns

Name of the database columns the web service method returns.

Version Comments

Comment on this version of the web service method.

Service method grid area buttons

Button

Description

Authorisation

Cancel icon (red cross, synweb)Green tick button (synweb)Warning button (red triangle, synweb)

Indicates the authorisation status of this method with Synergetic. Click to send an authorisation request.

  • Cancel icon (red cross, synweb) - web service method has not been authorised
  • Green tick button (synweb) - web service method has been authorised
  • Warning button (red triangle, synweb) - web service authorisation is invalid.

Search (magnify on document)(synweb)

Send test emails or SMSes to logged in users.

Edit icon (pencil, Synweb)

Edit this web service method version.

Delete icon (red circle with minus) (synweb)

Delete this web service method version.

Service method parameter grid area fields

Each parameter used by the web service method has its own grid entry within that version grid entry of the web service method.

Field

Description

Seq

Code identifying the web service method parameter.

Name

Name of the database value.

Value

Default value to pass if no value is provided to the parameter.

SqlDbType

Data type of the parameter.

Length

Length of the parameter.

Direction

Whether the parameter is:

  • input - sent in for use by the database
  • output - returned by the database.

Read Only

Select if this parameter cannot be changed when the web service method is run. For example, if a default value is provided and you do not want a different value passed.

Description

Description of the web service method parameter.

Last modified: 13/08/2014 8:05:07 AM

See Also

Configuring custom web services

Creating web service methods

Requesting authorisation from Synergetic

Testing web service methods

© 2016 Synergetic Management Systems. Published 19 September 2016.

Top of page