fkm

<back to all web services

FilePush

Requires Authentication
The following routes are available for this service:
POST/FilePush
FilePush Parameters:
NameParameterData TypeRequiredDescription
FileIdbodystringYes
UserNamebodystringYes
TaskIdbodystringYes
CompletionIdbodystringNo
ObjectUidbodystringYes
FileNamebodystringNo
FileTypebodyFileTypesNo
StatusbodyFileSendStatusNo
LastOperationDatebodystringNo
TotalByteCountbodylongNo
ExternalPathbodystringNo
PublicUrlbodystringNo
FileTypes Enum:
file
survey
completion
FileSendStatus Enum:
inProcess
sent
faultSend

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /FilePush HTTP/1.1 
Host: s10.tdfkm.ru 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FilePush xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <CompletionId>String</CompletionId>
  <ExternalPath>String</ExternalPath>
  <FileId>String</FileId>
  <FileName>String</FileName>
  <FileType>file</FileType>
  <LastOperationDate>String</LastOperationDate>
  <ObjectUid>String</ObjectUid>
  <PublicUrl>String</PublicUrl>
  <Status>inProcess</Status>
  <TaskId>String</TaskId>
  <TotalByteCount>0</TotalByteCount>
  <UserName>String</UserName>
</FilePush>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FilePush.FilePushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <IsOk>false</IsOk>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FilePush.FilePushResponse>