ListInvitations

ListInvitations

This method returns a list of invitations associated with the indicated document.

URI

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

Input Parameters

name type comment
handshake string Authentication token
id int ID of the saved copy
type DocumentType Type of document
max int Indicates how many invitations should be returned at most
skip int Indicates how many invitations should be skipped from the search result when return

Returns

Returns a list of invitations related with the Template or Document (depending on type param) indicated by id. This method returns the items paginated by using max and skip parameters.

REST

<?xml version="1.0" encoding="utf-8" ?>
<ServiceResultOfListOfInvitationDescriptor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Failed>false</Failed>
    <Result>
        <InvitationDescriptor>
            <InvitationID>211</InvitationID>
            <LinkedDocumentID>192</LinkedDocumentID>
            <LinkedDocumentType>Blank</LinkedDocumentType>
            <InviteeEmail>johnsmith@gmail.com</InviteeEmail>
            <CreationDate>2012-03-04T02:31:00.217</CreationDate>
            <ExpirationDate>2012-04-08T22:29:35.987</ExpirationDate>
        </InvitationDescriptor>
    </Result>
</ServiceResultOfListOfInvitationDescriptor>

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

SOAP

Returns ServiceResult<List<InvitationDescriptor>>

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