Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Expand
titleOpening the Web Service List window

To open

...

the Web Service List

...

 window:

...

  1. Select System > Web Service Maintenance

...

  1.  from the SynWeb main menu.

...

  1. The Web Service List

...

  1.  window is displayed.

...

  1. Image Added


Web Service List window key fields and buttons
Buttons

O_34990 Image Removed

Button

Description

AnchorO_34990

Image Added

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

AnchorO_34991O_34991 Image Removed

Image Added

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

AnchorH_34974H_34974 (on page ). AnchorO_34981O_34981 Image Removed

.

Image Added

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

AnchorH_34973H_34973 (on page )

.

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

Image Removed

Image Added

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

Image RemovedImage RemovedImage Removed O_30356 Image Removed

Image AddedImage AddedImage Added

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

AnchorO_30356O_34532O_34532 Image Removed
  • Image Added - web service method has not been authorised
AnchorO_34979 Image Removed
  • Image Added - web service method has been authorised
AnchorO_34979
  • Image Added - web service authorisation is invalid.
AnchorO_34978O_34978 Image Removed

Image Added

Send test emails or SMSes to logged in users.

AnchorO_30341O_30341 Image Removed

Image Added

Edit this web service method version.

AnchorO_32210O_32210 Image Removed

Image Added

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.