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

Get files, returns files, if no paramters are used it will return all files for the last 30 days.

Request Information

URI Parameters

Name	Description	Type	Additional information
status	Status of file (-1 default for all files, New = 0, InProgress = 1, Fecthed = 2, Deleted = 3)	integer	Default value is -1
onlydownloadable	Only list downloadable files	boolean	Default value is False
fromTime	From value Datetime expecting "yyyy-MM-ddTHH:mm:ss.fff formatting. If not passed then default value of 30 days is used.	date	None.
toTime	To Value Datetime expecting "yyyy-MM-ddTHH:mm:ss.fff formatting. If not passed then current date and time us used.	date	None.

Body Parameters

None.

Response Information

Resource Description

List of files

Collection of FileInfo

Name	Type	Additional 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.
GroupID	integer	None.
Notes	string	None.
Metadata	string	None.
ArchiveFileList	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "sample string 1",
    "Created": "2024-05-02T15:48:50.3931258+00:00",
    "Creator": "sample string 3",
    "CreatorSSN": "sample string 4",
    "Deleted": true,
    "FetchStart": "2024-05-02T15:48:50.394114+00:00",
    "FetchEnd": "2024-05-02T15:48:50.394114+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": "2024-05-02T15:48:50.394114+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": "2024-05-02T15:48:50.394114+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      }
    ],
    "Status": 0,
    "IsCreator": true,
    "GroupName": "sample string 11",
    "GroupID": 12,
    "Notes": "sample string 13",
    "Metadata": "sample string 14",
    "ArchiveFileList": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "ID": "sample string 1",
    "Created": "2024-05-02T15:48:50.3931258+00:00",
    "Creator": "sample string 3",
    "CreatorSSN": "sample string 4",
    "Deleted": true,
    "FetchStart": "2024-05-02T15:48:50.394114+00:00",
    "FetchEnd": "2024-05-02T15:48:50.394114+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": "2024-05-02T15:48:50.394114+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": "2024-05-02T15:48:50.394114+00:00",
        "AuthData": "sample string 7",
        "FetchData": "sample string 8"
      }
    ],
    "Status": 0,
    "IsCreator": true,
    "GroupName": "sample string 11",
    "GroupID": 12,
    "Notes": "sample string 13",
    "Metadata": "sample string 14",
    "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>2024-05-02T15:48:50.3931258+00:00</Created>
    <Creator>sample string 3</Creator>
    <CreatorSSN>sample string 4</CreatorSSN>
    <Deleted>true</Deleted>
    <FetchEnd>2024-05-02T15:48:50.394114+00:00</FetchEnd>
    <FetchStart>2024-05-02T15:48:50.394114+00:00</FetchStart>
    <FetchesLeft>9</FetchesLeft>
    <FileHash>sample string 7</FileHash>
    <Filename>sample string 6</Filename>
    <GroupID>12</GroupID>
    <GroupName>sample string 11</GroupName>
    <ID>sample string 1</ID>
    <IsCreator>true</IsCreator>
    <Metadata>sample string 14</Metadata>
    <Notes>sample string 13</Notes>
    <Receivers>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2024-05-02T15:48:50.394114+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>2024-05-02T15:48:50.394114+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>2024-05-02T15:48:50.3931258+00:00</Created>
    <Creator>sample string 3</Creator>
    <CreatorSSN>sample string 4</CreatorSSN>
    <Deleted>true</Deleted>
    <FetchEnd>2024-05-02T15:48:50.394114+00:00</FetchEnd>
    <FetchStart>2024-05-02T15:48:50.394114+00:00</FetchStart>
    <FetchesLeft>9</FetchesLeft>
    <FileHash>sample string 7</FileHash>
    <Filename>sample string 6</Filename>
    <GroupID>12</GroupID>
    <GroupName>sample string 11</GroupName>
    <ID>sample string 1</ID>
    <IsCreator>true</IsCreator>
    <Metadata>sample string 14</Metadata>
    <Notes>sample string 13</Notes>
    <Receivers>
      <Receiver>
        <AuthData>sample string 7</AuthData>
        <Email>sample string 3</Email>
        <FetchData>sample string 8</FetchData>
        <Fetched>2024-05-02T15:48:50.394114+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>2024-05-02T15:48:50.394114+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>