ListTemplates

ListTemplates

Search for templates using the searchPattern string. If the searching string is contained on any attribute of some template then that template will be returned. The max and skip parameters are used for pagination.

URI

https://www.fillanypdf.com/api/rest/ListTemplates

Input Parameters

name type comment
handshake string Authentication token
searchpattern string Text to used find templates
max int Indicates how many templates should be returned at most
skip int Indicates how many templates should be skipped from the search result when return

Returns

All templates matching the searchPattern string, skipping skip templates, and taking at most max templates.

REST

<?xml version="1.0" encoding="utf-8" ?>
<ServiceResultOfListOfTemplateDescriptor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Failed>false</Failed>
    <Result>
        <TemplateDescriptor>
            <TemplateID>238</TemplateID>
            <Pages>4</Pages>
            <Name>TestM5</Name>
            <Revision/>
            <Number/>
            <Notes/>
            <Active>true</Active>
        </TemplateDescriptor>
        <TemplateDescriptor>
            <TemplateID>239</TemplateID>
            <Pages>2</Pages>
            <Name>LastTemplate</Name>
            <Revision/>
            <Number/>
            <Notes/>
            <Active>true</Active>
        </TemplateDescriptor>
        <TemplateDescriptor>
            <TemplateID>240</TemplateID>
            <Pages>4</Pages>
            <Name>TestM5 - 1</Name>
            <Revision/>
            <Number/>
            <Notes/>
            <Active>true</Active>
        </TemplateDescriptor>
    </Result>
</ServiceResultOfListOfTemplateDescriptor>

In case of an error, the Result is returned empty (null) and the field Error is populated with the error message.

SOAP

Returns <List<TemplateDescriptor>>

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License