Projet

Général

Profil

Pelle API v10 » Historique » Version 14

Version 13 (Nicolas BERTRAND, 08/09/2016 15:14) → Version 14/45 (Nicolas BERTRAND, 08/09/2016 16:05)

h1. Pelle API v10

h2. API Base URL

<pre>
https://tuco.tdcpb.org/pelle/v1.0
</pre>

h2. Authentication

HTTP requests to the REST API are protected with HTTP Basic authentication

Example:
<pre>
curl -u <username>:<pass> -H "Content-Type: application/json" -X GET https://tuco.tdcpb.org/pelle/v1.0/exhibitors
</pre>

h2. Exhibitors Resources

h3. Exhibitor Properties

|_. NAME |_. DESCRIPTION |
| cncid | Unique exhibitor authorization ID given by CNC |
| id | Unique ID given by tuco (internal usage) |
| name | Theater name |
| address | Exhibitor address |
| city | Exhibitor city |
| contact | Person to contact |



h3. List all exhibitors

<pre>
GET exhibitors
</pre>

Output sample:

<pre>
{
exhibitors:[
{
'cncid': '123456',
'name': 'UN CINEMA'
'city' : LA VILLE
},
....
]
}
</pre>

h3. Retrieve a exhibitor

<pre>
GET exhibitors/<cncid>
</pre>

Output sample:

<pre>
{
exhibitors:
{
'cncid': '123456',
'name': 'UN CINEMA'
'city' : LA VILLE
},
}
</pre>

h3. Retrieve a exhibitor current downloads

<pre>
GET exhibitors/<cncid>/current_downloads
</pre>

Output sample:
<pre>
</pre>

h2. Distributor Resources

h3. Distributor Properties

h3. List all distributors

<pre>
GET distributors
</pre>

Output sample:

h3. Retrieve a distributor

<pre>
GET distributors/<cncid>
</pre>

Output sample:

h3. List distributor catalog
<pre>
GET distributors/<cncid>/movies
</pre>

Output sample:

h2. Distribution Resources

h3. Retrieve distribution status of DCP <dcpid> to exhibitor <cncid>

<pre>
GET distributions/<cncid>/<dcpid>
</pre>


h3. Distribute a DCP to a distributor

<pre>
POST distributions/<cncid>/<dcpid>
</pre>