GET api/File/GetFiles?status={status}&onlydownloadable={onlydownloadable}

Get all files

Request Information

URI Parameters

NameDescriptionTypeAdditional information
status

Status of file (-1 default for all files, New = 0, InProgress = 1, Fecthed = 2, Deleted = 3)

integer

Default value is -1

onlydownloadable

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

List of files

Collection of FileInfo
NameDescriptionTypeAdditional information
ID

string

None.

Created

date

None.

Creator

string

None.

CreatorSSN

string

None.

Deleted

boolean

None.

FetchStart

date

None.

FetchEnd

date

None.

Filename

string

None.

FileHash

string

None.

Size

integer

None.

FetchesLeft

integer

None.

Receivers

Collection of Receiver

None.

Status

FileStatus

None.

IsCreator

boolean

None.

GroupName

string

None.

Notes

string

None.

ArchiveFileList

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "sample string 1",
    "Created": "2022-06-29T14:33:17.0483631+00:00",
    "Creator": "sample string 3",
    "CreatorSSN": "sample string 4",
    "Deleted": true,
    "FetchStart": "2022-06-29T14:33:17.0483631+00:00",
    "FetchEnd": "2022-06-29T14:33:17.0483631+00:00",
    "Filename": "sample string 6",
    "FileHash": "sample string 7",
    "Size": 8,
    "FetchesLeft": 9,
    "Receivers": [
      {
        "Name": "sample string 1",
        "SSN": "sample string 2",
        "Email": "sample string 3",
        "Mobile": "sample string 4",
        "Message": "sample string 5",
        "Notify": true,
        "Fetched": "2022-06-29T14:33:17.0483631+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      },
      {
        "Name": "sample string 1",
        "SSN": "sample string 2",
        "Email": "sample string 3",
        "Mobile": "sample string 4",
        "Message": "sample string 5",
        "Notify": true,
        "Fetched": "2022-06-29T14:33:17.0483631+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      }
    ],
    "Status": 0,
    "IsCreator": true,
    "GroupName": "sample string 11",
    "Notes": "sample string 12",
    "ArchiveFileList": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "ID": "sample string 1",
    "Created": "2022-06-29T14:33:17.0483631+00:00",
    "Creator": "sample string 3",
    "CreatorSSN": "sample string 4",
    "Deleted": true,
    "FetchStart": "2022-06-29T14:33:17.0483631+00:00",
    "FetchEnd": "2022-06-29T14:33:17.0483631+00:00",
    "Filename": "sample string 6",
    "FileHash": "sample string 7",
    "Size": 8,
    "FetchesLeft": 9,
    "Receivers": [
      {
        "Name": "sample string 1",
        "SSN": "sample string 2",
        "Email": "sample string 3",
        "Mobile": "sample string 4",
        "Message": "sample string 5",
        "Notify": true,
        "Fetched": "2022-06-29T14:33:17.0483631+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      },
      {
        "Name": "sample string 1",
        "SSN": "sample string 2",
        "Email": "sample string 3",
        "Mobile": "sample string 4",
        "Message": "sample string 5",
        "Notify": true,
        "Fetched": "2022-06-29T14:33:17.0483631+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      }
    ],
    "Status": 0,
    "IsCreator": true,
    "GroupName": "sample string 11",
    "Notes": "sample string 12",
    "ArchiveFileList": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfFileInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.FileExchange">
  <FileInfo>
    <ArchiveFileList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ArchiveFileList>
    <Created>2022-06-29T14:33:17.0483631+00:00</Created>
    <Creator>sample string 3</Creator>
    <CreatorSSN>sample string 4</CreatorSSN>
    <Deleted>true</Deleted>
    <FetchEnd>2022-06-29T14:33:17.0483631+00:00</FetchEnd>
    <FetchStart>2022-06-29T14:33:17.0483631+00:00</FetchStart>
    <FetchesLeft>9</FetchesLeft>
    <FileHash>sample string 7</FileHash>
    <Filename>sample string 6</Filename>
    <GroupName>sample string 11</GroupName>
    <ID>sample string 1</ID>
    <IsCreator>true</IsCreator>
    <Notes>sample string 12</Notes>
    <Receivers>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2022-06-29T14:33:17.0483631+00:00</Fetched>
        <Message>sample string 5</Message>
        <Mobile>sample string 4</Mobile>
        <Name>sample string 1</Name>
        <Notify>true</Notify>
        <SSN>sample string 2</SSN>
      </Receiver>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2022-06-29T14:33:17.0483631+00:00</Fetched>
        <Message>sample string 5</Message>
        <Mobile>sample string 4</Mobile>
        <Name>sample string 1</Name>
        <Notify>true</Notify>
        <SSN>sample string 2</SSN>
      </Receiver>
    </Receivers>
    <Size>8</Size>
    <Status>New</Status>
  </FileInfo>
  <FileInfo>
    <ArchiveFileList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ArchiveFileList>
    <Created>2022-06-29T14:33:17.0483631+00:00</Created>
    <Creator>sample string 3</Creator>
    <CreatorSSN>sample string 4</CreatorSSN>
    <Deleted>true</Deleted>
    <FetchEnd>2022-06-29T14:33:17.0483631+00:00</FetchEnd>
    <FetchStart>2022-06-29T14:33:17.0483631+00:00</FetchStart>
    <FetchesLeft>9</FetchesLeft>
    <FileHash>sample string 7</FileHash>
    <Filename>sample string 6</Filename>
    <GroupName>sample string 11</GroupName>
    <ID>sample string 1</ID>
    <IsCreator>true</IsCreator>
    <Notes>sample string 12</Notes>
    <Receivers>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2022-06-29T14:33:17.0483631+00:00</Fetched>
        <Message>sample string 5</Message>
        <Mobile>sample string 4</Mobile>
        <Name>sample string 1</Name>
        <Notify>true</Notify>
        <SSN>sample string 2</SSN>
      </Receiver>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2022-06-29T14:33:17.0483631+00:00</Fetched>
        <Message>sample string 5</Message>
        <Mobile>sample string 4</Mobile>
        <Name>sample string 1</Name>
        <Notify>true</Notify>
        <SSN>sample string 2</SSN>
      </Receiver>
    </Receivers>
    <Size>8</Size>
    <Status>New</Status>
  </FileInfo>
</ArrayOfFileInfo>