Credit role
Note: Only Movida accounts with this feature enabled will expose this API.
A credit role resource represents the role of a credit in a piece of content. E.g. actor, director, producer, etc. Credit roles are created by BeBanjo upon request, there’s not UI for that yet.
This is how a credit role resource looks like in the API:
<?xml version="1.0" encoding="UTF-8"?>
<credit-role>
<id type="integer">1</id>
<name>actor</name>
<admits-character-name type="boolean">true</admits-character-name>
<link rel="self" href="https://movida.bebanjo.net/api/credit_roles/1"/>
</credit-role>
Valid attributes
-
id
: Movida’s internal identifier for a credit role. -
name
(optional): a descriptive name for the role. -
admits-character-name
(optional): a boolean (true
/false
) to indicate if a credit with this role may supply or not a character name. Meaningful for actors, but not for directors, technical stuff, etc.
Getting the list of available credit roles
To return a list of all the credit roles available in one account, just send a GET
request like the following:
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/credit_roles
<?xml version="1.0" encoding="UTF-8"?>
<credit-roles type="array">
<credit-role>
<id type="integer">1</id>
<name>actor</name>
<admits-character-name type="boolean">true</admits-character-name>
<link rel="self" href="https://movida.bebanjo.net/api/credit_roles/1"/>
</credit-role>
<credit-role>
<id type="integer">2</id>
<name>director</name>
<admits-character-name type="boolean">false</admits-character-name>
<link rel="self" href="https://movida.bebanjo.net/api/credit_roles/2"/>
</credit-role>
<credit-role>
<id type="integer">3</id>
<name>producer</name>
<admits-character-name type="boolean">false</admits-character-name>
<link rel="self" href="https://movida.bebanjo.net/api/credit_roles/3"/>
</credit-role>
</credit-roles>
Getting a specific credit role
This operation allows you to recover information about one specific credit role:
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/credit_roles/1
<?xml version="1.0" encoding="UTF-8"?>
<credit-role>
<id type="integer">1</id>
<name>actor</name>
<admits-character-name type="boolean">true</admits-character-name>
<link rel="self" href="https://movida.bebanjo.net/api/credit_roles/1"/>
</credit-role>
Last updated January 25th, 2021.