GetStorageFolderById (v2)

Overview

Returns a Storage Folder information by id.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter	Type	Description	Requirements

Parameter	Type	Description	Requirements
token	String	API authentication token	Mandatory
id	Integer	The requested Storage Policy's id	Mandatory

Response

Parameters of the API response in GetStorageFolderById type called return:

Parameter	Type	Description

Parameter	Type	Description
status	Status	Possible return values:
storageFolder	StorageFolder

Examples

Example GetStorageFolderById transaction.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:getStorageFolderById>
         <token>z5bqHedL87j39ntkv4ZLt4yVCGeA26B9</token>
         <id>2</id>
      </v2:getStorageFolderById>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStorageFolderByIdResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <storageFolder>
               <certPublic/>
               <eid>0000</eid>
               <emailTls>false</emailTls>
               <exportTarget>false</exportTarget>
               <exportTargetEveryone>true</exportTargetEveryone>
               <id>2</id>
               <name>Amazon S3 TEST</name>
               <path>verbatest</path>
               <serverName>eu-west-1</serverName>
               <storageType>amazon_s3</storageType>
               <userLogin>..................</userLogin>
               <userPassword>........................................</userPassword>
            </storageFolder>
         </return>
      </ns2:getStorageFolderByIdResponse>
   </S:Body>
</S:Envelope>

Example GetStorageFolderById transaction with bad id in the request.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:getStorageFolderById>
         <token>jA994tlI4jS6kbb4ENvKYThglekdi2wz</token>
         <id>4</id>
      </v2:getStorageFolderById>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStorageFolderByIdResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <message>No such Storage Target:  id=4</message>
               <statusCode>ERROR_NOT_FOUND</statusCode>
            </status>
         </return>
      </ns2:getStorageFolderByIdResponse>
   </S:Body>
</S:Envelope>