Services Integration Framework Guide

10.5

Back Next

GetOrsList

retrieves a list of the Operational Record Stores (ORS) registered in the master database.

Required Parameters

The

GetOrsList

request does not have any required parameters. The ORS ID is not required because this API request operates on the master database.

Response Fields

The

GetOrsList

response can contain the information described in the following table:

Field	Description
MetaDataOrs	Contains the display name, the physical name, and the ID of the ORS. Each ORS in the list is represented by a MetaDataOrs object.

Use Case

The following scenarios are common uses of the

GetOrsList

API:

Retrieve the list of ORS databases to display them for selection in a custom client application.

Retrieve the ORS ID to use as an input using MetaDataOrs.getOrsId() in subsequent calls where the ORS ID is required but is not hard-coded.

GetOrsList Request Usage Example

The following example gets the list of all registered ORS databases:

GetOrsListRequest request = new GetOrsListRequest();
GetOrsListResponse response = (GetOrsListResponse)sipClient.process(request);

GetOrsList Response Usage Example

The following example displays the returned list of all registered ORS databases:

for(Iterator iter=response.getOrsList().iterator(); iter.hasNext();) {
//iterate through response records
MetaDataOrs ors = (MetaDataOrs) iter.next();
System.out.println("ORS Display Name"+ ors.getDisplayName());
System.out.println(" Physical name" + ": " + ors.getName());
System.out.println(" ORS Id" + ": " + ors.getOrsId());
};

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

GetOrsList

GetOrsList

Required Parameters

Response Fields

Use Case

GetOrsList Request Usage Example

GetOrsList Response Usage Example