A lookup call to get all available Media Owners, including their Media Owner ID and description. The call will allow a single ID to be given in order to return the description.
When accessed via a GET request this API method will return a list of all media owners. By specifying an id parameter you can retrieve details about a specific media owner.
As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.
parameter | type | description |
---|---|---|
id | string (optional) | a media owner identifier to restrict results to |
If accessing GET /api/media-owner?id=3 the following JSON would be returned:
{
"data": [
{
"media_owner_id": 3,
"media_owner_description": "JCDecaux"
}
]
}
A "data" element that contains an array of media owners defined as follows:
media_owner_id - string - the unique identifier used within SPACE to reference the media owner
media_owner_description - string - a description of the media owner suitable for display to a user