/testsite/Services/Gateway.asmx/SetDocumentParameters (Method)

Description

Set a document's parameters.

Request (SetDocumentParametersSoapIn)

The request body is of type SetDocumentParameters.

Request Body Parameters

Name	Description	Data Type
p_ApiCode	The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings.	xml:string
p_FileID	The id of the relevant file.	xml:string
p_DocumentID	The id of the relevant document.	xml:string
p_XMLContent	XML of parameters to change. Currently the valid list is: externalid1 externalid2 externalid3 changeExpiredStatus (accepts values 'expire', 'unexpire')	xml:string

Response (SetDocumentParametersSoapOut)

The response body is of type SetDocumentParametersResponse.

Response Body Parameters

Name	Description	Data Type
SetDocumentParametersResult	"SUCCESS" or error message.	xml:string

Example

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:SetDocumentParameters>
         <ser:p_ApiCode>88F54943-115A-4BD7-B325-52262BCA2F98</ser:p_ApiCode>
         <ser:p_FileID>d4pA7tZhuGA=</ser:p_FileID>
         <ser:p_DocumentID>vqUbZIRdBq4=</ser:p_DocumentID>
         <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>
      </ser:SetDocumentParameters>
   </soap:Body>
</soap:Envelope>

Remarks

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."