Secured Signing API

<back to all web services

FormFieldsRequest

The following routes are available for this service:
GET/FormDirect/GetPredefinedFormFields/{FormReference}Gets predefined fields for a single formGets a single form. Returns a collection of signers required for signing the forms.
FormFieldsRequest Parameters:
NameParameterData TypeRequiredDescription
FormReferencepathstringYesForm reference
FormFieldResponse Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<FormField>No
LastUpdateTimeformstringNoDate of last update
FormField Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
DisplayNameformstringNo
FieldTypeformHTMLElementTypeNo
FiledValueformstringNo
ValueOptionsformList<string>No
ClientFieldformstringNo
ClientMappingformintNo
HTMLElementType Enum:
NameValue
Text0
MultiLineText1
CheckBox3
RadioButton4
DropDownList5
DateInput6

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /FormDirect/GetPredefinedFormFields/{FormReference} HTTP/1.1 
Host: api.securedsigning.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFieldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <Fields xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:FormField>
      <d2p1:ClientField>String</d2p1:ClientField>
      <d2p1:ClientMapping>0</d2p1:ClientMapping>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:FieldType>Text</d2p1:FieldType>
      <d2p1:FiledValue>String</d2p1:FiledValue>
      <d2p1:ValueOptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:ValueOptions>
    </d2p1:FormField>
  </Fields>
  <LastUpdateTime>String</LastUpdateTime>
</FormFieldResponse>