GET api/FormFileSignatures/search?patientExternalId={patientExternalId}&signatureDateUtcOperator={signatureDateUtcOperator}&signatureDateUtc1={signatureDateUtc1}&signatureDateUtc2={signatureDateUtc2}&page={page}&itemPerPage={itemPerPage}

Returns a list of form files signed by patients.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientExternalId

Unique external ID of the patient.

string

None.

signatureDateUtcOperator

Signature date operator a form file signature's comparison operators. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith

string

Default value is empty string ("")

signatureDateUtc1

Signature date that is signed a form file.

date

None.

signatureDateUtc2

Second signature date that is signed a form file.

date

None.

page

Page number requested (search results are paginated).

integer

Default value is 1

itemPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfFormFileSignatureModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of FormFileSignatureModel

None.

Response Formats

application/json, text/json

Sample:
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "formFileSignatureId": 1,
      "formFileId": 2,
      "formFileName": "sample string 3",
      "formFileFileName": "sample string 4",
      "patientFullName": "sample string 5",
      "patientBirthday": "2026-05-29T16:59:21.5509607+00:00",
      "patientExternalId": "sample string 6",
      "signatureDate": "2026-05-29T16:59:21.5509607+00:00",
      "alreadySent": true,
      "hasSignatureFileBinaryData": true
    },
    {
      "formFileSignatureId": 1,
      "formFileId": 2,
      "formFileName": "sample string 3",
      "formFileFileName": "sample string 4",
      "patientFullName": "sample string 5",
      "patientBirthday": "2026-05-29T16:59:21.5509607+00:00",
      "patientExternalId": "sample string 6",
      "signatureDate": "2026-05-29T16:59:21.5509607+00:00",
      "alreadySent": true,
      "hasSignatureFileBinaryData": true
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfFormFileSignatureModel1wkFnTSU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.FormFileSignatures">
    <d2p1:FormFileSignatureModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:FormFileFileName>sample string 4</d2p1:FormFileFileName>
      <d2p1:FormFileId>2</d2p1:FormFileId>
      <d2p1:FormFileName>sample string 3</d2p1:FormFileName>
      <d2p1:FormFileSignatureId>1</d2p1:FormFileSignatureId>
      <d2p1:HasSignatureFileBinaryData>true</d2p1:HasSignatureFileBinaryData>
      <d2p1:PatientBirthday>2026-05-29T16:59:21.5509607+00:00</d2p1:PatientBirthday>
      <d2p1:PatientExternalId>sample string 6</d2p1:PatientExternalId>
      <d2p1:PatientFullName>sample string 5</d2p1:PatientFullName>
      <d2p1:SignatureDate>2026-05-29T16:59:21.5509607+00:00</d2p1:SignatureDate>
    </d2p1:FormFileSignatureModel>
    <d2p1:FormFileSignatureModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:FormFileFileName>sample string 4</d2p1:FormFileFileName>
      <d2p1:FormFileId>2</d2p1:FormFileId>
      <d2p1:FormFileName>sample string 3</d2p1:FormFileName>
      <d2p1:FormFileSignatureId>1</d2p1:FormFileSignatureId>
      <d2p1:HasSignatureFileBinaryData>true</d2p1:HasSignatureFileBinaryData>
      <d2p1:PatientBirthday>2026-05-29T16:59:21.5509607+00:00</d2p1:PatientBirthday>
      <d2p1:PatientExternalId>sample string 6</d2p1:PatientExternalId>
      <d2p1:PatientFullName>sample string 5</d2p1:PatientFullName>
      <d2p1:SignatureDate>2026-05-29T16:59:21.5509607+00:00</d2p1:SignatureDate>
    </d2p1:FormFileSignatureModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfFormFileSignatureModel1wkFnTSU>