GetSignatureImage

  • Method

    SlimCD.Transact.GetSignatureImage

    Purpose

    Retrieves a bitmap version of the vector signature.

    Description

    Upon success, GetSignatureImage returns a status code of 200, a content-type based on the type of image requested, and binary data that represents the image. Supported image types include PNG, JPG, BMP, ICON, TIFF. In the case of an error, the content type is set to text/plain, the body contains text representing the error, the HTTP status code us set to an error code (not 200) and status text to represent the error.

    Business Rules

    Link to something

    Argument List

    Name Required Usage
    CreateSessionRequest Required Object containing properties for the request
    timeout Optional Integer wait time, in seconds, before timeout response is generated
    callback* Optional Function to call upon completion of asynchronous request

    *for JavaScript only

    Request Fields

    Field Name Type Length Required Description
    UserName string 20 require Username or API Access Credential that accesses web service.
    Password string 20 require Plaintext password for the client account.
    GateID integer 12 require Gateway ID for previous transaction.
    FileType string varies require represents type of data ID for previous transaction.
    Width
    Height
    PenWidth
    Transparent
    Edge
    Border
    Testmode

    1 Passwords are required except when the username is set to an API Access Credential, in which case it should be passed in as an empty string.

    Reply Fields

    reply outer tag for the reply data block
    response Success, FAIL, Error
    response code 0, 1, 2 (respective) matching the above
    description If successful, this will contain the single word, OK. Otherwise it will contain a description of failure or error which occurred .
    reponseurl The Slimcd.com url which was called for this operation .
    datablock The confirmation text returned from the server.

    Reply Hierarchy

    • reply
      • response
      • responsecode
      • description
      • responseurl
      • datablock

    Remarks

    • General
      1. Names in name/value pairs are NOT case-sensitive
      2. Names inside XML tags ARE case-sensitive
    • Function-Specific
      1. None
  • Include

    Method

    Request

    Reply

    Sample Code

    Downloads

    Download full sample source.


     

  • Include

    Method

    Request

    JSON Reply

    Sample Code

    Downloads

    Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference: Client

    Sample Code

    Downloads

    Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference: Client

    Sample Code

    Downloads

    Download full sample source.


  • INCLUDE

    Method

    Request

    Reply


  • Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

     


  • URL

    Protocols

        • SOAP/XML
        • HTTP POST
        • HTTP GET

    Request


    This sample shows the name/value pairs that would be send with HTTP POST

    Reply Output is in XML format.

    Status Codes

    Status Code Status Description Explanation
    200 200 OK All CloseBatch attempts will return XML with this response.
    500 500 Internal Server Error The response will not contain XML, as a server error has occurred.

    Sample Code

    code

    [/tabs]
    Remarks

    • JSON (based on content-type)

    Downloads

    ONLINE EXERCISER TOOL

  • URL

    Protocols

    • HTTP POST
    • HTTP GET

    This function accepts either name/value pairs or JSON

    Request

    Reply

    Sample Code


    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    The sample above shows the use jQuery cross-domain POST with jsonp, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another json data item

    The sample above shows the use jQuery cross-domain POST with name/value pairs, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another name/value pair

    Remarks

    1. None