GetStorageFolderByName (v3)

Overview

Returns a Storage Folder information by name.

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
eid	String	The requested Storage Folder's eid	Mandatory
name	String	The requested Storage Folder's name	Mandatory

Response

Parameters of the API response in GetStorageFolderByName type called return:

Parameter	Type	Description
status	Status	Possible return values: OK ERROR_GENERAL ERROR_ILLEGAL_ARGUMENT ERROR_UNAUTHORIZED ERROR_NOT_FOUND
StorageFolder	StorageFolder

Examples

Example GetStorageFolderByName transaction.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:getStorageFolderByName>
         <token>h0QNnaRB5dX5RXJUlcmiFT9MpKX2VPZTz</token>
         <eid>0000</eid>
         <name>Amazon S3 TEST</name>
      </v3:getStorageFolderByName>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStorageFolderByNameResponse xmlns:ns2="http://v3.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>AKIAIDR3I26OLTLTJVKA</userLogin>
               <userPassword>HR3Q74zh93GiU/T0FTFm0syhdfZereaIVLaZxuDN/drsOKVb2CuUBjoK8LeDn0ab</userPassword>
            </storageFolder>
         </return>
      </ns2:getStorageFolderByNameResponse>
   </S:Body>
</S:Envelope>

Example GetStorageFolderByName transaction with bad name in the request.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:getStorageFolderByName>
         <token>jA994tlI4jS6kbb4ENvKYThglekdi2wz</token>
         <eid>0000</eid>
         <name>NotExists</name>
      </v3:getStorageFolderByName>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getStorageFolderByNameResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <message>No such Storage Target:  {ENVIRONMENT: eid=0000 (exact)} name=EWS</message>
               <statusCode>ERROR_NOT_FOUND</statusCode>
            </status>
         </return>
      </ns2:getStorageFolderByNameResponse>
   </S:Body>
</S:Envelope>