Version 8.3.8

Back | 

GetProject

Returns basic project metadata, as well as a list of categories if they exist.

URL Format

/ws/get_project/api/{app_token}/p/{project_uuid}/r/{referenceId}/c/{clientuuid}

Parameters

Name Req Type Description
project_uuid string The uuid of the project to search
app_token string The user api token
mode string Specifies response mode. Can be {'xml','json'}
referenceId string The referenceId for the project (clientuuid parameter required as well)
clientuuid string The uuid of the client (for use with referenceId)

Request Headers

Name

Possible Responses

  • 202 Project Found
  • 338 Invalid Project UUID
  • 659 Invalid Client
  • 1033 Project Deleted

Example Response

{
  "response": {
    "success": {
      "code": 202,
      "message": "Vod Project Found",
      "details": ""
    },
    "getProjectResponse": {
      "vodProject": {
        "class": "VodProject",
        "pdate": "2012-04-30T16:37:56Z",
        "uuid": "t8592qaq",
        "title": "Single AppStudio Player Project",
        "description": null,
        "playerSwfUrl": "http:\/\/appasset.appstudio.piksel.com\/app\/AppLoader.swf?compiledApp=http:\/\/appasset.appstudio.piksel.com\/compiled\/mediasuite_STATIC_0\/AppShell_ftaj4vyu.swf",
        "clientUUID": "69739d355baa942ebab4d61573aa08ed",
        "tag": null,
        "referenceId": null,
        "rssLinks": {
          "vidego": "http:\/\/api-ovp.piksel.tech\/ws\/get_rss\/p_t8592qaq\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/t8592qaq.xml",
          "subscriptions": {
            "yahoo": "http:\/\/e.my.yahoo.com\/config\/cstore?.opt=content&.url=http:\/\/api-ovp.piksel.tech\/ws\/get_rss\/p_t8592qaq\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/t8592qaq.xml",
            "bloglines": "http:\/\/www.bloglines.com\/login?r=\/sub\/http:\/\/api-ovp.piksel.tech\/ws\/get_rss\/p_t8592qaq\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/t8592qaq.xml",
            "google": "http:\/\/www.google.com\/ig\/add?feedurl=http:\/\/api-ovp.piksel.tech\/ws\/get_rss\/p_t8592qaq\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/t8592qaq.xml",
            "itunes": "itpc:\/\/api-ovp.piksel.tech\/ws\/get_rss\/p_t8592qaq\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/t8592qaq.xml"
          }
        },
        "elements": {
          "autoPlay": true,
          "autoPlaySound": true,
          "useC2pIcon": true,
          "c2pIconAlpha": "75",
          "usePostRoll": false,
          "postRollImg": "",
          "postRollClickAction": "Replay",
          "postRollClickURL": null,
          "landingPage": "",
          "centerAlignPermalink": true,
          "flash9FS": true,
          "videoScaling": "Letterbox",
          "imageWatermark": "",
          "watermarkLink": null,
          "showMenuFullScreen": true,
          "showMenu": true,
          "showLink": true,
          "showRSS": true,
          "showS2f": true,
          "showEmbed": true,
          "showHelp": true,
          "prerollVideoAd": "",
          "postrollVideoAd": "",
          "gaAccountNumber": null,
          "disableGoogleAnalytics": false,
          "enableOmniture": false,
          "omniAccountID": null,
          "omniPlayerName": null,
          "omniNamespace": null,
          "omniDC": null,
          "omniTrackingServer": null,
          "omniTrackingMethod": "Milestones",
          "omniTrackingInterval": "10,50,90",
          "omniDataMapping": null,
          "omniCustomVar": null,
          "omniTrackClick": true,
          "useChartbeat": false,
          "chartBeatAcct": null,
          "chartBeatDomain": null,
          "chartBeatUseCanonical": false,
          "videoStartTrackingTag": null,
          "videoClickTrackingTag": null,
          "AppStudio Custom Player": "1",
          "invEnabled": false,
          "invType": "LIVE",
          "invPID": null,
          "invVID": null,
          "mcnFeaturedImage": "",
          "mcnMenuImage": "",
          "mcnPageTemplate": "heroAdvancedTemplate",
          "mcnMenuClassification": null,
          "mcnTrailer": null,
          "mcnRelatedProjects": null,
          "mcnProjectPublished": false,
          "sfEventDescription": null,
          "sfName": null,
          "sfSpeaker": null,
          "sfAddress": null,
          "sfPhone": null,
          "sfEmail": null,
          "sfWebsite": null,
          "sfAboutus": null,
          "sfFacebookAPIkey": null,
          "sfTwitter": null,
          "sfGivingURL": null,
          "sfBibleVersion": null,
          "sfLiveImage": "",
          "iTunesCustomImage": "",
          "iTunesOwnerName": null,
          "iTunesOwnerEmail": null,
          "iTunesAuthor": null,
          "iTunesSummary": null,
          "iTunesCopyright": null,
          "iTunesLanguage": "en-us",
          "iTunesSubtitle": null,
          "iTunesCategory": "None",
          "iTunesSubCategory": "None",
          "iTunesPublishDate": "Date Added",
          "iTunesNewFeed": null,
          "appstudioDelivery": "Akamai HD",
          "twitterDeliveryMethod": "Progressive Download",
          "disbaleDirectDownload": false,
          "geofilter": "",
          "geoMessage": "You are not permitted to view this content in your geographical location.",
          "xtsd": null,
          "xtsite": null,
          "xtn2": null,
          "xitiEnabled": false
        },
        "hasGeoFilter": false
      },
      "ama_config_url": "https:\/\/player.piksel.com\/templates\/analytics_ondemand_prod.xml"
    }
  }
}