Our Web API is accessible via HTTPS and is REST compliant.
Requests must be sent from a client, you, to a server, us, using specific URLs and
parameters.
URLs can be static or dynamic. Our Api is based on Slim Php.
For each response, you can find these properties:
| Name | Description |
|---|---|
| error | |
| errorCode | |
| _message | The result(s) of your call. The value is an object (or an array of objects). |
| _links | Special property is a map of keys and values where the key is the relation name (rel) and the value is an object (or an array of objects). |
To access the Api, you have to be a Diese client. Please ask your contact at Diese for more information.
function doCurl($url,$data = array()) {
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_URL => "https://{idClient}.diesesoftware.com/_app/{idSubClient}/api/".$url,
CURLOPT_POST => 1,
CURLOPT_POSTFIELDS => json_encode($data),
CURLOPT_HTTPHEADER =>array('Authorization: {apiKey}','Idclient: {idSubClient}','Token: {token}')
));
$resp = curl_exec($curl);
curl_close($curl);
return json_decode($resp);
}
| Name | Description | Type | Additional information |
|---|---|---|---|
| idClient | string | Required |
|
| idSubClient | string | Required You have to insert it twice ! It could be the production account (identical to idClient) or a pre production account |
|
| apiKey | string | Required linked to the idSubClient |
|
| token | string | Required (except the Authenticate call) You have it thanks to the Authentication call |
doCurl('authentication/')
| Name | Description | Type |
|---|---|---|
| Message | ||
| return a string: the token. It's used in your
doCurl function. It improves drastically the response time fo your API. |
||
{
"error": false,
"message": "QkZsblh5NkxZWXBISWN6ZWprWWx3dWdrSEhZQ3ZmWktJeVNvaWhJRmJIUnByK210bGd3OUxBVUJWT2FOWEJ4VzAzVGVUZmdHK0tFZ0hCTHdCOVVyMHc9PTo68zOo9VMMOTWzxRODdfYgYg=="
}
doCurl('production/{idProduction}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
$data = array(
"getCast" => true,
"getActivities" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCast | Set to true if you want to directly get the production's cast. | boolean |
| getSeason | Set to true if you want to directly get the production's season. | boolean |
| getActivities | Set to true if you want to directly get the production's activities. | boolean |
| getContracts | Set to true if you want to directly get the production's contracts. | boolean |
| getProductionsL1 | Set to true if you want to directly get the production's productions Level 1. | boolean |
| getCustomFields | Set to true if you want to directly get the production's custom fields. | boolean |
| getPlanificationStatuses | Set to true if you want to directly get the production's planification statuses. | boolean |
| getSeries | Set to true if you want to directly get the production's series. | boolean |
| getBreakdown | Set to true if you want to directly get the production's breakdowns. | boolean |
| getFiles | Set to true if you want to directly get the production's files. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| production_id | integer | |
| production_title | string | |
| production_titleShort | string | |
| production_alternativeTitle | string | |
| production_backgroundColor | string | |
| production_textColor | string | |
| production_duration | format "HH:MM:SS" | |
| production_premiereDate | YYYY-MM-DD | |
| season_id | integer | |
| season_title | string | |
| productionType_id | integer | |
| productionType_title | string | |
| productionStatus_id | integer | |
| productionStatus_title | string | |
| productionStatus_titleShort | string | |
| productionVenue_id | integer | |
| productionVenue_title | string | |
| productionStatus_titleShort | string | |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
| _links | ! not available in a get productions call. You have to use the direct calls instead. | |
| getCast | string | |
| getSeason | string | |
| getActivities | string | |
| getContracts | string | |
| getProductionsL1 | string | |
| getCustomFields | string | |
| getPlanificationStatuses | string | |
| getSeries | string | |
{
"error": false,
"errorCode": 0,
"message": [
{
"production_id": 2,
"production_title": "La Traviata",
"production_titleShort": "",
"productionL1_premiereDate": "1980-02-01",
"season_id": 14,
"season_title": "2015-2016",
"productionType_id": 1,
"productionType_title": "Lyrical",
"productionStatus_id": 1,
"productionStatus_title": "Provisional",
"productionStatus_titleShort": "PREP",
"productionVenue_id": 11,
"productionVenue_title": "Richelieu",
"productionVenue_titleShort": "AMP"
}
],
"_links": {
"getCast": "production/cast/2",
"getSeason": "season/14",
"getActivities": "production/activities/2",
"getContracts": "production/contracts/2",
"getProductionsL1": "production/productionsL1/2",
"getCustomFields": "production/customFields/2",
"getPlanificationStatuses": "production/planificationStatuses/2",
"getSeries": "production/series/2"
}
}
doCurl('productions/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" |
|
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| idProduction | integers separated by commas | ||
| idSeason | integers separated by commas | ||
| idProductionType | integers separated by commas | ||
| idProductionStatus | integers separated by commas | ||
| idProductionVenue | integers separated by commas | ||
| createdOrUpdatedBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| getCast | Set to true if you want to directly get the production's cast. | boolean | |
| getSeason | Set to true if you want to directly get the production's season. | boolean | |
| getActivities | Set to true if you want to directly get the production's activities. | boolean | |
| getContracts | Set to true if you want to directly get the production's contracts. | boolean | |
| getProductionsL1 | Set to true if you want to directly get the production's productions Level 1. | boolean | |
| getCustomFields | Set to true if you want to directly get the production's custom fields. | boolean | |
| getPlanificationStatuses | Set to true if you want to directly get the production's planification statuses. | boolean | |
| getSeries | Set to true if you want to directly get the production's series. | boolean | |
| getBreakdown | Set to true if you want to directly get the production's breakdown. | boolean |
You can access the production's cast through the get production call or by a direct call
doCurl('production/cast/{idProduction}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
$data = array(
"function" => "12,3,5",
"notRoleCategory" => "27"
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| function | the list of the function's Ids you want. They must be separated by a comma. | string |
| notFunction | the list of the function's Ids you DON'T want. They must be separated by a comma. | string |
| roleCategory | the list of the role categorie's Ids you want. They must be separated by a comma. | string |
| notRoleCategory | the list of the role categorie's Ids you DON'T want. They must be separated by a comma. | string |
| role_export | Can be 0 or 1. Allow to filter by the export flag. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| role_id | integer | |
| role_groupingKey | integer | |
| role_shortTitle | string | |
| role_title | string | |
| role_order | integer | |
| role_customText | string | |
| role_export | Integer boolean (0,1) | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleCategory_order | integer | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
| role_castAssignment | array | |
| roleCast_id | integer | |
| roleCast_title | string | |
| roleCast_order | integer | |
| roleCast_isCover | Integer boolean (0,1) | |
| roleStatus_id | int | |
| roleStatus_title | string | |
| productionsL1 | array | |
| productionL1_id | integer | |
| productionL1_title | string | |
| rate_id | integer | |
| rate_title | string | |
| seat_id | integer | |
| seat_title | string | |
| function_id | integer | |
| function_title | string | |
| linkCastProductionL1_note | string | |
{
"error": false,
"errorCode": 0,
"message": [
{
"contact_id": 131,
"contact_lastName": "DOE",
"contact_firstName": "John",
"role_id": 78,
"role_title": "Direction musicale",
"roleCategory_id": 2,
"roleCategory_title": "Equipe de production",
"roleCategory_order": 1
},
{
"contact_id": 144,
"contact_lastName": "DOE",
"contact_firstName": "JAne",
"role_id": 79,
"role_title": "Metteur en scène",
"roleCategory_id": 2,
"roleCategory_title": "Equipe de production",
"roleCategory_order": 1
},
]
}
You can access the production's contracts through the get production call or by a direct call
doCurl('production/contracts/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contract_id | integer | |
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| type | string | |
| start | string | |
| end | string | |
| department | string | |
| function | string | |
{
"error": false,
"errorCode": 0,
"message": [
{
"contract_id": 1295,
"contact_id": 127,
"contact_lastName": "DOE",
"contact_firstName": "Jane",
"type": "CDD technique",
"start": "09-03-2018",
"end": "30-06-2018",
"department": "Technique",
"function": "Agent"
},
{
"contract_id": 2539,
"contact_id": 131,
"contact_lastName": "DOE",
"contact_firstName": "John",
"type": "Soliste",
"start": "01-10-2019",
"end": "31-10-2019",
"department": "Artistique",
"function": "Soprano"
}
]
}
You can access the production's activities through the get production call or by a direct call.
If you want more data about the activity, we recommend to use the get activity call (id activity required).
doCurl('production/activities/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
$data = array(
"activityTypeId" => "12,3,5",
"notActivityTypeId" => "8",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| activityTypeId | the list of the activity type Ids you want. They must be separated by a comma. | string |
| notActivityTypeId | the list of the activity type Ids you DON'T want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| activity_id | integer | |
| activity_type | string | |
| activity_type_otherLanguageTitle | string | |
| activity_status | string | |
| activity_venue | string | |
| idVenue | integer | |
| start | string | |
| end | string | |
{
"error": false,
"message": [
{
"activity_id": 8884,
"activity_type": "REPRESENTATION",
"activity_type_otherLanguageTitle": "REPRESENTATION",
"activity_status": "Normal",
"activity_venue": "PB AMHS",
"idVenue": 137,
"start": "2019-05-21 04:30:00",
"end": "2019-05-21 07:00:00"
},
{
"activity_id": 8885,
"activity_type": "REPRESENTATION",
"activity_type_otherLanguageTitle": "REPRESENTATION",
"activity_status": "Normal",
"activity_venue": "Nef ’nord",
"idVenue": 2,
"start": "2019-05-22 14:45:00",
"end": "2019-05-22 17:15:00"
}
]
}
You can access the production's custom fields through the get production call or by a direct call.
doCurl('/production/customFields/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
$data = array(
"fieldId" => "12,3,5",
"notFieldId" => "8",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| fieldId | the list of the field's Ids you want. They must be separated by a comma. | string |
| notFieldId | the list of the field's Ids you DON'T want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_id | integer | |
| fieldgroup_title | string | |
| fieldgroup_order | integer | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Libretto"
["field_id"]=>
int(85)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "From original work (ex : literary)"
["field_id"]=>
int(86)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[2]=>
object(stdClass)#20 (5) {
["field_title"]=>
string(7) "Edition"
["field_id"]=>
int(87)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
}
}
You can access the production Level 1 through the get production call or by a direct call.
If you want more data about the production L1, we recommend to use the get production L1 call (id production L1 required).
doCurl('/production/productionsL1/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionL1_id | integer | |
| productionL1_title | string | |
| linkPPL1_id | integer | |
| linkPPL1_order | integer | |
| linkPPL1_duration | string | |
| LinkPPL1_customText | string | |
| LinkPPL1_customText2 | string | |
| linkPPL1_status_id | integer | |
| linkPPL1_status_title | string | |
| linkPPL1_status_titleShort | string | |
| linkPPL1_movements | array | |
| movement_id | integer | |
| movement_title | string | |
| movement_number | integer | |
| movement_duration | format "HH:MM" | |
| linkPPL1_movement_order | integer | |
object(stdClass)#15 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (2) {
["productionL1_id"]=>
int(2)
["productionL1_title"]=>
string(11) "La Traviata"
}
}
}
You can access the production planification statuses through the get production call or by a direct call.
doCurl('/production/planificationStatuses/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| planificationStatus_id | integer | |
| planificationStatus_title | string | |
| planificationStatus_order | integer | |
object(stdClass)#15 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (2) {
["planificationStatus_id"]=>
int(2)
["planificationStatus_id"]=>
string(11) "published"
["planificationStatus_id"]=>
int(1)
}
}
}
You can access the production series statuses through the get production call or by a direct call.
doCurl('/production/series/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| serie_id | integer | |
| serie_title | string | |
| serieType_id | integer | |
| serieType_title | string | |
| linkPSerie_order | integer | |
| linkSerieP_order | integer | |
| linkPSerie_status_id | integer | |
| linkPSerie_status_title | string | |
| linkPSerie_status_titleShort | string | |
object(stdClass)#15 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (2) {
["act_id"]=>
int(2)
["act_title"]=>
string(7) "Serie 1"
["serie_order"]=>
int(1)
["linkPSerie_status_id"]=>
int(1)
["linkPSerie_status_title"]=>
string(9) "Confirmed"
["linkPSerie_status_titleShort"]=>
string(1) "C"
}
}
}
You can access the production's breakdown through the get production call or by a direct call.
doCurl('/production/breakdown/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| act_id | integer | |
| act_title | string | |
| act_titleShort | string | |
| act_interval | integer boolean (0,1) | |
| act_duration | format "HH:MM:SS" | |
| act_order | integer | |
| groups | By default the scenes are linked to no group (NULL) | array |
| group_id | integer or NULL | |
| group_title | string or NULL | |
| scenes | array | |
| scene_id | integer | |
| scene_title | string | |
| scene_titleShort | string | |
| scene_duration | format "HH:MM:SS" | |
| scene_page | string | |
| scene_note | string | |
| scene_order | integer | |
| scene_roles | array | |
| scene_role_id | integer | |
| role_id | integer | |
| role_title | string | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
{
"error": false,
"errorCode": 0,
"message": [
{
"act_id": 357,
"act_title": "Acte 1",
"act_titleShort": "A1",
"act_interval": 0,
"act_duration": "01:00:00",
"act_order": 1,
"groups": [
{
"group_id": null,
"group_title": null,
"scenes": [
{
"scene_id": 327,
"scene_title": "Scene 1",
"titleShort": null,
"scene_duration": "01:00:00",
"scene_page": "",
"scene_note": "",
"scene_order": 1
"scene_roles": [
{
"scene_role_id": 12,
"role_id": 78,
"role_title": "Direction musicale",
"roleFunction_id": 1,
"roleFunction_title": "Role function title",
"contact_id": 131,
"contact_lastName": "DOE",
"contact_firstName": "John"
}
]
}
]
}
]
},
{
"act_id": 358,
"act_title": "Acte 2",
"act_titleShort": "A2",
"act_interval": 0,
"act_duration": "03:12:03",
"act_order": 2,
"groups": [
{
"group_id": null,
"group_title": null,
"scenes": [
{
"scene_id": 328,
"scene_title": "Scene 1",
"titleShort": null,
"scene_duration": "00:06:00",
"scene_page": "",
"scene_note": "",
"scene_order": 1
},
{
"scene_id": 329,
"scene_title": "Scene 2",
"titleShort": null,
"scene_duration": "03:00:03",
"scene_page": "",
"scene_note": "",
"scene_order": 2
}
]
},
{
"group_id": 20,
"group_title": "Scene de la chasse",
"scenes": [
{
"scene_id": 330,
"scene_title": "Scene 3",
"titleShort": null,
"scene_duration": "00:06:00",
"scene_page": "A",
"scene_note": "aze",
"scene_order": 3
},
{
"scene_id": 331,
"scene_title": "scene 4",
"titleShort": null,
"scene_duration": "00:00:00",
"scene_page": "",
"scene_note": "",
"scene_order": 10
}
]
}
]
}
]
}
You can access the production's file through the get production call or by a direct call.
doCurl('/production/files/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
$data = array(
"imageOnly" => true,
"idFolder" => "8",
"validityDuration" => "300",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| imageOnly | Set to true if you only want the images. | boolean |
| idFolder | the list of the folder Ids you want. They must be separated by a comma. | string |
| validityDuration | The validity duration in seconds. Default is 300 seconds. | int |
| Name | Description | Type |
|---|---|---|
| Message | ||
| upload_id | int | |
| path | This is a temporary path. It is available for 5 minutes to allow you to download the file. | string |
| upload_title | string | |
| created_by | int | |
| created_date | string | |
| edited_by | int | |
| edited_date | string | |
| folder_id | int | |
| folder_title | string | |
"error": false,
"message": [
{
"path": "https://static.diese.io/get/XXXX",
"upload_title": "Main photo.jpg",
"created_by": 1,
"created_date": "2021-04-13 14:04:52",
"edited_by": 0,
"edited_date": "0000-00-00 00:00:00",
"folder_id": 8,
"folder_title": Photos
},
]
You can access the production centers through the get production call or by a direct call.
doCurl('/production/productionCenters/{idProduction}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProduction | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionCenter_id | int | |
| productionCenter_code | string | |
| productionCenter_title | string | |
| productionCenter_main | int | |
{
"error": false,
"errorCode": 0,
"message": [
{
"productionCenter_id": 2,
"productionCenter_code": "1401",
"productionCenter_title": "Main production center",
"productionCenter_main": 1
},
{
"productionCenter_id": 1,
"productionCenter_code": "1202",
"productionCenter_title": "Second production center,
"productionCenter_main": 0
},
{
"productionCenter_id": 35,
"productionCenter_code": "1725",
"productionCenter_title": "Third production center",
"productionCenter_main": 0
}
]
}
doCurl('productionType/{idProductionType}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionType | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionType_id | int | |
| productionType_title | string | |
| productionType_order | int | |
{
"error": false,
"message": [
{
"productionType_id": 1,
"productionType_title": "Lyrical",
"productionType_order": 1
}
]
}
doCurl('productionTypes/',{data})
See get production type's basic info
doCurl('productionStatus/{idProductionStatus}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionStatus | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionStatus_id | int | |
| productionStatus_title | string | |
| productionStatus_titleShort | string | |
| productionStatus_order | int | |
{
"error": false,
"message": [
{
"productionStatus_id": 1,
"productionStatus_title": "Provisional",
"productionStatus_titleShort": "PRO",
"productionStatus_order": 1
}
]
}
doCurl('productionStatuses/',{data})
See get production status's basic info
doCurl('planificationStatus/{idPlanificationStatus}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idPlanificationStatus | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| planificationStatus_id | int | |
| planificationStatus_title | string | |
| planificationStatus_titleShort | string | |
| planificationStatus_order | int | |
{
"error": false,
"message": [
{
"planificationStatus_id": 2,
"planificationStatus_title": "Planification générale",
"planificationStatus_titleShort": "PG",
"planificationStatus_order": 1
}
]
}
doCurl('planificationStatuses/',{data})
See get planification status's basic info
doCurl('productionL1/{idProductionL1}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL1 | integer | Required |
$data = array(
"getCast" => true,
"getActivities" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCast | Set to true if you want to directly get the production L1's cast. | boolean |
| getProductionsL2 | Set to true if you want to directly get the production L1's production Level 2. | boolean |
| getCustomFields | Set to true if you want to directly get the production L1's custom fields. | boolean |
| getFiles | Set to true if you want to directly get the L1's files. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionL1_id | integer | |
| productionL1_title | string | |
| productionL1_duration | string | |
| productionL1_premiereDate | YYYY-MM-DD | |
| productionL1_titleShort | string | |
| productionL1_ownLanguageTitle | string | |
| productionL1Type_id | integer | |
| productionL1Type_title | string | |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
| _links | ! not available in a get productions L1 call. You have to use the direct calls instead. | |
| getCast | string | |
| getProductionL2 | string | |
| getCustomFields | string | |
object(stdClass)#5 (4) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (7) {
["productionL1_id"]=>
int(2)
["productionL1_title"]=>
string(11) "La Traviata"
["productionL1_duration"]=>
string(8) "02:15:00"
["productionL1_premiereDate"]=>
string(10) "1980-02-01"
["productionL1_titleShort"]=>
string(4) "TRAV"
["productionL1_ownLanguageTitle"]=>
string(11) "La Traviata"
["productionL1Type_id"]=>
int(1)
["productionL1Type_title"]=>
string(5) "Opera"
}
}
["_links"]=>
object(stdClass)#17 (2) {
["getCast"]=>
string(18) "productionL1/cast/"
["getProductionL2"]=>
string(26) "productionL1/productionL2/"
}
}
doCurl('productionsL1/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL1 | integers separated by commas |
You can access the production's cast through the get production L1 call or by a direct call
doCurl('productionL1/cast/{idProductionL1}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL1 | integer | Required |
$data = array(
"function" => "12,3,5",
"notRoleCategory" => "27"
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| function | the list of the function's Ids you want. They must be separated by a comma. | string |
| notFunction | the list of the function's Ids you DON'T want. They must be separated by a comma. | string |
| roleCategory | the list of the role categorie's Ids you want. They must be separated by a comma. | string |
| notRoleCategory | the list of the role categorie's Ids you DON'T want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| role_shortTitle | string | |
| role_title | string | |
| role_id | integer | |
| role_order | integer | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleCategory_order | integer | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
object(stdClass)#5 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(6) {
[0]=>
object(stdClass)#18 (8) {
["contact_id"]=>
int(2600)
["contact_lastName"]=>
string(3) "Doe"
["contact_firstName"]=>
string(4) "Jane"
["role_id"]=>
int(18)
["role_title"]=>
string(16) "Violetta Valéry"
["roleCategory_id"]=>
int(3)
["roleCategory_title"]=>
string(8) "Solistes"
["roleCategory_order"]=>
int(10)
}
[1]=>
object(stdClass)#19 (8) {
["contact_id"]=>
int(2610)
["contact_lastName"]=>
string(3) "Doe"
["contact_firstName"]=>
string(4) "John"
["role_id"]=>
int(19)
["role_title"]=>
string(15) "Alfredo Germont"
["roleCategory_id"]=>
int(3)
["roleCategory_title"]=>
string(8) "Solistes"
["roleCategory_order"]=>
int(10)
}
[2]=>
object(stdClass)#21 (8) {
["contact_id"]=>
int(2615)
["contact_lastName"]=>
string(5) "Verdi"
["contact_firstName"]=>
string(9) "Giuseppe "
["role_id"]=>
int(34)
["role_title"]=>
string(8) "Composer"
["roleCategory_id"]=>
int(2)
["roleCategory_title"]=>
string(20) "Equipe de production"
["roleCategory_order"]=>
int(1)
}
}
}
You can access the production's custom fields through the get production L1 call or by a direct call
doCurl('productionL1/customFields/{idProductionL1}')
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_title | string | |
| fieldgroup_id | integer | |
| fieldgroup_order | integer | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Classif 21"
["field_id"]=>
int(27)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "Work details"
["fieldgroup_id"]=>
int(1)
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "Classif 20"
["field_id"]=>
int(28)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "Work details"
["fieldgroup_id"]=>
int(1)
}
}
}
You can access the production Level 2 through the get production L1 call or by a direct call.
If you want more data about the production L2, we recommend to use the get production L2 call (id production L2 required).
doCurl('/productionL1/productionL2/{idProductionL1}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL1 | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionL2_id | integer | |
| productionL2_title | string | |
object(stdClass)#5 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (2) {
["productionL2_id"]=>
int(4)
["productionL2_title"]=>
string(11) "La Traviata"
}
}
}
You can access the production Level 1 file through the get production Level 1 call or by a direct call.
doCurl('/productionL1/files/{idProductionL1}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| productionL1 | integer | Required |
$data = array(
"imageOnly" => true,
"idFolder" => "8",
"validityDuration" => "300",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get productionL1 call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| imageOnly | Set to true if you only want the images. | boolean |
| idFolder | the list of the folder Ids you want. They must be separated by a comma. | string |
| validityDuration | The validity duration in seconds. Default is 300 seconds. | int |
| Name | Description | Type |
|---|---|---|
| Message | ||
| upload_id | int | |
| path | This is a temporary path. It is available for 5 minutes to allow you to download the file. | string |
| upload_title | string | |
| created_by | int | |
| created_date | string | |
| edited_by | int | |
| edited_date | string | |
| folder_id | int | |
| folder_title | string | |
"error": false,
"message": [
{
"path": "https://static.diese.io/get/XXXX",
"upload_title": "Main photo.jpg",
"created_by": 1,
"created_date": "2021-04-13 14:04:52",
"edited_by": 0,
"edited_date": "0000-00-00 00:00:00",
"folder_id": 8,
"folder_title": Photos
},
]
doCurl('productionL2/{idProductionL2}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL2 | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionL2_id | integer | |
| productionL2_title | string | |
| productionL2_creationDate | string | |
| productionL2_ownLanguageTitle | string | |
| productionL2Type_id | integer | |
| productionL2Type_title | string | |
| productionL2_premiereDate | YYYY-MM-DD | |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
| _links | ! not available in a get productions L2 call. You have to use the direct calls instead. | |
| getCast | string | |
| getCustomFields | string | |
object(stdClass)#17 (4) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(1) {
[0]=>
object(stdClass)#18 (6) {
["productionL2_id"]=>
int(4)
["productionL2_title"]=>
string(11) "La Traviata"
["productionL2_creationDate"]=>
string(10) "1853-03-06"
["productionL2_ownLanguageTitle"]=>
string(11) "La Traviata"
["productionL2Type_id"]=>
int(1)
["productionL2Type_title"]=>
string(5) "Opera"
["productionL1_premiereDate"]=>
string(10) "1980-02-01"
}
}
["_links"]=>
object(stdClass)#19 (1) {
["getCast"]=>
string(18) "productionL2/cast/"
}
}
doCurl('productionsL2/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL2 | integers separated by commas |
You can access the production's cast through the get production L2 call or by a direct call
doCurl('productionL2/cast/{idProductionL2}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idProductionL2 | integer | Required |
$data = array(
"function" => "12,3,5",
"notRoleCategory" => "27"
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| function | the list of the function's Ids you want. They must be separated by a comma. | string |
| notFunction | the list of the function's Ids you DON'T want. They must be separated by a comma. | string |
| roleCategory | the list of the role categorie's Ids you want. They must be separated by a comma. | string |
| notRoleCategory | the list of the role categorie's Ids you DON'T want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| role_shortTitle | string | |
| role_title | string | |
| role_id | integer | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleCategory_order | integer | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
object(stdClass)#17 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(9) {
[0]=>
object(stdClass)#18 (8) {
["contact_id"]=>
int(123)
["contact_lastName"]=>
string(5) "Verdi"
["contact_firstName"]=>
string(8) "Giuseppe"
["role_id"]=>
int(8)
["role_title"]=>
string(11) "Compositeur"
["roleCategory_id"]=>
int(2)
["roleCategory_title"]=>
string(20) "Equipe de production"
["roleCategory_order"]=>
int(1)
}
[1]=>
object(stdClass)#22 (8) {
["contact_id"]=>
int(402)
["contact_lastName"]=>
string(5) "Piave"
["contact_firstName"]=>
string(15) "Francesco Maria"
["role_id"]=>
int(12)
["role_title"]=>
string(11) "Librettiste"
["roleCategory_id"]=>
int(2)
["roleCategory_title"]=>
string(20) "Equipe de production"
["roleCategory_order"]=>
int(1)
}
}
}
You can access the production's custom fields through the get production L2 call or by a direct call
doCurl('productionL2/customFields/{idProductionL2}')
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| fieldgroup_title | string | |
| fieldgroup_id | integer | |
| fieldgroup_order | integer | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Classif 21"
["field_id"]=>
int(27)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "Work details"
["fieldgroup_id"]=>
int(1)
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "Classif 20"
["field_id"]=>
int(28)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "Work details"
["fieldgroup_id"]=>
int(1)
}
}
}
doCurl('season/{idSeason}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idSeason | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| season_id | int | |
| season_title | string | |
| season_start | string | |
| season_end | string | |
| season_order | integer | |
object(stdClass)#1 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#2 (10) {
["season_id"]=>
int(373)
["season_title"]=>
string(0) ""
["season_start"]=>
string(8) "02:15:00"
["season_end"]=>
string(8) "02:15:00"
["season_ordre"]=>
int(8)
}
}
}
doCurl('seasons/',{data})
doCurl('serie/{idSerie}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idSerie | integer | Required |
$data = array(
"getCast" => true,
"getActivities" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCustomFields | Set to true if you want to directly get the serie's custom fields. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| serie_id | int | |
| serie_title | string | |
| serie_titleShort | string | |
| serieType_id | integer | |
| serieType_title | string | |
| serieType_order | integer | |
object(stdClass)#1 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#2 (10) {
["serie_id"]=>
int(373)
["serie_title"]=>
string(10) "La série 1"
["serie_titleShort"]=>
string(2) "S1"
["serieType_id"]=>
int(1)
["serieType_title"]=>
string(14) "Type série 1 z"
}
}
}
doCurl('series/',{data})
You can access the activity's custom fields through the get serie call or by a direct call.
doCurl('/serie/customFields/{idSerie}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idSerie | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_id | integer | |
| fieldgroup_title | string | |
| fieldgroup_order | integer | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Libretto"
["field_id"]=>
int(85)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "From original work (ex : literary)"
["field_id"]=>
int(86)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[2]=>
object(stdClass)#20 (5) {
["field_title"]=>
string(7) "Edition"
["field_id"]=>
int(87)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
}
}
doCurl('activity/{idActivity}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| activity_id | integer | |
| created_date | string | |
| note | string | |
| extra_description | string | |
| start | string | |
| end | string | |
| created_by | string | |
| edited_by | string | |
| edited_date | string | |
| activity_type | string | |
| activity_type_otherLanguageTitle | string | |
| activity_type_id | integer | |
| activity_status | string | |
| activity_status_id | integer | |
| activity_venue | string | |
| venue_id | integer | |
| activity_production | string | |
| production_id | integer | |
| technical_minutes_before | integer | |
| technical_minutes_after | integer | |
| activity_type_detail | string | |
| activity_venue_detail | string | |
| activity_linkVenueContact | int | |
| _links | ! not available in a get activities call. You have to use the direct calls instead. | |
| getCustomFields | string | |
| getActivityNeeds | string | |
| getVenues | string | |
| getSeries | string | |
| getActivityType | string | |
| getAttendingArtists | string | |
| getProductionsL1 | string | |
| getFiles | Set to true if you want to directly get the activity's files. | boolean |
$data = array(
"getCustomFields" => true,
"getActivities" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCustomFields | Set to true if you want to directly get the activity's custom fields. | boolean |
| getActivityNeeds | Set to true if you want to directly get the activity's needs. | boolean |
| getVenue | Set to true if you want to directly get the activity's venue. | boolean |
| getSeries | Set to true if you want to directly get the activity's series. | boolean |
| getAttendingArtists | Set to true if you want to directly get the activity's attending artists. | boolean |
| getActivityType | Set to true if you want to directly have more information about the activity type. | boolean |
| getProductionsL1 | Set to true if you want to directly have more information about the linked productions L1. | boolean |
object(stdClass)#230 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#231 (15) {
["id"]=>
int(666)
["created_date"]=>
string(19) "2018-04-24 12:07:22"
["note"]=>
string(0) ""
["extra_description"]=>
string(0) ""
["start"]=>
string(19) "2018-05-21 09:00:00"
["end"]=>
string(19) "2018-05-21 11:00:00"
["created_by"]=>
string(16) "Admin IT4Culture"
["edited_by"]=>
NULL
["edited_date"]=>
string(19) "0000-00-00 00:00:00"
["activity_type"]=>
string(6) "Lights"
["activity_type_otherLanguageTitle"]=>
string(6) "Lights"
["activity_status"]=>
string(11) "Provisional"
["activity_venue"]=>
string(30) "Main Stage"
["idVenue"]=>
int(1)
["activity_production"]=>
string(6) "Le Cid"
["production_id"]=>
int(15)
["technical_minutes_before"]=>
int(0)
["technical_minutes_after"]=>
int(0)
["activity_type_detail"]=>
string(7) "Dancers"
["activity_venue_detail"]=>
string(5) "Stage"
}
}
["_links"]=>
object(stdClass)#3 (1) {
["getCustomFields"]=>
string(70) "activity/customFields/666"
["getActivityNeeds"]=>
string(70) "activity/activityNeeds/666"
}
}
doCurl('activities/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| idProduction | integers separated by commas | ||
| idActivityTypeSystem | integers separated by commas | ||
| idActivityType | integers separated by commas | ||
| idActivityStatus | integers separated by commas | ||
| idActivityVenue | integers separated by commas | ||
| notIdActivityStatus | integers separated by commas | ||
| getCustomFields | Set to true if you want to directly get the activity's custom fields. | boolean | |
| getActivityNeeds | Set to true if you want to directly get the activity's needs. | boolean | |
| getVenue | Set to true if you want to directly get the activity's venue. | boolean | |
| getSeries | Set to true if you want to directly get the activity's series. | boolean | |
| getAttendingArtists | Set to true if you want to directly get the activity's attending artists. | boolean | |
| getActivityType | Set to true if you want to directly have more information about the activity type. | boolean | |
| getProductionsL1 | Set to true if you want to directly have more information about the linked productions L1. | boolean | |
| getFiles | Set to true if you want to directly get the activity's files. | boolean |
You can access the activity's custom fields through the get activity call or by a direct call.
doCurl('/activity/customFields/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
$data = array(
"fieldId" => "12,3,5",
"notFieldId" => "8",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| fieldId | the list of the field's Ids you want. They must be separated by a comma. | string |
| notFieldId | the list of the field's Ids you DON'T want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_id | integer | |
| fieldgroup_title | string | |
| fieldgroup_order | integer | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Libretto"
["field_id"]=>
int(85)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "From original work (ex : literary)"
["field_id"]=>
int(86)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
[2]=>
object(stdClass)#20 (5) {
["field_title"]=>
string(7) "Edition"
["field_id"]=>
int(87)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
["fieldgroup_id"]=>
int(20)
}
}
}
You can access the activity's needs through the get activity call or by a direct call.
doCurl('/activity/activityNeeds/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| need_id | integer | |
| need_note | string | |
| need_start | string | |
| need_end | string | |
| need_number | string | |
| need_task | string | |
| need_department | string | |
object(stdClass)#1 (2) {
["error"]=>
bool(false)
["message"]=>
array(5) {
[0]=>
object(stdClass)#2 (7) {
["need_id"]=>
int(373)
["need_note"]=>
string(0) ""
["need_start"]=>
string(8) "02:15:00"
["need_end"]=>
string(8) "05:15:00"
["need_number"]=>
string(5) "12.00"
["need_task"]=>
string(13) "Accueil' mat."
["need_department"]=>
string(9) "Ticketing"
}
[1]=>
object(stdClass)#3 (7) {
["need_id"]=>
int(374)
["need_note"]=>
string(0) ""
["need_start"]=>
string(8) "02:15:00"
["need_end"]=>
string(8) "05:15:00"
["need_number"]=>
string(4) "5.00"
["need_task"]=>
string(5) "T.A.P"
["need_department"]=>
string(11) "Accueil"
}
[2]=>
object(stdClass)#4 (7) {
["need_id"]=>
int(375)
["need_note"]=>
string(4) "test"
["need_start"]=>
string(8) "02:15:00"
["need_end"]=>
string(8) "05:15:00"
["need_number"]=>
string(5) "12.00"
["need_task"]=>
string(13) "Accueil"
["need_department"]=>
string(9) "Ticketing"
}
}
}
You can access the activity series statuses through the get activity call or by a direct call.
doCurl('/activity/series/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| serie_id | integer | |
| serie_title | string | |
| linkActivitySerie_order | integer | |
| linkActivitySerie_status_id | integer | |
| linkActivitySerie_status_title | string | |
| linkActivitySerie_status_titleShort | string | |
object(stdClass)#15 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#16 (2) {
["serie_id"]=>
int(2)
["serie_title"]=>
string(7) "Serie 1"
["linkActivitySerie_order"]=>
int(1)
["linkActivitySerie_status_id"]=>
int(1)
["linkActivitySerie_status_title"]=>
string(9) "Confirmed"
["linkActivitySerie_status_titleShort"]=>
string(1) "C"
}
}
}
You can access the activity attending artists through the get activity call or by a direct call.
doCurl('/activity/attendingArtists/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
| Name | Description | Type |
|---|---|---|
| data | You can use the data array in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| getProductionsL1 | Set to true if you want to see the production L1s linked to this role. | boolean |
| onlyPublishedShifts | Set to true if you want to see only published shifts | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| role_title | string | |
| role_id | integer | |
| role_groupingKey | integer | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleCategory_order | integer | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
| attendingArtist_isCover | Integer boolean (0,1) | |
| attendingArtist_task_id | integer | |
| attendingArtist_task_title | string | |
| shift_note | string | |
| shift_id | integer | |
| replacedContact_id | integer | |
| replacedRole_id | integer | |
| created_by | int | |
| created_date | string | |
| edited_by | int | |
| edited_date | string | |
You can access the activity productions L1 through the get activity call or by a direct call.
doCurl('/activity/productionsL1/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivity | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| productionL1_id | integer | |
| productionL1_title | string | |
| linkPPL1_order | integer | |
You can access the activity file through the get activity call or by a direct call.
doCurl('/activity/files/{idActivity}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| activity | integer | Required |
$data = array(
"imageOnly" => true,
"idFolder" => "8",
"validityDuration" => "300",
);
| Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get activity call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| imageOnly | Set to true if you only want the images. | boolean |
| idFolder | the list of the folder Ids you want. They must be separated by a comma. | string |
| validityDuration | The validity duration in seconds. Default is 300 seconds. | int |
| Name | Description | Type |
|---|---|---|
| Message | ||
| upload_id | int | |
| path | This is a temporary path. It is available for 5 minutes to allow you to download the file. | string |
| upload_title | string | |
| created_by | int | |
| created_date | string | |
| edited_by | int | |
| edited_date | string | |
| folder_id | int | |
| folder_title | string | |
"error": false,
"message": [
{
"path": "https://static.diese.io/get/XXXX",
"upload_title": "Main photo.jpg",
"created_by": 1,
"created_date": "2021-04-13 14:04:52",
"edited_by": 0,
"edited_date": "0000-00-00 00:00:00",
"folder_id": 8,
"folder_title": Photos
},
]
doCurl('activityType/{idActivityType}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivityType | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| activityType_id | int | |
| activityType_title | string | |
| activityType_titleShort | string | |
| activityType_order | int | |
| activityTypeGroup_id | int | |
| activityTypeGroup_title | string | |
| activityTypeGroup_order | int | |
| activityTypeSystem_id | int | |
| activityTypeSystem_title | string | |
{
"error": false,
"message": [
{
"activityType_id": 1,
"activityType_title": "Scène piano",
"activityType_titleShort": "SP",
"activityType_order": 130,
"activityTypeGroup_id": 1,
"activityTypeGroup_title": "Groupe 1",
"activityTypeGroup_order": 1,
"activityTypeSystem_id": 3,
"activityTypeSystem_title": "Rehearsal"
}
]
}
doCurl('activityTypes/',{data})
See get activity type's basic info
doCurl('activityStatus/{idActivityStatus}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivityStatus | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| activityStatus_id | int | |
| activityStatus_title | string | |
| activityStatus_order | int | |
{
"error": false,
"message": [
{
"activityStatus_id": 2,
"activityStatus_title": "Confirmed",
"activityStatus_order": 100
}
]
}
doCurl('activityStatuses/',{data})
See get activity status's basic info
doCurl('activityNeed/{idActivityNeed}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idActivityNeed | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| need_id | int | |
| need_note | string | |
| need_start | string | |
| need_end | string | |
| need_number | string | |
| need_task | string | |
| need_task_id | int | |
| need_department | string | |
| need_department_id | int | |
| activity_id | int | |
object(stdClass)#1 (2) {
["error"]=>
bool(false)
["message"]=>
array(1) {
[0]=>
object(stdClass)#2 (10) {
["need_id"]=>
int(373)
["need_note"]=>
string(0) ""
["need_start"]=>
string(8) "02:15:00"
["need_end"]=>
string(8) "05:15:00"
["need_number"]=>
string(5) "12.00"
["need_task"]=>
string(13) "Accueil' mat."
["need_task_id"]=>
int(3)
["need_department"]=>
string(9) "Ticketing"
["need_department_id"]=>
int(10)
["activity_id"]=>
int(5799)
}
}
}
doCurl('activityNeeds/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| idNeed | integers separated by commas | ||
| idActivity | integers separated by commas |
See get activity Need's basic info
See get activity Need's basic info
doCurl('venue/{idVenue}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idVenue | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| venue_id | int | |
| venue_title | string | |
| venue_order | integer | |
| venue_localisation | string | |
| venue_localisation2 | string | |
| venueGroup_id | int | |
| venueGroup_title | string | |
| contact_id | int | |
| contact_lastName | string | |
| contact_firstName | string | |
doCurl('venues/',{data})
doCurl('contact/{idContact}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
$data = array(
"getCast" => true,
"getActivities" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getContactAddresses | Set to true if you want to directly get the contact's addresses. | boolean |
| getCustomFields | Set to true if you want to directly get the contact's custom fields. | boolean |
| getCommElements | Set to true if you want to directly get the contact's communication elements. | boolean |
| getFormSheets | Set to true if you want to directly get the contact's form sheet list. | boolean |
| getCalendar | Set to true if you want to directly get the contact's calendar. | boolean |
| getProductions | Set to true if you want to directly get the contact's produtions. | boolean |
| getFiles | Set to true if you want to directly get the contact's files. | boolean |
| getDepartments | Set to true if you want to directly get the contact's departments. | boolean |
| getBankAccounts | Set to true if you want to directly get the contact's bank accounts. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| contact_civilLastName | string | |
| contact_civilFirstName | string | |
| contact_sexId | integer | |
| contact_sexTitle | string | |
| contact_birthdate | 'YYYY-MM-DD' | string |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
object(stdClass)#2 (6) {
["contact_id"]=>
int(4447)
["contact_lastName"]=>
string(5) "Doe"
["contact_firstName"]=>
string(7) "Jane"
["contact_sexId"]=>
int(1)
["contact_sexTitle"]=>
string(4) "Male"
["contact_birthdate"]=>
string(10) "0000-00-00"
}
doCurl('contacts/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integers separated by commas | ||
| onlyActive | boolean | ||
| nameLike | string | Will search on first and last name. Example: "Jo Do" search will have as result "Joe Doe, John Doe, Joel Down, Dorothy Joel" | |
| getContactAddresses | Set to true if you want to directly get the contact's addresses. | boolean | |
| getCustomFields | Set to true if you want to directly get the contact's custom fields. | boolean | |
| getCommElements | Set to true if you want to directly get the contact's communication elements. | boolean | |
| getFormSheets | Set to true if you want to directly get the contact's form sheet list. | boolean | |
| getCalendar | Set to true if you want to directly get the contact's calendar. | boolean | |
| getProductions | Set to true if you want to directly get the contact's prodution. | boolean | |
| getFiles | Set to true if you want to directly get the contact's files. | boolean | |
| getDepartments | Set to true if you want to directly get the contact's departments. | boolean | |
| getBankAccounts | Set to true if you want to directly get the contact's bank accounts. | boolean |
You can access the contact's addresses by a direct call
doCurl('contact/addresses/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
$data = array(
"addressType" => "2",
"addressMain" => 1
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| addressType | the list of the address type's Ids you want. They must be separated by a comma. | string |
| addressMain | Allow you to only have the main address. Two
possibilities: "1" : Main "0" : Not main |
integer |
| Name | Description | Type |
|---|---|---|
| Message | ||
| address_id | integer | |
| address_title | string | |
| address_type_id | integer | |
| address_type | string | |
| address_1 | string | |
| address_2 | string | |
| address_3 | string | |
| address_zipCode | string | |
| address_city | string | |
| country_id | integer | |
| country_title | string | |
| country_code | string | |
| address_main | 0 or 1 | integer |
object(stdClass)#4 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(3) {
[0]=>
object(stdClass)#5 (8) {
["address_id"]=>
int(42)
["address_title"]=>
string(15) "Default address"
["address_type_id"]=>
int(3)
["address_type"]=>
string(9) "Residence"
["address_1"]=>
string(16) "11 rue Duvergier"
["address_2"]=>
string(0) ""
["address_3"]=>
string(0) ""
["address_zipCode"]=>
string(5) "75019"
["address_city"]=>
string(5) "Paris"
["country_id"]=>
int(2)
["country_title"]=>
string(6) "France"
["country_code"]=>
string(2) "FR"
["address_main"]=>
int(1)
}
}
}
You can access the contact's communication elements by a direct call
doCurl('contact/commElements/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
$data = array(
"commElementType" => "2"
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| commElementType | the list of the communication element type's Ids you want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| commElement_id | integer | |
| commElement_value | string | |
| commElement_type_id | integer | |
| commElement_type_title | string | |
| country_id | integer | |
| country_title | string | |
| country_code | string | |
object(stdClass)#4 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(3) {
[0]=>
object(stdClass)#5 (8) {
["commElement_id"]=>
int(42)
["commElement_value"]=>
string(15) "+33 9 54 85 61 19"
["commElement_type_id"]=>
int(3)
["commElement_type_title"]=>
string(9) "Pro. phone"
["country_id"]=>
int(2)
["country_title"]=>
string(6) "France"
["country_code"]=>
string(2) "FR"
}
[1]=>
object(stdClass)#5 (8) {
["commElement_id"]=>
int(43)
["commElement_value"]=>
string(15) "john@doe.fr"
["commElement_type_id"]=>
int(4)
["commElement_type_title"]=>
string(9) "Pro. email"
["country_id"]=>
int(0)
["country_title"]=>
string(6) NULL
["country_code"]=>
string(2) NULL
}
}
}
You can access the contact's custom fields by a direct call
doCurl('contact/customFields/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_title | string | |
| field_id | integer | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_title | string | |
| fieldgroup_id | integer | |
| fieldgroup_order | integer | |
{
"error": false,
"message": [
{
"field_title": "Field",
"field_id": 72,
"field_value": null,
"field_value_ids": null,
"fieldgroup_title": "Field 72",
"fieldgroup_id": 15
}
]
}
You can access the production details linked to a contact through a direct call.
doCurl('contact/productions/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| production_id | integer | |
| production_title | string | |
| role_id | integer | |
| role_groupingKey | integer | |
| role_title | string | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
{
"error": false,
"message": [
{
"production_id": 12,
"production_title": "Production 15",
"role_id": 14,
"role_title": "Role title",
"roleCategory_id": 27,
"roleCategory_title ": "Role category title"
"roleFunction_id": 78,
"roleFunction_title ": "Role function title"
}
]
}
You can access the calendar details linked to a contact through a direct call.
doCurl('contact/calendar/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required | |
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| activityTypeId | integers separated by commas |
| Name | Description | Type |
|---|---|---|
| Message | ||
| shift_id | integer | |
| shift_start | string | |
| shift_end | string | |
| production_id | integer | |
| production_title | string | |
| absence_id | integer | |
| absence_title | string | |
| task_id | integer | |
| task_title | string | |
| venue_id | integer | |
| venue_title | string | |
| role_id | integer | |
| role_groupingKey | integer | |
| role_title | string | |
| roleCategory_id | integer | |
| roleCategory_title | string | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
| activity_id | integer | |
| activityType_id | integer | |
| activityType_title | string | |
| activity_status | string | |
| activity_venue | string | |
{
"error": false,
{
"message": [
{
"shift_id": 12,
"shift_start": "2025-02-11 08:00:00",
"shift_end": "2025-02-11 16:00:00",
"production_id": 15,
"production_title": "Production 15",
"absence_id": 7,
"absence_title": "Sick Leave",
"task_id": 22,
"task_title": "Stage Preparation",
"venue_id": 5,
"venue_title": "National Theater",
"role_id": 14,
"role_title": "Lighting Technician",
"roleCategory_id": 27,
"roleCategory_title": "Technical Team",
"roleFunction_id": 78,
"roleFunction_title": "Light Management",
"activity_id": 33,
"activityType_id": 4,
"activityType_title": "Rehearsal",
"activity_status": "Scheduled",
"activity_venue": "Main Hall"
}
]
}
}
You can access the contact's form sheets list by a direct call
doCurl('contact/formSheets/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| formSheet_id | integer | |
| form_id | integer | |
| form_title | string | |
| sheetType_id | integer | |
| sheetType_title | string | |
{
"error": false,
"message": [
{
"formSheet_id": 26,
"form_id": 1,
"form_title": "Make your own pizza",
"sheetType_id": 1,
"sheetType_title": "Make your own food"
}
]
}
You can access the contact's file through the get contact call or by a direct call.
doCurl('/contact/files/{idContact}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
$data = array(
"imageOnly" => true,
"idFolder" => "8",
"validityDuration" => "300",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get contact call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| imageOnly | Set to true if you only want the images. | boolean |
| idFolder | the list of the folder Ids you want. They must be separated by a comma. | string |
| validityDuration | The validity duration in seconds. Default is 300 seconds. | int |
| Name | Description | Type |
|---|---|---|
| Message | ||
| upload_id | int | |
| path | This is a temporary path. It is available for 5 minutes to allow you to download the file. | string |
| upload_title | string | |
| created_by | int | |
| created_date | string | |
| edited_by | int | |
| edited_date | string | |
| folder_id | int | |
| folder_title | string | |
"error": false,
"message": [
{
"path": "https://static.diese.io/get/XXXX",
"upload_title": "Main photo.jpg",
"created_by": 1,
"created_date": "2021-04-13 14:04:52",
"edited_by": 0,
"edited_date": "0000-00-00 00:00:00",
"folder_id": 8,
"folder_title": Photos
},
]
You can access the contact's form sheets list by a direct call
doCurl('contact/departments/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| department_id | integer | |
| department_title | string | |
{
"error": false,
"message": [
{
"department_id":1,
"department_title":"Comptabilité"
},
{
"department_id":2,
"department_title":"Menuiserie"
},
{
"department_id":4,
"department_title":"Restauration"
}
]
}
You can retrieve the contact's bank account information via a direct call
doCurl('contact/bankAccounts/{idContact}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContact | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| bankAccount_label | string | |
| bankAccount_owner | string | |
| bankAccount_name | string | |
| bankAccount_address | string | |
| bankAccount_iban | string | |
| bankAccount_bic | string | |
| bankAccount_routingNumber | int | |
| bankAccount_accountNumber | int | |
{
"error": false,
"message": [
{
"bankAccount_label": "Primary Business Account",
"bankAccount_owner": "John Doe",
"bankAccount_name": "Bank of Example",
"bankAccount_address": "123 Finance Avenue, 75001 Paris, France",
"bankAccount_iban": "FR76 3000 6000 0112 3456 7890 189",
"bankAccount_bic": "BEXAFRPPXXX",
"bankAccount_routingNumber": "026009593",
"bankAccount_accountNumber": "123456789012"
}
]
}
doCurl('contract/{idContract}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContract | integer | Required |
| Name | Description | Type | Additional information |
|---|---|---|---|
| getFinancialElements | Set to true if you want to directly get the contract's financial elements. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contract_id | integer | |
| contract_created_date | 'YYYY-MM-DD hh:mm:ss' | string |
| contract_updated_date | 'YYYY-MM-DD hh:mm:ss' | string |
| contract_order | integer | |
| roleFunction_id | integer | |
| roleFunction_title | string | |
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| contact_title_id | integer | |
| contact_title | string | |
| contract_type | integer | |
| contract_start | 'YYYY-MM-DD' changed the 24/10/19 |
string |
| contract_end | 'YYYY-MM-DD' changed the 24/10/19 |
string |
| contract_department | string | |
| contract_function | string | |
| production_id | integer | |
| production_title | string | |
| role_title | string | |
object(stdClass)#1 (3) {
["error"]=>
bool(false)
["errorCode"]=>
int(0)
["message"]=>
array(1) {
[0]=>
object(stdClass)#2 (11) {
["contract_id"]=>
int(4117)
["contract_order"]=>
int(3)
["roleFunction_id"]=>
int(12)
["roleFunction_title"]=>
string(5) "Soprano"
["contact_lastName"]=>
string(5) "Doe"
["contact_firstName"]=>
string(6) "Jane"
["contact_title_id"]=>
int(3)
["contact_title"]=>
string(5) "Miss"
["contract_type"]=>
string(6) "Singer"
["contract_start"]=>
string(10) "15-05-2018"
["contract_end"]=>
string(10) "21-07-2018"
["contract_department"]=>
string(10) "Production"
["contract_function"]=>
string(6) "Singer"
["production_id"]=>
int(67)
["production_title"]=>
string(10) "Carmen"
["role_title"]=>
string(4) "Carmen"
}
}
}
doCurl('contracts/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" |
|
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedBefore | Datetime | "YYYY-MM-DD hh:mm:ss" |
You can access the contract's custom fields by a direct call.
doCurl('/contract/customFields/{idContract}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContract | integer | Required |
$data = array(
"fieldId" => "12,3,5",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| fieldId | the list of the field's Ids you want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["field_title"]=>
string(8) "Libretto"
["field_id"]=>
int(85)
["field_value"]=>
string(0) ""
}
[1]=>
object(stdClass)#19 (5) {
["field_title"]=>
string(34) "From original work (ex : literary)"
["field_id"]=>
int(86)
["field_value"]=>
string(0) ""
["fieldgroup_title"]=>
string(10) "About work"
}
}
}
You can access the contract's third party contacts by a direct call.
doCurl('/contract/thirdPartyContacts/{idContract}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContract | integer | Required |
$data = array(
"fieldId" => "12,3,5",
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array in a get production call and in a direct call. It allows to refine your message. You can use all or a part of the parameters. | array |
| contractContactFunction | the list of the function's Ids you want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| contract_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
| contact_title_id | integer | |
| contact_title | string | |
| contract_contact_function_id | integer | |
| contract_contact_function | string | |
object(stdClass)#17 (2) {
["error"]=>
bool(false)
["message"]=>
array(3) {
[0]=>
object(stdClass)#18 (5) {
["contract_id"]=>
int(180)
["contact_lastName"]=>
string(3) "DOE"
["contact_firstName"]=>
string(4) "Jane"
["contact_title_id"]=>
int(2)
["contact_title"]=>
string(6) "Madame"
["contract_contact_function_id"]=>
int(2)
["contract_contact_function"]=>
string(14) "Est le contact"
}
}
}
You can access the contract's financial element by a direct call.
doCurl('/contract/financialElements/{idContract}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContract | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| financialElement_idLink | integer | |
| financialElement_id | integer | |
| financialElement_quantity | string | |
| financialElement_value | string | |
| financialElement_discount | string | |
| financialElement_total | string | |
| financialElement_note | string | |
| financialElementType_id | integer | |
| financialElementType_title | string | |
| financialElementGroup_id | integer | |
| financialElementGroup_title | string | |
| financialElement_createdBy | string | |
| financialElement_createdDate | string | |
| financialElement_editedBy | integer | |
| financialElement_editedDate | string | |
{
"financialElement_idLink": 5090,
"financialElement_id": 4459,
"financialElement_quantity": "0.00",
"financialElement_value": "1000.00000",
"financialElement_discount": "0.00000",
"financialElement_total": "900.00",
"financialElement_note": "",
"financialElementType_id": 58,
"financialElementType_title": "Salaire opéra",
"financialElementGroup_id": 1,
"financialElementGroup_title": "Salaires",
"financialElement_createdBy": 0,
"financialElement_createdDate": "0000-00-00 00:00:00",
"financialElement_editedBy": 0,
"financialElement_editedDate": "0000-00-00 00:00:00"
}
You can access the contract's rules and their values by a direct call.
doCurl('/contract/rules/{idContract}')
| Name | Description | Type | Additional information |
|---|---|---|---|
| idContract | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| rule_id | integer | |
| rule_title | Custom label of the rule | string |
| rule_code | Short code of the rule | string |
| rule_coef | Coefficient applied to the rule | string |
| rule_type | Type of rule: "counter" or "rule" | string |
| rulePeriod_monthStart | Starting month of the rule period (format: "01" to "12") | string |
| rulePeriod_monthEnd | Ending month of the rule period (format: "01" to "12") | string |
| ruleValues | Array of values associated with this rule | array |
| ruleValue_date | Date of the value (format: "YYYY-MM") | string |
| ruleValueType_id | integer | |
| ruleValueType_title | Type label of the value | string |
| ruleValue_result | Calculated or entered result value | string |
| ruleValue_note | Optional note for this value | string |
{
"error": false,
"message": [
{
"rule_id": 5,
"rule_title": "Overtime hours",
"rule_type": "counter",
"rule_code": "OT",
"rule_coef": "1.5",
"rulePeriod_monthStart": "01",
"rulePeriod_monthEnd": "12",
"ruleValues": [
{
"ruleValue_date": "2024-01",
"ruleValueType_id": 1,
"ruleValueType_title": "Monthly calculation",
"ruleValue_result": "15.5",
"ruleValue_note": "Extra shifts in January"
},
{
"ruleValue_date": "2024-02",
"ruleValueType_id": 1,
"ruleValueType_title": "Monthly calculation",
"ruleValue_result": "8.0",
"ruleValue_note": ""
}
]
},
{
"rule_id": 12,
"rule_title": "Performance bonus",
"rule_type": "rule",
"rule_code": "PERF",
"rule_coef": "1.0",
"rulePeriod_monthStart": "01",
"rulePeriod_monthEnd": "06",
"ruleValues": [
{
"ruleValue_date": "2024-06",
"ruleValueType_id": 2,
"ruleValueType_title": "Semester calculation",
"ruleValue_result": "500.00",
"ruleValue_note": "Q1-Q2 performance achieved"
}
]
}
]
}
doCurl('shift/:id)
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| shift_id | integer | |
| shift_type | string | |
| start | Datetime | |
| end | Datetime | |
| shift_note | string | |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
| contact_id | int | |
| contact_firstName | string | |
| contact_lastName | string | |
| contract_id | int | |
| activity_id | int | |
| activity_type_id | int | |
| activity_type_title | string | |
| activity_type_otherLanguageTitle | string | |
| task_id | int | |
| task_title | string | |
| absence_id | int | |
| absence_title | string | |
| venue_id | int | |
| venue_title | string | |
| production_id | int | |
| production_title | string | |
| replacedContact_id | integer | |
{
"error": false,
"total": 1,
"message": [
{
"shift_id": 16469,
"shift_type": "GTA",
"start": "2018-11-26 17:45:00",
"end": "2018-11-26 20:45:00",
"shift_note": "",
"contact_id": 685,
"contact_firstName": "John",
"contact_lastName": "DOE",
"contract_id": 1311,
"activity_id": 7000,
"activity_type_id": 14,
"activity_type_title": "REPRESENTATION",
"task_id": 0,
"task_title": "At. tremplins",
"absence_id": 8,
"absence_title": "Jours travaillés",
"venue_id": 139,
"venue_title": "Foyer III. Rang",
"production_id": 2928,
"production_title": "Bérénice"
"replacedContact_id: null
}
]
}
doCurl('shifts/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| startBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| startAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| endAfter | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| idContractType | string | ||
| idActivityType | string | ||
| idDayType | string | ||
| createdOrUpdatedBefore | Datetime | "YYYY-MM-DD hh:mm:ss" | |
| createdOrUpdatedAfter | Datetime | "YYYY-MM-DD hh:mm:ss" |
doCurl('stockItem/{idStockItem}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idStockItem | integer | Required |
$data = array(
"getCustomFields" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCustomFields | Set to true if you want to directly get the stock item's custom fields. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| stockItem_id | integer | |
| stockItem_title | string | |
| stockItem_barcode | string | |
| stockItem_barcode2 | string | |
| stockItem_quantity | integer | |
| stockItemModule_id | integer | |
| stockItemModule_title | string | |
| stockItemGroup_id | integer | |
| stockItemGroup_title | string | |
| stockItemType_id | integer | |
| stockItemType_title | string | |
| stockItemSupplier_id | integer | |
| stockItemSupplier_firstName | string | |
| stockItemSupplier_lastName | string | |
| stockItemChar1_id | combo type characteristic; commonly used for the item's origin | integer |
| stockItemChar1_title | string | |
| stockItemChar2_id | combo type characteristic; commonly used for the item's era | integer |
| stockItemChar2_title | string | |
| stockItemChar3_id | combo type characteristic; commonly used for the item's location | integer |
| stockItemChar3_title | string | |
| stockItemChar4_value | text type characteristic; commonly used for the item's size | string |
| stockItemChar5_value | number type characteristic; commonly used for the item's value | string |
| stockItemChar6_value | text type characteristic; commonly used for the item's reference | string |
| stockItemChar7_value | text type characteristic; | string |
| stockItemChar8_value | text type characteristic; | string |
| stockItemChar9_value | text type characteristic; | string |
| stockItemChar10_value | text type characteristic; | string |
| created_by | string | |
| created_date | string | |
| edited_by | string | |
| edited_date | string | |
{
"error": false,
"message": [
{
"stockItem_id": 108,
"stockItem_title": "Stroboscop",
"stockItem_barcode": "",
"stockItem_quantity": 2,
"stockItemModule_id": 4,
"stockItemModule_title": "Lights é",
"stockItemGroup_id": 6,
"stockItemGroup_title": "Spots",
"stockItemType_id": 11,
"stockItemType_title": "Stroboscop",
"stockItemSupplier_id": 284,
"stockItemSupplier_firstName": "",
"stockItemSupplier_lastName": "Fournitures & cie",
"stockItemChar1_id": null,
"stockItemChar1_title": null,
"stockItemChar2_id": null,
"stockItemChar2_title": null,
"stockItemChar3_id": 4,
"stockItemChar3_title": "sans module",
"stockItemChar4_value": "m4",
"stockItemChar5_value": "5.00000",
"stockItemChar6_value": "m6",
"stockItemChar7_value": "note1",
"stockItemChar8_value": "ch1",
"stockItemChar9_value": "ch2",
"stockItemChar10_value": "ch3",
"created_by": "John Doe",
"created_date": "2015-01-21 15:22:02",
"edited_by": null,
"edited_date": "0000-00-00 00:00:00"
}
]
}
doCurl('stockItems/',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idStockItemModule | integers separated by commas |
See get stock item's basic info
You can access the stock item's custom fields by a direct call.
doCurl('/stockItem/customFields/{idStockItem}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idStockItem | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_ids | string | |
| field_value_orders | string | |
| fieldgroup_id | integer | |
| fieldgroup_title | string | |
| fieldgroup_order | integer | |
{
"error": false,
"message": [
{
"field_title": "Colour",
"field_id": 4,
"field_value": "blue,green",
"field_value_ids": "1,2",
"fieldgroup_id": 3,
"fieldgroup_title": "Additional information"
},
{
"field_title": "Note",
"field_id": 5,
"field_value": "This is a note",
"field_value_ids": null,
"fieldgroup_id": 3,
"fieldgroup_title": "Additional information"
}
]
}
doCurl('/formSheet/{idFormSheet}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idFormSheet | integer | Required |
$data = array(
"getCustomFields" => true,
"getUploads" => true
); | Name | Description | Type |
|---|---|---|
| Message | ||
| formSheet_id | integer | |
| form_id | integer | |
| form_title | string | |
| contact_id | integer | |
| contact_lastName | string | |
| contact_firstName | string | |
{
"error": false,
"message": [
{
"formSheet_id": 4898,
"form_id": 1,
"form_title": "Form",
"contact_id": 3341,
"contact_lastName": "Doe",
"contact_firstName": "John",
}
]
}
You can access the form sheet's custom fields by a direct call.
doCurl('/formSheet/customFields/{idFormSheet}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idFormSheet | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_id | integer | |
| field_title | string | |
| field_order | integer | |
| field_value | string | |
| field_value_complement | Used only for some very specific cases. Ex: the textfields with "phone" as specific format. In this case we'll need the DIESE's country ID here (see get countries call) | string |
| field_value_ids | string | |
| field_value_orders | string | |
{
"error": false,
"message": [
{
"field_title": "Colour",
"field_id": 4,
"field_value": "blue,green",
"field_value_ids": "1,2",
"field_value_orders": "0,1",
},
{
"field_title": "Note",
"field_id": 5,
"field_value": "This is a note",
"field_value_ids": null,
field_value_orders: null
}
]
}
You can access the form sheet's uploads by a direct call.
doCurl('/formSheet/uploads/{idFormSheet}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idFormSheet | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| upload_id | integer | |
| upload_title | string | |
| upload_extension | string | |
| upload_content | File content encoded in base 64 | string |
{
"error": false,
"message": [
{
"upload_id": 687,
"upload_title": "mydsf",
"upload_extension": "pdf",
"upload_content": "JVBERi0xLjUKJeLjz9MKCjE[....]sdfzAAZERs=="
}
]
}
doCurl('form/{idForm}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idForm | integer | Required |
$data = array(
"getCustomFieldsStructure" => true
); | Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| getCustomFieldsStructure | Set to true if you want to directly get the form's custom fields structure. | boolean |
| Name | Description | Type |
|---|---|---|
| Message | ||
| form_id | integer | |
| form_title | string | |
| form_active | integer boolean (0,1) | |
| sheetType_id | integer | |
| sheetType_title | string | |
| production_id | int | |
| roleCategory_id | int | |
| documentType_id | int | |
{
"error": false,
"errorCode": 0,
"message": [
{
"form_id": 1,
"form_title": "Make your own pizza",
"form_active": 1,
"sheetType_id": 1,
"sheetType_title": "Make your own food"
}
]
}
You can access the form's custom fields structure by a direct call.
doCurl('/form/customFieldsStructure/{idForm}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idForm | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| field_title | string | |
| field_title_lg2 | string | |
| field_id | integer | |
| field_type | string | |
| field_mandatory | Integer boolean (0,1) | |
| field_active | Integer boolean (0,1) | |
| field_displayed | Integer boolean (0,1) | |
| field_order | integer | |
| field_specific_format | "phone","email" or NULL | string |
| fieldCombo_values | Only available for the combobox and multichoice types | Array |
| fieldCombo_id | integer | |
| fieldCombo_title | string | |
| fieldCombo_title_lg2 | string | |
| fieldCombo_active | Integer boolean (0,1) | |
| fieldCombo_displayed | Integer boolean (0,1) | |
| fieldCombo_order | integer | |
{
"error": false,
"message": [
{
"field_title": "Please make a choice",
"field_title_lg2": "",
"field_id": 32,
"field_type": "combobox",
"field_mandatory": 0,
"field_active": 1,
"field_displayed": 0,
"field_order": 1,
"fieldCombo_values": [
{
"fieldCombo_id": 47,
"fieldCombo_title": "tomato",
"fieldCombo_title_lg2": null,
"fieldCombo_active": 1,
"fieldCombo_displayed": 0,
"fieldCombo_order": 10
},
{
"fieldCombo_id": 48,
"fieldCombo_title": "potato",
"fieldCombo_title_lg2": null,
"fieldCombo_active": 1,
"fieldCombo_displayed": 0,
"fieldCombo_order": 20
}
]
},
{
"field_title": "Please specify your allergies",
"field_title_lg2": "",
"field_id": 19,
"field_type": "textfield",
"field_mandatory": 0,
"field_active": 1,
"field_displayed": 1,
"field_order": 180
},
{
"field_title": "Additional information",
"field_title_lg2": "",
"field_id": 17,
"field_type": "textarea",
"field_mandatory": 0,
"field_active": 1,
"field_displayed": 1,
"field_order": 160
}
]
}
doCurl('country/{idCountry}',{data})
| Name | Description | Type | Additional information |
|---|---|---|---|
| idCountry | integer | Required |
| Name | Description | Type |
|---|---|---|
| Message | ||
| country_id | integer | |
| country_title | string | |
| country_shortTitle | string | |
| country_order | integer | |
| countrySystem_id | int | |
| countrySystem_title | string | |
| roleCategory_id | int | |
| countrySystem_ISO_code | Universal code. Can be used to validate a phone number for example. | string |
{
"error": false,
"message": [
{
"country_id": 2,
"country_title": "France",
"country_shortTitle": "FRA",
"country_order": 10,
"countrySystem_id": 3,
"countrySystem_title": "France",
"countrySystem_ISO_code": "FR"
}
]
}
doCurl('countries/',{data})
doCurl('transcodifications/',{data})
$data = array(
"transcodification_reference" => "TRANSCO_LIEUX,TRANSCO_TYPEACTI"
);
| Name | Description | Type |
|---|---|---|
| data | You can use the data array. It allows you to gather your calls. You can use all or a part of the parameters. | array |
| transcodification_reference | The list of the references you want. They must be separated by a comma. | string |
| Name | Description | Type |
|---|---|---|
| Message | ||
| transcodification_id | integer | |
| transcodification_reference | string | |
| transcodification_source | string | |
| transcodification_target | string | |
| transcodification_comment | string | |
{
"error": false,
"message": [
{
"transcodification_id": 9,
"transcodification_reference": "TRANSCO_LIEUX",
"transcodification_source": "143",
"transcodification_target": "6",
"transcodification_comment": ""
},
{
"transcodification_id": 6,
"transcodification_reference": "TRANSCO_TYPEACTI",
"transcodification_source": "Opera",
"transcodification_target": "1",
"transcodification_comment": "comment result"
}
]
}
| error codes | description |
|---|---|
| 400 | The api key is missing |
| 401 | Access denied : Invalid Api key or client |
| 402 | Access denied : Invalid token |
| date | type | description |
|---|---|---|
| 18/08/2025 | Improvement | New data from the /contract and /contracts endpoints to retrieve roleFunction_id, roleFunction_title, and contract_order. |
| 28/07/2025 | Improvement | New call to retrieve the production budget centers linked to a production |
| 12/03/2025 | Improvement | Addition of the first date at the production level, productionL1, and productionL2. |
| 10/03/2025 | Improvement | Add a parameter to set file validity duration (default: 300s) |
| 10/03/2025 | Improvement | Add grouping keys for roles. |
| 10/03/2025 | Improvement | Add a parameter to set file validity duration (default: 300s) |
| 12/03/2025 | Improvement | Addition of the first date at the production level, productionL1, and productionL2. |
| 10/03/2025 | Improvement | Add grouping keys for roles. |
| 03/03/2025 | Improvement | Adding file retrieval for contact. |
| 11/02/2025 | Improvement | New request to retrieve the calendar linked to a contact. |
| 11/02/2025 | Improvement | New request to retrieve the productions linked to a contact. |
| 31/01/2025 | Improvement | Adding file retrieval for activity. |
| 19/12/2024 | Improvement | Adding file retrieval for production level 1. |
| 30/10/2024 | Improvement | New call to retrieve a production linked files. |
| 30/09/2024 | Improvement | new filters for activity custom fields. Available in getCustomFields and in activity/:id. |
| 10/09/2024 | Improvement | new filters for production activity type. Available in getActivities and in production/:id. |
| 05/09/2024 | Improvement | New entry for attendingArtists and shift calls: replacedContact_id. |
| 27/08/2024 | Improvement | New call: Get transcodifications basic info |
| 27/08/2024 | Improvement | new filters for production custom fields. Available in getCustomFields and in production/:id. |
| 18/04/2023 | Improvement | new entries availables in : production, activity > attending artists and productionL2 |
| 04/10/2022 | Improvement | New call: get production's breakdown |
| 24/09/2021 | Improvement | New filter for the production cast call. New call: get activitie's production L1 |
| 18/06/2021 | Improvement | New filters for the production and activity calls |
| 17/02/2021 | Improvement | Add of a new call: stock item |
| 22/04/2020 | Improvement |
Add of new values: Cast calls and Activity/Attending artists call : roleFunction_id,roleFunction_title production/Cast call:role_customText production: production_alternativeTitle production/productionL1: LinkPPL1_customText |
| 02/04/2020 | Improvement |
Add of contacts call Add of contact > custom fields call Add of direct calls for the contacts, series and productions L1 calls For all custom fields calls, add of the fiel_value_ids For all cast calls, add of role_order Add of created_by,created_date,edited_by,edited_date in productions and productions L1 calls Add of filters for productions call |
| 02/04/2020 | Bug correction | Wrong link order value for the production > serie call. |
| 06/02/2020 | Improvement | Add of several calls: Production activity, Production status, Planification status, Activity Types, Activity status |
| 12/12/2019 | Improvement |
Add of activity types call. Add of movement in the production > get PL1 call. Add of idActivityTypeSystem filter for the activities call. Add of the activity > get attending artists call. |
| 12/12/2019 | Doc correction | Wrong call for the series > get custom Fields call. |
| 06/11/2019 | Improvement | New!! Now you can regroup a main call with its _links thanks to an array of datas. Example: With a get production call, if you set getCast to true, and you will have in the response the production information and the cast. |
| 06/11/2019 | Improvement | New filter for the get activities call |
| 06/11/2019 | Improvement | New call: The venues |
| 24/10/2019 | Improvement |
NEW AUTHENTICATION SYSTEM. You don't have to authenticate in each
call anymore. You can now use a token. This mode improve drastically the response time of the calls. Two steps:
|
| 24/10/2019 | Improvement | New get contracts filters: createdOrUpdatedAfter and createdOrUpdatedBefore. |
| 24/10/2019 | Bug correction | In the contract call, the start and end information are now in 'YYYY-MM-DD' format, instead of 'DD-MM-YYYY'. |
| 24/10/2019 | Improvement |
Add of several informations (ex: contact_id in contract calls) |
| 24/10/2019 | Improvement |
Add of seasons and series calls. Add of a production call: get series |
| 09/08/2019 | Improvement | Add of production L1 > custom fields and production L2 > custom fields calls. |
| 09/09/2019 | Improvement |
Add of contract > custom fields, contract > Third Party contacts and
contracts calls. Add of contact > addresses and contact > communication elements calls. In contract basic infos, add of contact title. |
| 09/08/2019 | Improvement | Add of production L1 > custom fields and production L2 > custom fields calls. |
| 09/08/2019 | Improvement | Add of production L1 > custom fields and production L2 > custom fields calls. |
| 19/07/2019 | Improvement | Now in Dièse, productions can have more than one planification status, so you don't have the planification status in basic info call anymore, but with the _link getPlanificationStatuses. |
| 16/07/2019 | Improvement | Add of productions,productions L1 and productionsL2 calls. |
| 11/07/2019 | Improvement | Add of activity needs call (alone or by the activity call). |
| 25/06/2019 | Improvement | In production basic info call, you have the planification status information. |
| 25/06/2019 | Improvement | In activity basic info calls, you have now the custom fields call. |
| 24/06/2019 | Improvement | You can now have several activities in one call! See Get activities. |
| 24/06/2019 | Improvement | In activity basic info calls, you have now the production name and id. |
| 24/06/2019 | Improvement | In activity calls, update "technical_minutes_apres" into "technical_minutes_after", and "activity_statut" into "activity_status". |
| 18/06/2019 | Bug correction | production/productionL1 call |
| 17/06/2019 | Improvement |
The API location changed. It's now
"https://{idClient}.diesesoftware.com/_app/{idSubClient}/api/".$url. For more information, see First use > Step 2 |
| 17/06/2019 | Doc correction |
change default call /productionL1/productionsL2/{idProductionL1}
into /productionL1/productionL2/{idProductionL1} change default call /production/getCustomFields/{idProduction} into /production/customFields/{idProduction} |