Sertifi API Web Service
| Method | /testsite/Services/Gateway.asmx/AddLocation |
| Method | /testsite/Services/Gateway.asmx/AddLocation |
| Sertifi API Web Service > All Operations Resource Group : /testsite/Services/Gateway.asmx/AddLocation (Method) |
The request body is of type AddLocation.
| Name | Description | Data Type |
|---|---|---|
| pstr_APICode | The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings. | xml:string |
| pstr_FileID | The id of the relevant file. | xml:string |
| pstr_DocumentID | The id of the relevant document. | xml:string |
| pint_Page | The page of the pdf to add the location. | xml:int |
| pint_Top | The distance from the top of the page to the top edge of the signing location. | xml:int |
| pint_Left | The distance from the left side of the page to the left edge of the signing location. | xml:int |
| pint_Height | Pass '0'. Unused, but still required. | xml:int |
| pint_Width | Pass '0'. Unused, but still required. | xml:int |
| pstr_SignerEmail | The email address of the signer who needs to sign in this location. | xml:string |
| pstr_Caption | The text prompt that should appear in the large or small text boxes. | xml:string |
| pint_FieldType | A number indicating the type of field to add. | xml:int |
| sequence | The signer level | xml:int |
The response body is of type AddLocationResponse.
| Name | Description | Data Type |
|---|---|---|
| AddLocationResult | "SUCCESS" or error message. | xml:string |
Field Type ids:
Full name = 1
Initials = 2
Small text box = 4
Large signature box = 7
Payment authorization location = 10
Payment authorization with address = 11
Custom text box - Date = 13
Custom text box - Time = 14
Custom - Large Text Box = 23
Custom text box - Company = 33
Custom text box - Title = 43
Common Errors include:
"ERROR: Invalid API Code"
"ERROR: Invalid page number."
"ERROR: Invalid top coordinates."
"ERROR: Invalid left coordinates."
"ERROR: Invalid signer email"
"ERROR: Invalid signer email: ..."
"ERROR: File could not be accessed"
"ERROR: Document could not be accessed"
"ERROR: Document Expired"
"ERROR: SignerEmail not valid"
"ERROR: <pstr_SignerEmail> is not a signer at level <sequence>"
"ERROR: Signer sequence ambiguous. Sequence must be included for this signer and document."
"ERROR: Signing locations can only be added for signers of a document."
"ERROR: Signing locations can only be added to unsigned signature requests"
"ERROR: Could not remove an existing large signature box before adding a new one"
"ERROR: Invalid LocationType"