Getting Metadata

You can get the metadata values associated with a Media Item ID using the getMetaDataFields method.

The required parameters are:

Account Name (username)
The username you use to log in to the yospaceCDS Content Management Console
Password (password)
The password associated with the username you use to log in to the yospaceCDS Content Management Console
MediaItem ID (mediaItemId)
The MediaItem ID of the content the metadata of which you wish to query.

An example request:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
  <ns2:getMetaDataFields xmlns:ns2="http://www.yospace.com/tundra/MediaItemManagement/">
    <username>USERNAME</username>
    <password>PASSWORD</password>
    <mediaItemId>12345678</mediaItemId>
  </ns2:getMetaDataFields>
  </soap:Body>
</soap:Envelope>

Possible status code (with descriptions) are as follows:

  • 200, OK
  • 601, AUTHENTICATION_FAIL
  • 603, BAD_MEDIA_ITEM_ID (ID not supplied>
  • 603, NO_MEDIA_ITEM (media item not found)
  • 604, USER_DOES_NOT_OWN_RESOURCE
  • 609, NO_FIELD_DEFINITIONS (the account does not have a metadata schema set-up)
  • 599, GENERAL_ERROR

An example response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns2:getMetaDataFieldsResponse xmlns:ns2="http://www.yospace.com/tundra/MediaItemManagement/">
      <statusCode>200</statusCode>
      <statusDescription>OK</statusDescription>
      <mediaItemFields>
        <fieldName>Category</fieldName>
        <value>Music</value>
      </mediaItemFields>
      <mediaItemFields>
        <fieldName>Publish Date</fieldName>
        <value>2009-10-21 09:00:00.0</value>
      </mediaItemFields>
      <mediaItemFields>
        <fieldName>Title</fieldName>
        <value>Punch Brothers</value>
      </mediaItemFields>
      <mediaItemFields>
        <fieldName>Description</fieldName>
        <value>This is the description</value>
      </mediaItemFields>
      <mediaItemFields>
        <fieldName>Keywords</fieldName>
        <value>keyword1, keyword2</value>
      </mediaItemFields>
    </ns2:getMetaDataFieldsResponse>
  </soap:Body>
</soap:Envelope>