/
ListSites (v3)

ListSites (v3)

Overview

Returns a list of sites.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory

Response

Parameters of the API response:

ParameterType

Description

sitesList<Site>List of available approval workflows
returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_UNAUTHORIZED
    • ERROR_TOO_MANY_RESULT

Examples

 Example ListSites transaction.
Example ListSites 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:listSites>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
      </v3:listSites>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listSitesResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <sites>
               <description>Test purpose</description>
               <id>76FA85F2-924E-45A3-9C2A-40293AA30FE5</id>
               <name>Test site</name>
               <settingsJSON>{}</settingsJSON>
               <siteGroup>false</siteGroup>
            </sites>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:listSitesResponse>
   </S:Body>
</S:Envelope>
                



Related content

ListWorkflows (v3)
ListWorkflows (v3)
More like this
ListExtensionRules (v3)
ListExtensionRules (v3)
More like this
GetEnvironmentByEid (v2)
GetEnvironmentByEid (v2)
More like this
GetEnvironmentByEid (v3)
GetEnvironmentByEid (v3)
More like this
GetEnvironmentByShortName (v2)
GetEnvironmentByShortName (v2)
More like this
ListUsers (v2)
More like this