Services and Operations

Services and Operations

This section describes the services and operations available in SirsiDynix Symphony Web Services.

Each topic will contain a synopsis about the operation. The synopsis explains the operation namespace and defines any prerequisite information needed to execute the operation. Each topic also outlines information about request parameters and describes what elements will be returned in the operation response.

For each operation request, you will see the following information in a table:

Heading

Description

Parameter

Lists all the request parameters for the operation.

Type

Lists the data type of each request parameter for the operation. These are links to topics that describe the data type in detail (for more information, see Data types reference).

Description

Offers a brief description for each request parameter in the operation.

Required?

Specifies whether or not each request parameter is required for the operation request. Y means the request parameter is required; N means the request parameter is optional.

For each operation response, you will see the following information in a table:

Heading

Description

Element

Lists all the response elements for the operation.

Type

Lists the data type of each response element for the operation. These are links to topics that describe the data type in detail (for more information, see Data types reference).

Occ.

Specifies the minimum and maximum number of times the element can occur (or be returned) in the operation response. This is the format: <minimum>..<maximum>.

For example, if the element occured a minimum of 0 and was returned a maximum of 1, you would see “0..1”.

If the element always occurs once, but only once, you will see “1”.

Description

Offers a brief description for each response element in the operation.

Some request parameters and element responses are a choice pair. This means that in a request, you will need to specify only one of the parameters (not both), and in a response, only one element will be returned (not both). Choices are specified for your convenience.

This section contains these topics:

 


© 2009-2012 SirsiDynix