Skip to end of metadata
Go to start of metadata

Overview

Returns a list of announcement audio files for an announcement type.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
eidStringEnvironment ID of the tenant we are looking forMandatory

Response

Parameters of the API response:

ParameterType

Description

workflowsList<Workflow>List of available approval workflows
returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
    • ERROR_TOO_MANY_RESULT

Examples

 Example ListWorkflows transaction.
Example ListWorkflows 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:listWorkflows>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
         <eid>0000</eid>
      </v3:listWorkflows>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listWorkflowsResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <workflows>
               <autoApprove>true</autoApprove>
               <description>This workflow is intended to be used by Compliance Officers to generate an Audit Log event of their actions.</description>
               <eid>0000</eid>
               <enabled>true</enabled>
               <existsRequest>false</existsRequest>
               <id>1004</id>
               <name>Auto-Approve workflow for Compliance Officers</name>
               <notifTemplateId>3</notifTemplateId>
               <notifTemplateLang>en</notifTemplateLang>
               <priority>20</priority>
            </workflows>
            <workflows>
               <autoApprove>false</autoApprove>
               <description/>
               <eid>0000</eid>
               <enabled>true</enabled>
               <existsRequest>true</existsRequest>
               <id>1</id>
               <name>Basic Approval Workflow</name>
               <notifTemplateId>3</notifTemplateId>
               <notifTemplateLang>en</notifTemplateLang>
               <priority>10</priority>
            </workflows>
            <workflows>
               <autoApprove>false</autoApprove>
               <description>This workflow is for external compliance officers who request access on a case-by-case basis.</description>
               <eid>0000</eid>
               <enabled>true</enabled>
               <existsRequest>true</existsRequest>
               <id>2</id>
               <name>External investigator access</name>
               <notifTemplateId>3</notifTemplateId>
               <notifTemplateLang>en</notifTemplateLang>
               <priority>5</priority>
            </workflows>
            <workflows>
               <autoApprove>false</autoApprove>
               <description>2-step workflow for most users. Request sent to local manager first. Upon escalating it is sent to the Global Compliance Office.</description>
               <eid>0000</eid>
               <enabled>true</enabled>
               <existsRequest>false</existsRequest>
               <id>1002</id>
               <name>Standard company workflow</name>
               <notifTemplateId>3</notifTemplateId>
               <notifTemplateLang>en</notifTemplateLang>
               <priority>10</priority>
            </workflows>
            <workflows>
               <autoApprove>false</autoApprove>
               <description>3-step workflow designed for attorneys' requests in the US. First goes to the Line Manager for review without approval right. If escalated, it lands of the desk of the Department Head. Upon further Escalation, the Global Compliance Office will make a decisison.</description>
               <eid>0000</eid>
               <enabled>true</enabled>
               <existsRequest>false</existsRequest>
               <id>1003</id>
               <name>US-specific attorney workflow</name>
               <notifTemplateId>3</notifTemplateId>
               <notifTemplateLang>en</notifTemplateLang>
               <priority>30</priority>
            </workflows>
         </return>
      </ns2:listWorkflowsResponse>
   </S:Body>
</S:Envelope>