GET v1/Files/FilesByContact?contactid={contactid}&dlFileType={dlFileType}&pageNumber={pageNumber}&pageSize={pageSize}

Get a list of files associated to a Contact ID, alternatively you can request the byte[] of the file with 'downloadAs': None, Thumbnail, Original

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactid

string

Required

dlFileType

string

Required

pageNumber

string

Required

pageSize

string

Required

Body Parameters

None.

Response Information

Resource Description

PageOfOfBlobInfoDTO
NameDescriptionTypeAdditional information
Data

Collection of BlobInfoDTO

None.

PageNumber

integer

None.

PagesTotal

integer

None.

TotalItems

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

DisplayMessage

string

None.

Links

Collection of PageLink

None.

Href

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Id": 1,
      "BlobContainerInfoId": 2,
      "BlobFileName": "sample string 3",
      "FileName": "sample string 4",
      "DisplayName": "sample string 5",
      "FileType": "sample string 6",
      "CreatedOn": "sample string 7",
      "CreatedBy": "sample string 8",
      "EntityId": 9,
      "FileRelation": 10,
      "CreatedById": 1,
      "Active": true,
      "Description": "sample string 12",
      "ThumnbailBlobFileName": "sample string 13",
      "ThumbnailAvatarBlobFileName": "sample string 14",
      "FileSize": 1,
      "AppCreated": "sample string 15",
      "RelatedPolicyIDs": [
        1,
        2
      ],
      "CategoryDescriptor": "sample string 16",
      "File": "QEA=",
      "DownloadFileType": "sample string 17",
      "Readonly": true,
      "UsageCode": "sample string 19",
      "StorageLocationId": 1,
      "CreatedOnSearchable": "sample string 20",
      "FolderId": 1,
      "ExcludeFromStorageCost": true,
      "BlobUrl": "sample string 22",
      "Tags": "sample string 23",
      "ShouldHaveThumbnail": false
    },
    {
      "Id": 1,
      "BlobContainerInfoId": 2,
      "BlobFileName": "sample string 3",
      "FileName": "sample string 4",
      "DisplayName": "sample string 5",
      "FileType": "sample string 6",
      "CreatedOn": "sample string 7",
      "CreatedBy": "sample string 8",
      "EntityId": 9,
      "FileRelation": 10,
      "CreatedById": 1,
      "Active": true,
      "Description": "sample string 12",
      "ThumnbailBlobFileName": "sample string 13",
      "ThumbnailAvatarBlobFileName": "sample string 14",
      "FileSize": 1,
      "AppCreated": "sample string 15",
      "RelatedPolicyIDs": [
        1,
        2
      ],
      "CategoryDescriptor": "sample string 16",
      "File": "QEA=",
      "DownloadFileType": "sample string 17",
      "Readonly": true,
      "UsageCode": "sample string 19",
      "StorageLocationId": 1,
      "CreatedOnSearchable": "sample string 20",
      "FolderId": 1,
      "ExcludeFromStorageCost": true,
      "BlobUrl": "sample string 22",
      "Tags": "sample string 23",
      "ShouldHaveThumbnail": false
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:
<PageOfBlobInfoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Files">
    <d2p1:BlobInfoDTO>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AppCreated>sample string 15</d2p1:AppCreated>
      <d2p1:BlobContainerInfoId>2</d2p1:BlobContainerInfoId>
      <d2p1:BlobFileName>sample string 3</d2p1:BlobFileName>
      <d2p1:BlobUrl>sample string 22</d2p1:BlobUrl>
      <d2p1:CategoryDescriptor>sample string 16</d2p1:CategoryDescriptor>
      <d2p1:CreatedBy>sample string 8</d2p1:CreatedBy>
      <d2p1:CreatedById>1</d2p1:CreatedById>
      <d2p1:CreatedOn>sample string 7</d2p1:CreatedOn>
      <d2p1:CreatedOnSearchable>sample string 20</d2p1:CreatedOnSearchable>
      <d2p1:Description>sample string 12</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:DownloadFileType>sample string 17</d2p1:DownloadFileType>
      <d2p1:EntityId>9</d2p1:EntityId>
      <d2p1:ExcludeFromStorageCost>true</d2p1:ExcludeFromStorageCost>
      <d2p1:File>QEA=</d2p1:File>
      <d2p1:FileName>sample string 4</d2p1:FileName>
      <d2p1:FileRelation>10</d2p1:FileRelation>
      <d2p1:FileSize>1</d2p1:FileSize>
      <d2p1:FileType>sample string 6</d2p1:FileType>
      <d2p1:FolderId>1</d2p1:FolderId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Readonly>true</d2p1:Readonly>
      <d2p1:RelatedPolicyIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:RelatedPolicyIDs>
      <d2p1:StorageLocationId>1</d2p1:StorageLocationId>
      <d2p1:Tags>sample string 23</d2p1:Tags>
      <d2p1:ThumbnailAvatarBlobFileName>sample string 14</d2p1:ThumbnailAvatarBlobFileName>
      <d2p1:ThumnbailBlobFileName>sample string 13</d2p1:ThumnbailBlobFileName>
      <d2p1:UsageCode>sample string 19</d2p1:UsageCode>
    </d2p1:BlobInfoDTO>
    <d2p1:BlobInfoDTO>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AppCreated>sample string 15</d2p1:AppCreated>
      <d2p1:BlobContainerInfoId>2</d2p1:BlobContainerInfoId>
      <d2p1:BlobFileName>sample string 3</d2p1:BlobFileName>
      <d2p1:BlobUrl>sample string 22</d2p1:BlobUrl>
      <d2p1:CategoryDescriptor>sample string 16</d2p1:CategoryDescriptor>
      <d2p1:CreatedBy>sample string 8</d2p1:CreatedBy>
      <d2p1:CreatedById>1</d2p1:CreatedById>
      <d2p1:CreatedOn>sample string 7</d2p1:CreatedOn>
      <d2p1:CreatedOnSearchable>sample string 20</d2p1:CreatedOnSearchable>
      <d2p1:Description>sample string 12</d2p1:Description>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:DownloadFileType>sample string 17</d2p1:DownloadFileType>
      <d2p1:EntityId>9</d2p1:EntityId>
      <d2p1:ExcludeFromStorageCost>true</d2p1:ExcludeFromStorageCost>
      <d2p1:File>QEA=</d2p1:File>
      <d2p1:FileName>sample string 4</d2p1:FileName>
      <d2p1:FileRelation>10</d2p1:FileRelation>
      <d2p1:FileSize>1</d2p1:FileSize>
      <d2p1:FileType>sample string 6</d2p1:FileType>
      <d2p1:FolderId>1</d2p1:FolderId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Readonly>true</d2p1:Readonly>
      <d2p1:RelatedPolicyIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:RelatedPolicyIDs>
      <d2p1:StorageLocationId>1</d2p1:StorageLocationId>
      <d2p1:Tags>sample string 23</d2p1:Tags>
      <d2p1:ThumbnailAvatarBlobFileName>sample string 14</d2p1:ThumbnailAvatarBlobFileName>
      <d2p1:ThumnbailBlobFileName>sample string 13</d2p1:ThumnbailBlobFileName>
      <d2p1:UsageCode>sample string 19</d2p1:UsageCode>
    </d2p1:BlobInfoDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfBlobInfoDTO>