POST api/Doc/ImportFile

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyId	integer	None.
ImportCompanyId	integer	None.
ImportClientId	integer	None.
FileName	string	None.
Bytes	string	None.
IsRefresh	boolean	None.
IsPassive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "ImportCompanyId": 2,
  "ImportClientId": 3,
  "FileName": "sample string 4",
  "Bytes": "sample string 5",
  "IsRefresh": true,
  "IsPassive": true
}

application/xml, text/xml

Sample:

<ImportFileParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models">
  <Bytes>sample string 5</Bytes>
  <CompanyId>1</CompanyId>
  <FileName>sample string 4</FileName>
  <ImportClientId>3</ImportClientId>
  <ImportCompanyId>2</ImportCompanyId>
  <IsPassive>true</IsPassive>
  <IsRefresh>true</IsRefresh>
</ImportFileParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ImportFileResponse

Name	Type	Additional information
Result	boolean	None.
StatusCode	integer	None.
Status	string	None.
Messages	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": true,
  "StatusCode": 2,
  "Status": "sample string 3",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ImportFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Result>true</Result>
  <Status>sample string 3</Status>
  <StatusCode>2</StatusCode>
</ImportFileResponse>