Back | 

AssetRssGetHdsManifestGetLiveM3u8LoginWsAccountMetadataWsAccountPreferenceWsAnalyticsJobWsAnalyticsReportWsAssetWsAssetAssociatedFileWsAssetAssociatedLinkWsAssetAssociationsWsAssetCaptionFileWsAssetCustomEmbedWsAssetFileWsAssetSubTypeWsChannelWsClientWsDsUserWsEPGDefaultScheduleWsEPGScheduleWsEmbedWsFiletypesWsFolderWsFtpWsFtpAccountWsGoogleAnalyticsReportWsHtml5PlayerWsLiveEventWsLiveNoteWsLiveSeriesWsMidRollAdWsPaletteReportWsPermissionWsPlayerWsPresentationWsPresentationSlideWsProgramWsProgramM3u8WsRandomProgramsWsRecycleAssetWsRelatedProgramsWsScheduleItemsForPlayoutWsSearchProgramsWsSecurityFilterWsSfSyndicationWsSpriteWsSystemDefaultWsThumbnailWsTimezonesWsTranscodeHistoryWsTranscodingProfileWsUnpreparedFilesWsUserWsUserTokenWsVimeoAccountWsVimeoPublishWsVodProjectWsYouTubeAccountWsYouTubePublish

WsFtp

Returns Returns ftp files for the given account

URL Format

/ws/ws_ftp/api/{app_token}/mode/json/apiv/5/?start={index_start}&end={index_end}&sortby={sortby}&sortdir={asc/desc}&type={type}

Parameters

Name	Req	Type	Description
app_token		string	App token for the client
apiv		integer	The api version; only version 5 supported.
filename		string	filename param. Used to search files by filename. Supports partial search
start		integer	Index to start results, Used primarily for pagination. Default is set to 0
end		integer	Index to stop results, Used primarily for pagination. Default is set to start+50
sortby		string	sortby param. Possible values (filename,fileSize,dtstamp,type)
sortdir		string	sort direction param (asc/desc)
type		type	of the file. Example (video,audio,presentation,image)

Request Headers

Name

Possible Responses

• 885 Ftp files found
• 659 Invalid Client
• 102 Invalid app token
• 912 Invalid sort direction param
• 1041 Invalid sort params
• 915 Invalid type

Example Response

{
  "response": {
    "success": {
      "code": 885,
      "message": "Ftp files found",
      "details": ""
    },
    "WsFtpResponse": {
      "currentCount": 1,
      "totalCount": 6,
      "files": [
        {
          "filename": "clipcanvas_14348_ProResHQ_1080 (1).mov",
          "dtstamp": "2014-09-09T12:05:00Z",
          "base_filename": "clipcanvas_14348_ProResHQ_1080 (1)",
          "ext": "mov",
          "ext_text": "Quicktime Multimedia",
          "isMediaCompatibleForPlayout": true,
          "days_until_deletion": 8,
          "fileSize": "177387292",
          "type": "video"
        }
      ]
    }
  }
}