Sertifi API Web Service
Set a document's parameters.
Request (SetDocumentParametersSoapIn)

The request body is of type SetDocumentParameters.

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_DocumentIDThe id of the relevant document.xml:string

XML of parameters to change.

Currently the valid list is:
 changeExpiredStatus (accepts values 'expire', 'unexpire')

p_XMLContent Element p_DocumentID Element p_FileID Element p_ApiCode Element Sequence SetDocumentParameters Element
Response (SetDocumentParametersSoapOut)

The response body is of type SetDocumentParametersResponse.

Response Body Parameters

NameDescriptionData Type
SetDocumentParametersResult"SUCCESS" or error message.xml:string
SetDocumentParametersResult Element Sequence SetDocumentParametersResponse Element
<soap:Envelope xmlns:soap="" xmlns:ser="">
         <ser:p_XMLContent><![CDATA[<?xml version='1.0' encoding='UTF-8' ?><document><parameter name='externalid1' value='123222' /><parameter name='externalid2' value='123232' /></document>]]></ser:p_XMLContent>
Common Errors include:
"ERROR: Invalid API Code"
"ERROR: File could not be accessed."
"ERROR: Document could not be accessed"
"ERROR: Invalid API code for the Document id."
"ERROR: Document id does not match the File id."
"ERROR: Invalid parameter attributes."
"ERROR: invalid value in one of externalid parameters."
"ERROR: invalid value in changeExpiredStatus parameter."
"ERROR: Invalid ... value."
"ERROR: Invalid XML."
"ERROR: cannot update external id and expiration status in the same call."
"ERROR: Error saving the document."
"ERROR: Error updating the document."
"ERROR: Document remained unchanged."
See Also
All Operations Resource GroupSertifi API Web Service



© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.