Sertifi API Web Service
Method/testsite/Services/Gateway.asmx/AddReferenceDocumentFromLibrary
Request (AddReferenceDocumentFromLibrarySoapIn)

The request body is of type AddReferenceDocumentFromLibrary.

Request Body Parameters

NameDescriptionData Type
pstr_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
pstr_FileIDThe id of the relevant file.xml:string
pstr_LibraryIdThe Id of the document in the Reference Document Section of your Sertifi Document Library.xml:string
pstr_TitleThe name the document will appear with to signers.xml:string
returnIdWhether or not to return the Id of the document in the file. (It will be different from the Library Id and specific to the version in this file.)xml:boolean
permissionsPermissions on who can view the reference document.ArrayOfReferenceDocumentPermission
customMetadataXMLPrefill XML.  Data that to fill into fields in the document that's specific to this file.xml:string
customMetadataXML Element Action Element Role Element Sequence Element Email Element Sequence ReferenceDocumentPermission Element Sequence permissions Element returnId Element pstr_Title Element pstr_LibraryId Element pstr_FileID Element pstr_APICode Element Sequence AddReferenceDocumentFromLibrary Element
Response (AddReferenceDocumentFromLibrarySoapOut)

The response body is of type AddReferenceDocumentFromLibraryResponse.

Response Body Parameters

NameDescriptionData Type
AddReferenceDocumentFromLibraryResultId of the reference document for the file, "SUCESS" or an error message.xml:string
AddReferenceDocumentFromLibraryResult Element Sequence AddReferenceDocumentFromLibraryResponse Element
Remarks

Common Errors include:
"ERROR: Invalid API Code"
"ERROR: Title cannot be empty or null"
"ERROR: Title cannot be exceed 100 characters"
"ERROR: File could not be accessed"
"ERROR: Room Expired"
"ERROR: Invalid SEQUENCE in permissions, CC's sequence should equal to zero"
"ERROR: Invalid SEQUENCE in permissions, sequence should be >= zero and less than 255 for signers"
"ERROR: Invalid EMAIL in permissions: ..."
"ERROR: could not parse custom metadata"
"ERROR: Could not fetch reference document from the library."

See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.