Document toolboxDocument toolbox

Integration ServiceOptimizer Get Responsibility Units SOAP API

On This Page:

Related Pages:

The sp:GetRespUnitsRequest API method can be used to obtain a list of responsibility units.

Description

The sp:GetRespUnitsRequest API method returns a set of responsibility units in the array RespUnits.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:GetRespUnitsRequest>

 

 

 

 

 

<ParentRespUnit>?</ParentRespUnit>

RUID

if this is not supplied, all Final Responsibility Units (FRUs) will be returned; if this is the ID of an FRU, all its constituent IRUs will be returned

(error)

(tick)

 

<PrevRespUnit>?</PrevRespUnit>

RUID

is the start point for each batch; it should not be set for the first batch.

(error)

(tick)

 

<RespUnitCount>?</RespUnitCount>

int

is the number of Responsibility Units which will be returned in each batch if you wish to impose a limit. Leave unset if no limit is to be applied.

(error)

 

</sp:GetRespUnitsRequest>

 

 

 

 

Return Structure

The API returns a non-standard return structure.

Web Service

Type

Description

Req?

Val?

<sp:GetRespUnitsResponse>

 

 

 

 

 

<PrevRespUnit>?</PrevRespUnit>

RUID

The last FRU returned if not all have yet been returned

 

 

 

<RespUnitCount>?</RespUnitCount>

int

The number of FRUs returned

 

 

 

<RespUnits>?</RespUnits>

RUID

The set of FRUs

 

 

</sp:GetRespUnitsResponse>

 

 

 

 

Return Codes

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

  • SP_OK (0)
  • SP_UNIT_INVALID (28)