Sertifi API Web Service
Method/testsite/Services/Gateway.asmx/SetRedirectURL
Description
Sets a URL that the signing page should redirect to when a signer signs the document.
Request (SetRedirectURLSoapIn)

The request body is of type SetRedirectURL.

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
p_FileIDThe id of the relevant file.xml:string
p_redirectUrlThe Url to redirect to.xml:string
redirectActionsA list of cases which should result in a redirection to that URL.  (Sign, Decline, or Reassign)ArrayOfRedirectOnAction
RedirectOnAction Element Sequence redirectActions Element p_redirectUrl Element p_FileID Element p_APICode Element Sequence SetRedirectURL Element
Response (SetRedirectURLSoapOut)

The response body is of type SetRedirectURLResponse.

Response Body Parameters

NameDescriptionData Type
SetRedirectURLResult"SUCCESS" or error message.xml:string
SetRedirectURLResult Element Sequence SetRedirectURLResponse Element
Example
Sample Call:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header/>
   <soap:Body>
      <ser:SetRedirectURL>
         <ser:p_APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:p_APICode>
         <ser:p_FileID>XlhsT3KlhAs=</ser:p_FileID>
         <ser:p_redirectUrl>www.sertifi.com</ser:p_redirectUrl>
         <ser:redirectActions>
            <!--Zero or more repetitions:-->
            <ser:RedirectOnAction>Sign</ser:RedirectOnAction>
         </ser:redirectActions>
      </ser:SetRedirectURL>
   </soap:Body>
</soap:Envelope>
Remarks

Only one redirect url can be set per file.

Common Errors include:
"ERROR: Invalid API Code"
"ERROR: Invalid URL. Cannot be empty or greater than 500 characters."
"ERROR: File could not be accessed"
"ERROR: Room Expired"

See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.