GET api/signature?includeCompleted={includeCompleted}

Get a list of pending or completed signatures

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeCompleted

Include completed signatures

 boolean

Default value is False

Body Parameters

None.

Remarks

None.

Example

//Gets a list of signature requests
http://localhost/api/signature

Response Information

Resource Description

List of signatures pending or compeleted

PagedSignatureResponse
NameDescriptionTypeAdditional information
SignatureResponse

Collection of SignatureResponse

None.
TotalPages

Total number of pages.

 integer

None.
NextPage

Link to the next page.

 string

None.
PreviousPage

Link to the previous page.

 string

None.
LastPage

Link to the last page.

 string

None.
FirstPage

Link to the first page.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "SignatureResponse": [
    {
      "Id": "sample string 1",
      "Type": "sample string 2",
      "Name": "sample string 3",
      "ImageBase64": "sample string 4"
    },
    {
      "Id": "sample string 1",
      "Type": "sample string 2",
      "Name": "sample string 3",
      "ImageBase64": "sample string 4"
    }
  ],
  "TotalPages": 1,
  "NextPage": "sample string 2",
  "PreviousPage": "sample string 3",
  "LastPage": "sample string 4",
  "FirstPage": "sample string 5"
}

application/xml, text/xml

Sample: 
<PagedSignatureResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Signature">
  <FirstPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 5</FirstPage>
  <LastPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 4</LastPage>
  <NextPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 2</NextPage>
  <PreviousPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 3</PreviousPage>
  <TotalPages xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">1</TotalPages>
  <SignatureResponse>
    <SignatureResponse>
      <Id>sample string 1</Id>
      <ImageBase64>sample string 4</ImageBase64>
      <Name>sample string 3</Name>
      <Type>sample string 2</Type>
    </SignatureResponse>
    <SignatureResponse>
      <Id>sample string 1</Id>
      <ImageBase64>sample string 4</ImageBase64>
      <Name>sample string 3</Name>
      <Type>sample string 2</Type>
    </SignatureResponse>
  </SignatureResponse>
</PagedSignatureResponse>