On This Page:

Related Pages:

The sp2:GetPromSetsRequest API method allows the details of Promise Sets to be retrieved.

Description

The sp2:GetPromSetsRequest API method allows the details of Promise Sets and their associated time bands as set up in ServiceScheduling to be retrieved.

Definition

The definition of this API is:

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp2:GetPromSetsRequest>`
	`<promSets>`			An optional array of one or more `<promSet>` values. When not included, all Promise Sets defined will be returned. When set, at least one `<promSet>` value must be included.	No
		`<promSet>?</promSet>`	`PromSetID`	A specific Promise Set ID, which when included in the <promSets> array, will be included in the response.	No	Yes
	`</promSets>`
`</sp2:GetPromSetsRequest>`

Return Structure

The API returns a non-standard return structure.

Click here to expand...

Web Service						Type	Description
`<sp2:GetPromSetsResponse>`
	`<result>`						A structure containing details of the success or failure of the API call.
		`<type>?</type>`				`string`	The Return Code name, representing the result of the API call.
		`<code>?</code>`				`int`	The Return Code number, representing the result of the API call.
	`</result>`
	`<promSets>`						A structure containing one or more `<promSet>` elements.
		`<promSet>`					A structure representing a single Promise Set.
			`<id>?</id>`			`PromSetID`	The ID of the Promise Set.
			`<bands>`				A structure containing one or more `<band>` elements.
				`<band>`			A structure representing a single Promise Set band.
					`<id>?</id>`	`TimeBandID`	The ID of the Promise Set band.
					`<start>?</start>`	`sp2:spTime`	The start time of the Promise Set band, in `HH:MM` format.
					`<end>?</end>`	`sp2:spTime`	The end time of the Promise Set band, in `HH:MM` format.
					`<desc>?</desc>`	`sp2:BandDescName`	The description of the Promise Set band.
				`</band>`
			`</bands>`
		`</promSet>`
	`</promSets>`
`</sp2:GetPromSetsResponse>`

Return Codes

In addition to the Integration ServiceOptimizer Common Standard Return Codes, the possible Integration ServiceOptimizer Common Return Codes from this API are:

SP_OK (0)

Browser not supported