Veetro Web Service Methods
Click here for a complete list of operations.
EnsureFolder
[Permission: Employee, Credentials: Documents.Files.Create]
Ensures that the specified path exists, returns the existing folder or newly created one
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/EnsureFolder"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<EnsureFolder xmlns="http://schema.veetro.com">
<path>string</path>
</EnsureFolder>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<EnsureFolderResponse xmlns="http://schema.veetro.com">
<EnsureFolderResult>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent xsi:nil="true" />
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</EnsureFolderResult>
</EnsureFolderResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<EnsureFolder xmlns="http://schema.veetro.com">
<path>string</path>
</EnsureFolder>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<EnsureFolderResponse xmlns="http://schema.veetro.com">
<EnsureFolderResult>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent xsi:nil="true" />
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</EnsureFolderResult>
</EnsureFolderResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /xml/EnsureFolder?path=string HTTP/1.1 Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Folder xmlns="http://schema.veetro.com">
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Folder>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/EnsureFolder HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length path=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Folder xmlns="http://schema.veetro.com">
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent>
<FolderID>int</FolderID>
<Name>string</Name>
<Tag>string</Tag>
<Parent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Parent>
<HasShare>boolean</HasShare>
<IsTeamDrive>boolean</IsTeamDrive>
<IsShared>boolean</IsShared>
</Folder>