Version 7.9.4

Back | 

WsAccountMetadata

Returns account metadata for a given account

URL Format

/ws/ws_account_metadata/api/{app_token}/mode/json/apiv/5/

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.

Possible Responses

  • 321 Account Metadata found
  • 101 Invalid client token.
  • 102 Invalid app token.
  • 659 Invalid Client

Example Response

{
  "response": {
    "success": {
      "code": 321,
      "message": "Account Metadata found",
      "details": ""
    },
    "WsAccountMetadataResponse": {
      "global": {
        "Name": {
          "id": 1,
          "gmId": 1,
          "minLength": 0,
          "maxLength": 2000,
          "minWords": 0,
          "maxWords": 2000,
          "isRequired": 0,
          "isVisible": 0,
          "mdName": "Name"
        },
        "Description": {
          "id": 2,
          "gmId": 2,
          "minLength": 0,
          "maxLength": 2000,
          "minWords": 0,
          "maxWords": 2000,
          "isRequired": 0,
          "isVisible": 0,
          "mdName": "Description"
        },
        "Keywords": {
          "id": 3,
          "gmId": 3,
          "minLength": 0,
          "maxLength": 2000,
          "minWords": 0,
          "maxWords": 2000,
          "isRequired": 0,
          "isVisible": 0,
          "mdName": "Keywords"
        },
        "Folder": {
          "id": 25,
          "gmId": 4,
          "minLength": 0,
          "maxLength": 0,
          "minWords": 0,
          "maxWords": 0,
          "isRequired": 0,
          "isVisible": 0,
          "mdName": "Folder"
        },
        "Start Date": {
          "id": 62,
          "gmId": 5,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "Start Date"
        },
        "End Date": {
          "id": 63,
          "gmId": 6,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "End Date"
        },
        "Published": {
          "id": 64,
          "gmId": 7,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "Published"
        },
        "Publishable To YouTube": {
          "id": 65,
          "gmId": 8,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "Publishable To YouTube"
        },
        "Hidden": {
          "id": 66,
          "gmId": 9,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "Hidden"
        },
        "Reference Id": {
          "id": 91,
          "gmId": 10,
          "minLength": 1,
          "maxLength": 200,
          "isRequired": 0,
          "isVisible": 1,
          "mdName": "Reference Id"
        }
      },
      "custom": {
        "Custom Meta": {
          "class": "GenericMetaname",
          "id": 50542,
          "fieldType": "text",
          "defaultValue": "Metadata",
          "metaname": "Custom Meta",
          "displayName": "Custom meta",
          "width": 100,
          "height": 20,
          "minLength": 0,
          "maxLength": 0,
          "minWords": 0,
          "maxWords": 0,
          "isRequired": 0,
          "sortnum": 0,
          "isHidden": 0
        }
      }
    }
  }
}