pp108 : GetProcedureInfo

GetProcedureInfo


This Web service operation is used to retrieve metadata information about all procedures of a particular catalog.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetProcedureInfo xmlns="http://schemas.cordys.com/WS-AppServer/1.0">
            <procedureName>CustOrdersOrders</procedureName>
            <procedureCatalog>Northwind</procedureCatalog>
            <procedureSchema>dbo</procedureSchema>
        </GetProcedureInfo>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Tags

Description

procedureName

Denotes the name of the procedure for which metadata information is retrieved; if this is empty or not specified, the metadata information is received for all the procedures.

procedureCatalog

Denotes the name of the catalog from which the procedure information should be extracted; if this is not mentioned, the information is retrieved from all the catalogs.

procedureSchema

Denotes the schema defined in the database; in SQL, this denotes the name of the owner of the database, that is, dbo.


SOAP Response

<data>
    <GetProcedureInfoResponse
        xmlns="http://schemas.cordys.com/WS-AppServer/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <tuple>
            <old>
                <Procedures>
                    <ProcedureInfo>
                        <procedureCatalog>Northwind</procedureCatalog>
                        <procedureSchema>dbo</procedureSchema>
                        <procedureName>CustOrdersOrders;1</procedureName>
                        <description/>
                        <procedureType>FUNCTION</procedureType>
                        <parameters>
                            <parameter>
                                <paramName>@RETURN_VALUE</paramName>
                                <dataType>i4</dataType>
                                <position>0</position>
                                <paramType>RETURN</paramType>
                            </parameter>
                            <parameter>
                                <paramName>@CustomerID</paramName>
                                <dataType>string</dataType>
                                <position>1</position>
                                <size>5</size>
                                <paramType>INPUT</paramType>
                            </parameter>
                        </parameters>
                    </ProcedureInfo>
                </Procedures>
            </old>
        </tuple>
    </GetProcedureInfoResponse>
</data>

Response Parameters

Tags

Description

parameter

The details of a specific parameter of the procedure

paramName

The name of the parameter. By default, @ is prefixed to the name.

dataType

The data type of the parameter

position

Indicates the order in which the parameters have to be passed while invoking the procedure. 1 refers to the first parameter, 2 to the second parameter, and so on. The position is 0 if the paramType is 'RETURN'.

size

Indicates the length of the parameter (no. of characters long) and it applies to parameters of data type String.

paramType

Indicates whether the parameter is an INPUT or OUTPUT or INOUT (both input and output) parameter.