Sertifi API Web Service
Method/testsite/Services/Gateway.asmx/GetLink
Description
Get a link to a specific page as a specific user.
Request (GetLinkSoapIn)

The request body is of type GetLink.

Request Body Parameters

NameDescriptionData Type
p_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
parametersAn array of link parameters to for the desired links.ArrayOfLinkParameter
Value Element Name Element Sequence NameValuePair Element Sequence AdditionalProperties Element SignerEmail Element LinkType Element PaymentId Element DocumentId Element FileId Element Sequence LinkParameter Element Sequence parameters Element p_APICode Element Sequence GetLink Element
Response (GetLinkSoapOut)

The response body is of type GetLinkResponse.

Response Body Parameters

NameDescriptionData Type
GetLinkResultList of links or error message.ArrayOfUrlQueryResult
SignerEmail Element LinkType Element DocumentId Element FileId Element Link Element Error Element Sequence UrlQueryResult Element Sequence GetLinkResult Element Sequence GetLinkResponse Element
Example
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/" xmlns:lin="https://apps.sertifi.net/services/LinkParameter">
   <soap:Header/>
   <soap:Body>
      <ser:GetLink>
         <ser:p_APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:p_APICode>
         <ser:parameters>
            <!--Zero or more repetitions:-->
            <ser:LinkParameter>
               <!--Optional:-->
               <lin:FileId>d4pA7tZhuGA=</lin:FileId>
               <!--Optional:-->
               <lin:DocumentId>vqUbZIRdBq4=</lin:DocumentId>
               <lin:LinkType>PrintablePdfLink</lin:LinkType>
               <!--Optional:-->
               <lin:SignerEmail>[email protected]</lin:SignerEmail>
            </ser:LinkParameter>
         </ser:parameters>
      </ser:GetLink>
   </soap:Body>
</soap:Envelope>
Remarks

Link types:
DocumentEditLocationsLink - Return link to edit document locations page only if document belongs to given room and is not signed
    Parameters: FileId, DocumentId
DocumentOriginalLink - Return link to original document only if document belongs to given room and its not expired
    Parameters: FileId, DocumentId, SignerEmail*
DocumentSignedLink - Return link to signed document only if document belongs to given room and is totally signed
    Parameters: FileId, DocumentId, SignerEmail*
DocumentPartiallySignedLink - Return link to partially signed document link if document belongs to given room and is partially signed
    Parameters: FileId, DocumentId, SignerEmail*
DocumentPrefillLink - Return link to edit document prefill page only if document belongs to given room and is not signed
    Parameters: FileId, DocumentId
DocumentPropertiesLink - Return link to the document management page only if document belongs to given room
    Parameters: FileId, DocumentId
FileMaintenanceLink - Return link to file maintenance page
    Parameters: FileId
FileSigningPageLink - Return link to file page containing list of links to sign for given user and his sequence
    Parameters: FileId, SignerEmail*
SigningPageLink - Return link to document signing page if the document belongs to the file and is ready to be signed by the signer
    Parameters: FileId, DocumentId, SignerEmail*
SecureSendingPageLink - Return a link to the sending page if the user is allowed to send files/documents on this site
    Parameters: SignerEmail*
SecureFileMaintenanceLink - Return link to file maintenance page
    Parameters: FileId
SecureFileSigningPageLink - Return link to file page containing list of links to sign for given user and his sequence
    Parameters: FileId, SignerEmail*
SecureDocumentOriginalLink - Return link to original document only if document belongs to given room and its not expired
    Parameters: FileId, DocumentId, SignerEmail*
SecureDocumentSignedLink - Return link to signed document only if document belongs to given room and is totally signed
    Parameters: FileId, DocumentId, SignerEmail*
SecureHomePageLink - Return a link to the user's home page on this site
    Parameters: SignerEmail
SecureDocumentPrefillLink - Return link to edit document prefill page only if document belongs to given room and is not signed
    Parameters: SignerEmail*
SecureDocumentPartiallySignedLink - Return link to partially signed document link if document belongs to given room and is partially signed
    Parameters: FileId, DocumentId, SignerEmail*
PrintablePdfLink - Return a link to the printable version of the document
    Parameters: None
SecurePaymentLink - Return a link to a specific payment's collection page
    Parameters: FileId, PaymentId, SignerEmail*
PaymentReceiptLink - Return a secure link to a payment receipt page
    Parameters: FileId, PaymentId, SignerEmail*

Common Errors include:
"ERROR: Invalid API Code"
"File could not be accessed."
"Document could not be accessed."
"Document is expired."
"Signer email is invalid. "
"Signer is not a part of the file."
"... is not an allowed sender for this account."
"... is not allowed to make changes to this folder."
"Form is deleted or not yet created, please try different document."
"Document Prefill link is not available for this document."

Notes:
Secure links are one-use only and expire after 5 minutes.
*SignerEmail parameters always refer to the user that should be using the link.  This is often but not always a signer.

See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.