PUT api/File/AddFile

Add new file to system

Request Information

URI Parameters

None.

Body Parameters

The add request

AddFileRequest
NameDescriptionTypeAdditional information
DataStream

Stream

None.

Data

Collection of byte

None.

FileString

string

None.

Filename

string

None.

FetchStart

date

None.

FetchEnd

date

None.

SendMail

boolean

None.

SMS

boolean

None.

Message

string

None.

Receivers

Collection of Receiver

None.

OneReceiver

boolean

None.

Notes

string

None.

Groups

Collection of integer

None.

NumFetches

integer

None.

DeleteWhenFetched

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "DataStream": null,
  "Data": "QEA=",
  "FileString": "sample string 1",
  "Filename": "sample string 2",
  "FetchStart": "2022-06-29T18:59:55.5931517+00:00",
  "FetchEnd": "2022-06-29T18:59:55.5931517+00:00",
  "SendMail": true,
  "SMS": true,
  "Message": "sample string 5",
  "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-29T18:59:55.5931517+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-29T18:59:55.5931517+00:00",
      "AuthData": "sample string 7",
      "FetchData": "sample string 8"
    }
  ],
  "OneReceiver": true,
  "Notes": "sample string 7",
  "Groups": [
    1,
    2
  ],
  "NumFetches": 8,
  "DeleteWhenFetched": true
}

application/xml, text/xml

Sample:
<AddFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.FileExchange">
  <Data>QEA=</Data>
  <DataStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <DeleteWhenFetched>true</DeleteWhenFetched>
  <FetchEnd>2022-06-29T18:59:55.5931517+00:00</FetchEnd>
  <FetchStart>2022-06-29T18:59:55.5931517+00:00</FetchStart>
  <FileString>sample string 1</FileString>
  <Filename>sample string 2</Filename>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Groups>
  <Message>sample string 5</Message>
  <Notes>sample string 7</Notes>
  <NumFetches>8</NumFetches>
  <OneReceiver>true</OneReceiver>
  <Receivers>
    <Receiver>
      <AuthData>sample string 7</AuthData>
      <Email>sample string 3</Email>
      <FetchData>sample string 8</FetchData>
      <Fetched>2022-06-29T18:59:55.5931517+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-29T18:59:55.5931517+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>
  <SMS>true</SMS>
  <SendMail>true</SendMail>
</AddFileRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ID of the file added

Collection of string

Response Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>