API TrainMe v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
activities
PostActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athlete | formData | string | false | none |
| product | formData | string | true | none |
| date | formData | string | true | none |
| address | formData | string | false | none |
| address_requirement | formData | string | false | none |
| address_requirement_message | formData | string | false | none |
| credit | formData | string | false | none |
| video_conference | formData | string | false | none |
| eventId | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivities
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/activities?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Serie] | false | none | none |
| »» additional_contact_information | string | false | none | extra_property |
| »» admin_notes | string | false | none | extra_property |
| »» chat_settings | string | false | none | extra_property |
| »» coach_notes | string | false | none | extra_property |
| »» conveniences | string | false | none | extra_property |
| »» files | string | false | none | extra_property |
| »» management_links | string | false | none | extra_property |
| »» managers | string | false | none | extra_property |
| »» mentionable_coaches | string | false | none | extra_property |
| »» past_lessons_count | string | false | none | extra_property |
| »» sport_identifier | string | false | none | extra_property |
| »» upcoming_lessons_count | string | false | none | extra_property |
GetActivitiesPermissions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/activities/permissions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/permissions?activities=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET activities/permissions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activities | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/activities/{activity}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/{activity}/cancel',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT activities/{activity}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelParticipation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/activities/{activity}/cancel-participation', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/{activity}/cancel-participation',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT activities/{activity}/cancel-participation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachPayoutAmountHistory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/activities/{activity}/coach-payout-amount-history', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/{activity}/coach-payout-amount-history',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET activities/{activity}/coach-payout-amount-history
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutConfirmActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/activities/{activity}/confirm', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/{activity}/confirm',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT activities/{activity}/confirm
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivity
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/activities/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/activities/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET activities/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » additional_contact_information | string | false | none | extra_property |
| » admin_notes | string | false | none | extra_property |
| » chat_settings | string | false | none | extra_property |
| » coach_notes | string | false | none | extra_property |
| » conveniences | string | false | none | extra_property |
| » files | string | false | none | extra_property |
| » management_links | string | false | none | extra_property |
| » managers | string | false | none | extra_property |
| » mentionable_coaches | string | false | none | extra_property |
| » past_lessons_count | string | false | none | extra_property |
| » sport_identifier | string | false | none | extra_property |
| » upcoming_lessons_count | string | false | none | extra_property |
GetActivityEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/activities/{id}/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/activities/{id}/events?page=string&sort_by=string&sort_order=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET activities/{id}/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| starting_before | query | string | false | none |
| starting_after | query | string | false | none |
| sort_by | query | string | true | Doit respecter le pattern #^(?:start_date OR end_date)$#xsu |
| sort_order | query | string | true | Doit respecter le pattern #^(?:asc OR desc)$#xsu |
| status | query | string | false | Statut ou tableau de statuts (PENDING_CONFIRMATION |
| in_the_future_or_in_progress | query | string | false | Doit respecter le pattern #^(?:true)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
admin
GetActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| activity_status | query | string | false | none |
| athlete_id | query | string | false | none |
| athlete_lesson_index | query | string | false | none |
| binomial_lesson_index | query | string | false | none |
| bypass_status | query | string | false | none |
| catalog | query | string | false | none |
| coach | query | string | false | none |
| coach_id | query | string | false | none |
| coach_payout_status | query | string | false | none |
| customer_or_organization | query | string | false | none |
| date_range | query | string | false | none |
| due_to_payout_mandatory | query | string | false | none |
| first_binomial_activity | query | string | false | none |
| force_payout_disabled | query | string | false | none |
| force_payout_enabled | query | string | false | none |
| with_payout_canceled | query | string | false | none |
| internal_status | query | string | false | none |
| is_pack_lesson | query | string | false | none |
| label_coach | query | string | false | none |
| main_athlete | query | string | false | none |
| main_athlete_client | query | string | false | none |
| main_athlete_first_activity | query | string | false | none |
| main_athlete_full_name_or_id | query | string | false | none |
| main_athlete_label | query | string | false | none |
| mandatory_offer_filter | query | string | false | none |
| offer | query | string | false | none |
| organization | query | string | false | none |
| organization_name | query | string | false | none |
| organizations | query | string | false | none |
| period | query | string | false | none |
| post_status | query | string | false | none |
| reference | query | string | false | none |
| serie_name | query | string | false | none |
| capacity | query | string | false | none |
| serie | query | string | false | none |
| sort | query | string | false | none |
| sport | query | string | false | none |
| status_reason | query | string | false | none |
| stripe_account_status | query | string | false | none |
| video_conference | query | string | false | none |
| coach_status | query | string | false | none |
| new_activity | query | string | false | none |
| new_coach | query | string | false | none |
| typology_coach | query | string | false | none |
| new_serie | query | string | false | none |
| force_limit_per_page | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| serie_category | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| account_csm | query | string | false | none |
| account_ops | query | string | false | none |
| account_manager | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetByPassStatuses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/bypass-statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/bypass-statuses',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/bypass-statuses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| query | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetByPassStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/bypass-statuses/{status}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/bypass-statuses/{status}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/bypass-statuses/{status}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| status | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetInternalStatuses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/internal-statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/internal-statuses',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/internal-statuses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| query | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetInternalStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/internal-statuses/{status}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/internal-statuses/{status}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/internal-statuses/{status}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| status | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivityContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/{activityId}/contract', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activityId}/contract',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/{activityId}/contract
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivityAthlete
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activities/{activity}/athletes/{athlete}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/athletes/{athlete}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activities/{activity}/athletes/{athlete}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| athlete | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelActivityAthlete
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/activities/{activity}/athletes/{athlete}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/athletes/{athlete}/cancel',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/activities/{activity}/athletes/{athlete}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| athlete | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivityByPassStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/activities/{activity}/bypass-statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/bypass-statuses',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/activities/{activity}/bypass-statuses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| status | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/activities/{activity}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/cancel',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/activities/{activity}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| with_notification | formData | string | false | none |
| with_coach_notification_only | formData | string | false | none |
| reason | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchActivityCoachCommission
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/activities/{activity}/coach-commission', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/coach-commission',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/activities/{activity}/coach-commission
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
| new_commission | formData | string | true | none |
| change_reason | formData | string | true | none |
| preview | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutConfirmActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/activities/{activity}/confirm', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/confirm',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/activities/{activity}/confirm
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| reason | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivityInternalStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/activities/{activity}/internal-statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activities/{activity}/internal-statuses',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/activities/{activity}/internal-statuses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| status | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivityCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/activity-credits', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity-credits',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/activity-credits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| credit | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| expires | formData | string | true | none |
| product | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| organization | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| offer | formData | string | true | none |
| coach_payout_amount_hc | formData | string | false | none |
| trainme_commission_pct | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivityCredits
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activity-credits', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity-credits?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activity-credits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| customer | query | string | false | none |
| customer_id | query | string | false | none |
| offer | query | string | false | none |
| coach | query | string | false | none |
| coach_id | query | string | false | none |
| creation_balance | query | string | false | none |
| balance | query | string | false | none |
| created_range | query | string | false | none |
| usable | query | string | false | none |
| organization | query | string | false | none |
| organizations | query | string | false | none |
| being_pack | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchActivityCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/activity-credits/{activityCredit}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity-credits/{activityCredit}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/activity-credits/{activityCredit}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityCredit | path | integer | true | none |
| newExpires | formData | string | true | none |
| credit | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivityCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activity-credits/{credit}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity-credits/{credit}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activity-credits/{credit}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| credit | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutActivityCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/activity-credits/{credit}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity-credits/{credit}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/activity-credits/{credit}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| credit | path | integer | true | none |
| credit | formData | string | false | Doit respecter le pattern #^(?:-?\d+)$#xsu |
| date | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivityAthletes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/activity/{activity}/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/activity/{activity}/athletes?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/activity/{activity}/athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| activity_query | query | string | false | none |
| athlete | query | string | false | none |
| athlete_id | query | string | false | none |
| offer | query | string | false | none |
| athlete_status | query | string | false | none |
| activity_status | query | string | false | none |
| sport | query | string | false | none |
| video_conference | query | string | false | none |
| date_range | query | string | false | none |
| from_client | query | string | false | none |
| created_range | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAddresses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/addresses?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| fitness_park | query | integer | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/addresses/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/addresses/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthletes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/athletes?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| activity_query | query | string | false | none |
| athlete | query | string | false | none |
| athlete_id | query | string | false | none |
| offer | query | string | false | none |
| athlete_status | query | string | false | none |
| activity_status | query | string | false | none |
| sport | query | string | false | none |
| video_conference | query | string | false | none |
| date_range | query | string | false | none |
| from_client | query | string | false | none |
| created_range | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthleteActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/athletes/{athlete}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/athletes/{athlete}/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/athletes/{athlete}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athlete | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| activity_status | query | string | false | none |
| athlete_id | query | string | false | none |
| athlete_lesson_index | query | string | false | none |
| binomial_lesson_index | query | string | false | none |
| bypass_status | query | string | false | none |
| catalog | query | string | false | none |
| coach | query | string | false | none |
| coach_id | query | string | false | none |
| coach_payout_status | query | string | false | none |
| customer_or_organization | query | string | false | none |
| date_range | query | string | false | none |
| due_to_payout_mandatory | query | string | false | none |
| first_binomial_activity | query | string | false | none |
| force_payout_disabled | query | string | false | none |
| force_payout_enabled | query | string | false | none |
| with_payout_canceled | query | string | false | none |
| internal_status | query | string | false | none |
| is_pack_lesson | query | string | false | none |
| label_coach | query | string | false | none |
| main_athlete | query | string | false | none |
| main_athlete_client | query | string | false | none |
| main_athlete_first_activity | query | string | false | none |
| main_athlete_full_name_or_id | query | string | false | none |
| main_athlete_label | query | string | false | none |
| mandatory_offer_filter | query | string | false | none |
| offer | query | string | false | none |
| organization | query | string | false | none |
| organization_name | query | string | false | none |
| organizations | query | string | false | none |
| period | query | string | false | none |
| post_status | query | string | false | none |
| reference | query | string | false | none |
| serie_name | query | string | false | none |
| capacity | query | string | false | none |
| serie | query | string | false | none |
| sort | query | string | false | none |
| sport | query | string | false | none |
| status_reason | query | string | false | none |
| stripe_account_status | query | string | false | none |
| video_conference | query | string | false | none |
| coach_status | query | string | false | none |
| new_activity | query | string | false | none |
| new_coach | query | string | false | none |
| typology_coach | query | string | false | none |
| new_serie | query | string | false | none |
| force_limit_per_page | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| serie_category | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| account_csm | query | string | false | none |
| account_ops | query | string | false | none |
| account_manager | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthleteActivityCredits
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/athletes/{athlete}/activity-credits', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/athletes/{athlete}/activity-credits?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/athletes/{athlete}/activity-credits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athlete | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| customer | query | string | false | none |
| customer_id | query | string | false | none |
| offer | query | string | false | none |
| coach | query | string | false | none |
| coach_id | query | string | false | none |
| creation_balance | query | string | false | none |
| balance | query | string | false | none |
| created_range | query | string | false | none |
| usable | query | string | false | none |
| organization | query | string | false | none |
| organizations | query | string | false | none |
| being_pack | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCartRules
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/cart-rules', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/cart-rules?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/cart-rules
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| customer | query | string | false | none |
| usable | query | string | false | none |
| with_reduction_amount | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCartRulesMigrationArchives
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/cart-rules/{athlete}/migration-archive', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/cart-rules/{athlete}/migration-archive',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/cart-rules/{athlete}/migration-archive
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athlete | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutDeactivateCartRule
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/cart-rules/{cartRule}/deactivate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/cart-rules/{cartRule}/deactivate',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/cart-rules/{cartRule}/deactivate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cartRule | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCatalogs
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/catalogs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/catalogs',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/catalogs
Responses
| Status | Meaning | Description | Schema |
|---|
GetPostStatusGroups
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coach-activities/post-status-groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coach-activities/post-status-groups',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coach-activities/post-status-groups
Responses
| Status | Meaning | Description | Schema |
|---|
GetB2bReviewStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coach/review-status', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coach/review-status',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coach/review-status
Responses
| Status | Meaning | Description | Schema |
|---|
GetGlobalNote
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coach/{coach}/global-note', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coach/{coach}/global-note',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coach/{coach}/global-note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| coach | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachsReviews
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coach/{coach}/reviews', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coach/{coach}/reviews?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coach/{coach}/reviews
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| coach | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| id_customer | query | string | false | none |
| id_activity | query | string | false | none |
| id_category | query | string | false | none |
| note | query | string | false | none |
| status | query | string | false | none |
| start | query | string | false | none |
| end | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCancelReview
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/coach/{coach}/reviews/{review}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coach/{coach}/reviews/{review}/cancel',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/coach/{coach}/reviews/{review}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| coach | path | integer | true | none |
| review | path | integer | true | none |
| recreate | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coaches/{coachId}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaches/{coachId}/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coaches/{coachId}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| coachId | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachingRequests
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coaching-requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coaching-requests
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| search_title | query | string | false | none |
| search_coaches | query | string | false | none |
| expires_date_range | query | string | false | none |
| search_activity_date_range | query | string | false | none |
| status | query | string | false | none |
| search_organization | query | string | false | none |
| search_activity | query | string | false | none |
| created_date_range | query | string | false | none |
| no_coach_option_left | query | string | false | none |
| created_by | query | string | false | none |
| with_archived | query | string | false | none |
| re_openable | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/coaching-requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/coaching-requests
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| expires_at | formData | string | false | none |
| title | formData | string | true | none |
| message | formData | string | true | none |
| private_notes | formData | string | false | none |
| products | formData | string | false | none |
| activities | formData | string | false | none |
| isDraft | formData | string | false | none |
| template_type | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/coaching-requests/{request}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests/{request}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/coaching-requests/{request}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/coaching-requests/{request}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests/{request}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/coaching-requests/{request}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/coaching-requests/{request}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests/{request}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/coaching-requests/{request}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
| products | formData | string | false | none |
| activities | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/coaching-requests/{request}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/coaching-requests/{request}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/coaching-requests/{request}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
| expires_at | formData | string | true | none |
| title | formData | string | true | none |
| message | formData | string | true | none |
| private_notes | formData | string | false | none |
| products | formData | string | false | none |
| activities | formData | string | false | none |
| isReopenRequest | formData | string | false | none |
| isSilentReopenRequest | formData | string | false | none |
| wantConvertDraftToRequest | formData | string | false | none |
| template_type | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostContractActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/contracts/{contractId}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/contracts/{contractId}/activities',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/contracts/{contractId}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| contractId | path | integer | true | none |
| activity_ids | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetContractActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/contracts/{contractId}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/contracts/{contractId}/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/contracts/{contractId}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| contractId | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| status | query | string | false | none |
| categoryId | query | string | false | none |
| order_by | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteContractActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/contracts/{contractId}/activities/{activityId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/contracts/{contractId}/activities/{activityId}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/contracts/{contractId}/activities/{activityId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| contractId | path | integer | true | none |
| activityId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/forms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/forms
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| name | formData | string | true | none |
| description | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetForms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/forms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/forms
Responses
| Status | Meaning | Description | Schema |
|---|
GetForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/corporate/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/corporate/forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/corporate/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/corporate/forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| name | formData | string | false | none |
| description | formData | string | false | none |
| active | formData | string | false | none |
| deleted | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostFormField
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/forms/{form}/fields', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/forms/{form}/fields
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| label | formData | string | true | none |
| description | formData | string | false | none |
| informational_note | formData | string | false | none |
| type | formData | string | true | none |
| value | formData | string | false | none |
| mandatory_type | formData | string | true | none |
| active | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetFormFields
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/forms/{form}/fields', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/forms/{form}/fields
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| filter_by_id | query | string | false | none |
| filter_by_position | query | string | false | none |
| filter_by_active | query | string | false | none |
| filter_by_label | query | string | false | none |
| filter_by_description | query | string | false | none |
| filter_by_informational_note | query | string | false | none |
| filter_by_type | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutFormFieldPositions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/forms/{form}/fields/positions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields/positions',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/forms/{form}/fields/positions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| fieldsPositions | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetFormField
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/forms/{form}/fields/{field}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields/{field}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/forms/{form}/fields/{field}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| field | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutDisableFormField
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/forms/{form}/fields/{field}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields/{field}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/forms/{form}/fields/{field}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| field | path | integer | true | none |
| active | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteFormField
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/corporate/forms/{form}/fields/{field}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields/{field}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/corporate/forms/{form}/fields/{field}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| field | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchFormField
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/corporate/forms/{form}/fields/{field}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/forms/{form}/fields/{field}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/corporate/forms/{form}/fields/{field}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | integer | true | none |
| field | path | integer | true | none |
| label | formData | string | false | none |
| description | formData | string | false | none |
| informational_note | formData | string | false | none |
| type | formData | string | false | none |
| value | formData | string | false | none |
| mandatory_type | formData | string | false | none |
| active | formData | string | true | none |
| deleted | formData | string | false | none |
| fichier | formData | string | false | none |
| remove_validation_file | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetHubspotDeals
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/hubspot-deals', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/hubspot-deals?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/hubspot-deals
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| processing_status | query | string | false | none |
| no_csm | query | string | false | none |
| csm_name | query | string | false | none |
| owner_name | query | string | false | none |
| dealname | query | string | false | none |
| hs_deal_id | query | string | false | none |
| hs_bo_matching | query | string | false | none |
| quote_number | query | string | false | none |
| no_starting_date | query | string | false | none |
| starting_period | query | string | false | none |
| category | query | string | false | none |
| force_update | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutHubspotDealStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/hubspot-deals/{deal}/status', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/hubspot-deals/{deal}/status',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/hubspot-deals/{deal}/status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deal | path | integer | true | none |
| processing_status | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationContracts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{id}/contracts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/contracts?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{id}/contracts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| in_progress | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/organizations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | formData | string | true | none |
| events_slug | formData | string | false | Doit respecter le pattern #^(?:[a-z0-9_-]{3,150})$#xsu |
| corporate_lessons_title | formData | string | false | none |
| corporate_lessons_subtitle | formData | string | false | none |
| primary_color | formData | string | false | Doit respecter le pattern #^(?:^#[a-zA-Z0-9]{6})$#xsu |
| secondary_color | formData | string | false | Doit respecter le pattern #^(?:^#[a-zA-Z0-9]{6})$#xsu |
| no_automation_marketing | formData | string | false | none |
| video_visibility | formData | string | false | none |
| video_available_fr | formData | string | false | none |
| video_available_en | formData | string | false | none |
| video_replay_visibility | formData | string | false | none |
| leaderboard_visibility | formData | string | false | none |
| organization_group_leaderboard_visibility | formData | string | false | none |
| payment_visibility | formData | string | false | none |
| gym_visibility | formData | string | false | none |
| enable_activity_credits_purchase | formData | string | false | none |
| enable_geographic_activity_filter | formData | string | false | none |
| enable_activity_modality_filter | formData | string | false | none |
| nutrition_advices | formData | string | false | none |
| athlete_cancel_deadline_hours | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| confirmed_activity_notification_delay | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| platform_used_by_attendees | formData | string | false | none |
| default_tz | formData | string | false | none |
| corporate_feed | formData | string | false | none |
| corporate_feed_header_text | formData | string | false | none |
| hubspot_id | formData | string | false | none |
| manager_workspace_visibility | formData | string | false | none |
| manager_can_add_customer | formData | string | false | none |
| manager_can_share | formData | string | false | none |
| activity_tab_name | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteOrganizations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/corporate/organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/corporate/organizations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationIds | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationsContents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/contents', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/contents?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/contents
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| filter_by_id | query | string | false | none |
| filter_by_exact_id | query | string | false | none |
| filter_by_type | query | string | false | none |
| filter_by_label | query | string | false | none |
| filter_by_created_employee | query | string | false | none |
| filter_by_content | query | string | false | none |
| filter_by_range_created | query | string | false | none |
| filter_by_external_id | query | string | false | none |
| filter_active | query | string | false | none |
| filter_by_organizations | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteOrganizationContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/corporate/organizations/contracts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/contracts/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/corporate/organizations/contracts/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/contracts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/contracts/{id}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/contracts/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| start | formData | string | true | none |
| end | formData | string | true | none |
| name | formData | string | false | none |
| notes | formData | string | false | none |
| asana_link | formData | string | false | none |
| series | formData | string | false | none |
| sold_lessons | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sold_price | formData | string | true | Doit respecter le pattern #^(?:\d{1,7}[, OR .]?\d{0,4})$#xsu |
| type | formData | string | true | none |
| status | formData | string | true | none |
| invoiced | formData | string | true | none |
| hs_quote_number | formData | string | false | none |
| hs_deal_id | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| name | formData | string | true | none |
| events_slug | formData | string | false | Doit respecter le pattern #^(?:[a-z0-9_-]{3,150})$#xsu |
| corporate_lessons_title | formData | string | false | none |
| corporate_lessons_subtitle | formData | string | false | none |
| primary_color | formData | string | false | Doit respecter le pattern #^(?:^#[a-zA-Z0-9]{6})$#xsu |
| secondary_color | formData | string | false | Doit respecter le pattern #^(?:^#[a-zA-Z0-9]{6})$#xsu |
| total_audience | formData | string | false | none |
| hubspot_id | formData | string | false | none |
| no_automation_marketing | formData | string | false | none |
| leaderboard_visibility | formData | string | false | none |
| organization_group_leaderboard_visibility | formData | string | false | none |
| payment_visibility | formData | string | false | none |
| gym_visibility | formData | string | false | none |
| enable_activity_credits_purchase | formData | string | false | none |
| nutrition_advices | formData | string | false | none |
| enable_geographic_activity_filter | formData | string | false | none |
| enable_activity_modality_filter | formData | string | false | none |
| athlete_cancel_deadline_hours | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| confirmed_activity_notification_delay | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| platform_used_by_attendees | formData | string | false | none |
| default_tz | formData | string | false | none |
| corporate_feed | formData | string | false | none |
| corporate_feed_header_text | formData | string | false | none |
| manager_can_send_email_for_orga_message | formData | string | false | none |
| customer_can_send_email_for_orga_message | formData | string | false | none |
| manager_workspace_visibility | formData | string | false | none |
| manager_can_add_customer | formData | string | false | none |
| manager_can_share | formData | string | false | none |
| activity_tab_name | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/corporate/organizations/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/corporate/organizations/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| activity_credit_products | formData | string | false | none |
| migrate | formData | string | false | none |
| video_visibility | formData | string | false | none |
| video_available_fr | formData | string | false | none |
| video_available_en | formData | string | false | none |
| video_replay_visibility | formData | string | false | none |
| enable_new_activity_filter | formData | string | false | none |
| enable_impact_co2_calculator | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationAccountCSM
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}/account-csm', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/account-csm',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}/account-csm
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| csm | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationAccountManager
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}/account-manager', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/account-manager',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}/account-manager
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| manager | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationAccountOPS
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}/account-ops', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/account-ops',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}/account-ops
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ops | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivitiesWithoutContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{id}/activities-without-contract', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/activities-without-contract?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{id}/activities-without-contract
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| status | query | string | false | none |
| categoryId | query | string | false | none |
| order_by | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutClientManagers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}/client-managers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/client-managers',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}/client-managers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| clientManagers | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/organizations/{id}/contracts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/contracts',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/organizations/{id}/contracts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| start | formData | string | true | none |
| end | formData | string | true | none |
| notes | formData | string | false | none |
| asana_link | formData | string | false | none |
| sold_lessons | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| series | formData | string | false | none |
| sold_price | formData | string | true | Doit respecter le pattern #^(?:\d{1,7}[, OR .]?\d{0,4})$#xsu |
| type | formData | string | true | none |
| status | formData | string | true | none |
| hs_quote_number | formData | string | false | none |
| hs_deal_id | formData | string | false | none |
| name | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCountActivitiesSportsAndStatusWithoutContract
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{id}/count-by-sport-and-status-without-contract', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/count-by-sport-and-status-without-contract',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{id}/count-by-sport-and-status-without-contract
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{id}/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/events?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{id}/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| date_range | query | string | false | none |
| status | query | string | false | none |
| serie | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| contract | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationUHOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/corporate/organizations/{id}/uh-organization', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{id}/uh-organization',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/corporate/organizations/{id}/uh-organization
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| uh_organization | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{organization}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{organization}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{organization}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationContents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/organizations/{organization}/contents', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{organization}/contents?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/organizations/{organization}/contents
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| filter_by_id | query | string | false | none |
| filter_by_exact_id | query | string | false | none |
| filter_by_type | query | string | false | none |
| filter_by_label | query | string | false | none |
| filter_by_created_employee | query | string | false | none |
| filter_by_content | query | string | false | none |
| filter_by_range_created | query | string | false | none |
| filter_by_external_id | query | string | false | none |
| filter_active | query | string | false | none |
| filter_by_organizations | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationCsmPulse
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/organizations/{organization}/csm-pulse', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{organization}/csm-pulse',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/organizations/{organization}/csm-pulse
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| status | formData | string | true | none |
| details | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostDuplicateOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/organizations/{organization}/duplicate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{organization}/duplicate',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/organizations/{organization}/duplicate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| name | formData | string | true | none |
| events_slug | formData | string | true | none |
| series | formData | string | false | none |
| with_future_activities | formData | string | false | none |
| with_addresses | formData | string | false | none |
| check_coach_availabilities | formData | string | true | none |
| activities_timezone_duplication | formData | string | false | none |
| default_tz | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostImportSeriesToOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/corporate/organizations/{organization}/import-series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/organizations/{organization}/import-series',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/corporate/organizations/{organization}/import-series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| series | formData | string | false | none |
| with_future_activities | formData | string | true | none |
| with_addresses | formData | string | false | none |
| check_coach_availabilities | formData | string | true | none |
| activities_timezone_duplication | formData | string | true | none |
| for_contract | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSeries
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/admin/corporate/series?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| organization | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| search_query | query | string | false | Recherche sur le nom orga ou serie |
| coach | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| active | query | string | false | none |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Serie] | false | none | none |
| »» additional_contact_information | string | false | none | extra_property |
| »» admin_notes | string | false | none | extra_property |
| »» chat_settings | string | false | none | extra_property |
| »» coach_notes | string | false | none | extra_property |
| »» conveniences | string | false | none | extra_property |
| »» files | string | false | none | extra_property |
| »» management_links | string | false | none | extra_property |
| »» managers | string | false | none | extra_property |
| »» mentionable_coaches | string | false | none | extra_property |
| »» past_lessons_count | string | false | none | extra_property |
| »» sport_identifier | string | false | none | extra_property |
| »» upcoming_lessons_count | string | false | none | extra_property |
GetSerieEventsAthletes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/series/events/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/series/events/athletes?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/series/events/athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchSerie
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/corporate/series/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/admin/corporate/series/{id}',
{
method: 'PATCH',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/corporate/series/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| published | formData | string | true | none |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Serie modifiée | Inline |
| 404 | Not Found | Serie non trouvée | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » additional_contact_information | string | false | none | extra_property |
| » admin_notes | string | false | none | extra_property |
| » chat_settings | string | false | none | extra_property |
| » coach_notes | string | false | none | extra_property |
| » conveniences | string | false | none | extra_property |
| » files | string | false | none | extra_property |
| » management_links | string | false | none | extra_property |
| » managers | string | false | none | extra_property |
| » mentionable_coaches | string | false | none | extra_property |
| » past_lessons_count | string | false | none | extra_property |
| » sport_identifier | string | false | none | extra_property |
| » upcoming_lessons_count | string | false | none | extra_property |
DeleteSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/corporate/series/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/series/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/corporate/series/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/corporate/series/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/corporate/series/{serie}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/corporate/series/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCustomerTag
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/customers/tags', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/tags',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/customers/tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| label | formData | string | true | none |
| description | formData | string | false | none |
| type | formData | string | true | none |
| color | formData | string | false | none |
| display_on_bo_orders | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerTags
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/tags', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/tags?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| label_search | query | string | false | none |
| description_search | query | string | false | none |
| type | query | string | false | none |
| customer_key | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerTag
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/tags/{tag}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/tags/{tag}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/tags/{tag}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tag | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCustomerTag
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/customers/tags/{tag}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/tags/{tag}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/customers/tags/{tag}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tag | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCustomerTag
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/customers/tags/{tag}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/tags/{tag}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/customers/tags/{tag}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tag | path | integer | true | none |
| label | formData | string | true | none |
| description | formData | string | false | none |
| type | formData | string | true | none |
| color | formData | string | false | none |
| display_on_bo_orders | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomer
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/{customerId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customerId}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/{customerId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customerId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerHistory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/{customer}/history', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/history',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/{customer}/history
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | integer | true | none |
| year | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCustomerPrivateNote
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/customers/{customer}/private-note', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/private-note',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/customers/{customer}/private-note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | integer | true | none |
| content | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCustomerPrivateNote
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/customers/{customer}/private-note/{note}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/private-note/{note}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/customers/{customer}/private-note/{note}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | integer | true | none |
| note | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerHasCustomerTags
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/{customer}/tags', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/tags',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/{customer}/tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCustomerHasCustomerTags
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/customers/{customer}/tags', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/tags',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/customers/{customer}/tags
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCustomerHasCustomerTag
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/customers/{customer}/tags/{tag}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{customer}/tags/{tag}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/customers/{customer}/tags/{tag}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customer | path | string | true | none |
| tag | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCustomerPaymentMethod
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/customers/{id}/payment-methods', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{id}/payment-methods',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/customers/{id}/payment-methods
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | true | Doit respecter le pattern #^(?:pm_[a-zA-Z0-9]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerPaymentMethods
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/{id}/payment-methods', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{id}/payment-methods?type=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/{id}/payment-methods
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| type | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerPayoutInformation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/customers/{id}/payout-informations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{id}/payout-informations',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/customers/{id}/payout-informations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCustomerSetupIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/customers/{id}/setup-intent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/customers/{id}/setup-intent',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/customers/{id}/setup-intent
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| params | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/domain-events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/domain-events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| attachments | query | string | false | none |
| mandatory_attachments | query | string | false | none |
| mandatory_include_types | query | string | false | none |
| include_types | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/domain-events/categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/categories',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/domain-events/categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | formData | string | true | none |
| parent | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| color | formData | string | false | Doit respecter le pattern #^(?:#[a-z0-9]{6})$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCategories
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/domain-events/categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/categories',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/domain-events/categories
Responses
| Status | Meaning | Description | Schema |
|---|
PutCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/domain-events/categories/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/categories/{categoryId}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/domain-events/categories/{categoryId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer | true | none |
| name | formData | string | true | none |
| parent | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| color | formData | string | false | Doit respecter le pattern #^(?:#[a-z0-9]{6})$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/domain-events/categories/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/categories/{categoryId}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/domain-events/categories/{categoryId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetTasks
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/domain-events/tasks', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/tasks?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/domain-events/tasks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| after_task | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| assignees | query | string | false | none |
| statuses | query | string | false | none |
| category | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| only_mines | query | integer | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| order_by | query | string | false | none |
| from_date | query | string | false | none |
| to_date | query | string | false | none |
| without_assignee | query | string | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| attachment_customers | query | string | false | none |
| attachment_reference | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetTask
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/domain-events/tasks/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/tasks/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/domain-events/tasks/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchTask
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/domain-events/tasks/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/tasks/{id}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/domain-events/tasks/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| assignee | formData | string | false | ID de l’assigné |
| note | formData | string | false | Note interne |
| status | formData | string | false | Statut de la tache Doit respecter le pattern #^(?:todo OR ongoing OR done OR archived)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetEvent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/domain-events/{domainEvent}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/domain-events/{domainEvent}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/domain-events/{domainEvent}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| domainEvent | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCancelPayout
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/due-payouts/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/due-payouts/cancel',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/due-payouts/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostExecutePayout
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/due-payouts/execute', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/due-payouts/execute',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/due-payouts/execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | formData | string | true | none |
| priority | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostManualPayout
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/due-payouts/execute-manual', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/due-payouts/execute-manual',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/due-payouts/execute-manual
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostUncancelPayout
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/due-payouts/uncancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/due-payouts/uncancel',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/due-payouts/uncancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetEmployees
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/employees', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/employees',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/employees
Responses
| Status | Meaning | Description | Schema |
|---|
GetEnvVariable
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/env-variable', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/env-variable?variable=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/env-variable
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| variable | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetExportedDataFile
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/exported-data-files/{file}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/exported-data-files/{file}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/exported-data-files/{file}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| file | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetNotificationCategories
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/notifications/notification-categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-categories?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/notifications/notification-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostNotificationCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/notifications/notification-categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-categories',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/notifications/notification-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | formData | string | true | none |
| description | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutNotificationCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/notifications/notification-categories/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-categories/{id}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/notifications/notification-categories/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| name | formData | string | true | Category name |
| description | formData | string | false | Category description |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteNotificationCategory
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/notifications/notification-categories/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-categories/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/notifications/notification-categories/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetNotificationTypes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/notifications/notification-types', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-types?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/notifications/notification-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| id | query | string | false | none |
| type | query | string | false | none |
| id_notification_category | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutNotificationType
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/notifications/notification-types/{id_notification_type}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-types/{id_notification_type}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/notifications/notification-types/{id_notification_type}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_notification_type | path | integer | true | none |
| id_notification_category | formData | string | false | ID of the notification category to assign |
| display_name | formData | string | false | Name of the notification category to assign |
| display_description | formData | string | false | Description of the notification category to assign |
Responses
| Status | Meaning | Description | Schema |
|---|
PutNotificationDefaultSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/notifications/notification-types/{id_notification_type}/default-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/notification-types/{id_notification_type}/default-settings',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/notifications/notification-types/{id_notification_type}/default-settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_notification_type | path | integer | true | none |
| settings | formData | string | true | Array of settings to save |
Responses
| Status | Meaning | Description | Schema |
|---|
PostTransactionalEmail
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/notifications/transactional-email', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transactional-email',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/notifications/transactional-email
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| technical_identifier | formData | string | true | Technical identifier for the transactional email |
| brevo_template_id | formData | string | false | none |
| name | formData | string | true | Name of the transactional email |
| description | formData | string | false | none |
| locale | formData | string | true | Locale for the transactional email |
| id_notification_type | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetTransactionalEmails
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/notifications/transactional-emails', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transactional-emails?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/notifications/transactional-emails
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetTransactionalEmailIdentifiers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/notifications/transactional-emails/identifiers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transactional-emails/identifiers',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/notifications/transactional-emails/identifiers
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteTransactionalEmail
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/notifications/transactional-emails/{id_email}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transactional-emails/{id_email}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/notifications/transactional-emails/{id_email}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_email | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutTransactionalEmail
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/notifications/transactional-emails/{id_email}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transactional-emails/{id_email}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/notifications/transactional-emails/{id_email}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_email | path | integer | true | none |
| brevo_template_id | formData | string | false | none |
| name | formData | string | false | Name of the transactional email |
| description | formData | string | false | none |
| locale | formData | string | false | Locale for the transactional email |
| id_notification_type | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetNotificationTransports
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/notifications/transports', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/notifications/transports',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/notifications/transports
Responses
| Status | Meaning | Description | Schema |
|---|
PatchOrder
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/orders/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/orders/{activity}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/orders/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| with_trainme_commission | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrder
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/orders/{order}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/orders/{order}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/orders/{order}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| order | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelOrder
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/orders/{order}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/orders/{order}/cancel',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/orders/{order}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| order | path | integer | true | none |
| cancel_method | formData | string | true | none |
| refunds | formData | string | false | none |
| impact_coach | formData | string | false | none |
| cancel_reasons | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutRefundOrder
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/orders/{order}/refund', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/orders/{order}/refund',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/orders/{order}/refund
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| order | path | integer | true | none |
| refunds | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationContent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/organization/content', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organization/content',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/organization/content
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| content | formData | string | true | none |
| organizations | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationContent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/organization/content', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organization/content',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/organization/content
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| content | formData | string | true | none |
| organizations | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationForms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/organizations/{organization}/forms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/forms',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/organizations/{organization}/forms
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteFormFromOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/organizations/{organization}/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/forms/{form}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/organizations/{organization}/forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| form | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutAttachFormToOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/organizations/{organization}/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/forms/{form}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/organizations/{organization}/forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| form | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationGroup
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/organizations/{organization}/groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/groups',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/organizations/{organization}/groups
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| group | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationGroups
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/organizations/{organization}/groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/groups',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/organizations/{organization}/groups
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationGroup
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/organizations/{organization}/groups/{group}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/groups/{group}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/organizations/{organization}/groups/{group}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| group | path | integer | true | none |
| name | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteOrganizationGroup
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/organizations/{organization}/groups/{group}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/groups/{group}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/organizations/{organization}/groups/{group}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| group | path | integer | true | none |
| form_id | formData | string | false | none |
| form_field_id | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationMyclubSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/organizations/{organization}/myclub-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/organizations/{organization}/myclub-settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| date_start | formData | string | false | none |
| date_end | formData | string | false | none |
| notes_for_creation | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationMyclubSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/organizations/{organization}/myclub-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/organizations/{organization}/myclub-settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostMyclubBannerTemplate
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/organizations/{organization}/myclub-settings/banner-template', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings/banner-template',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/organizations/{organization}/myclub-settings/banner-template
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteMyclubBannerTemplate
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/admin/organizations/{organization}/myclub-settings/banner-templates/{myclub_banner_template}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings/banner-templates/{myclub_banner_template}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE admin/organizations/{organization}/myclub-settings/banner-templates/{myclub_banner_template}
Responses
| Status | Meaning | Description | Schema |
|---|
PutMyclubCoachs
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/organizations/{organization}/myclub-settings/myclub-coachs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings/myclub-coachs',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/organizations/{organization}/myclub-settings/myclub-coachs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| myclub_coachs | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutMyclubSettingsActivation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/organizations/{organization}/myclub-settings/{myclub_settings}/activation', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/organizations/{organization}/myclub-settings/{myclub_settings}/activation',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/organizations/{organization}/myclub-settings/{myclub_settings}/activation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| myclub_settings | path | string | true | none |
| active | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelPaymentInstalment
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/payments/payment-instalments/{id}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/payments/payment-instalments/{id}/cancel',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/payments/payment-instalments/{id}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostRefundPayment
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/payments/{paymentIntentId}/refund', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/payments/{paymentIntentId}/refund',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/payments/{paymentIntentId}/refund
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| paymentIntentId | path | string | true | none |
| amount | formData | string | true | Doit respecter le pattern #^(?:[0-9]+([.,][0-9]{1,2})?)$#xsu |
| impact_coach | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetPayouts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/payouts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/payouts?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/payouts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| coach | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSportIdentifiers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/product/sport-identifiers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/product/sport-identifiers',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/product/sport-identifiers
Responses
| Status | Meaning | Description | Schema |
|---|
GetProducts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/products?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/products
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| query_filter | query | string | false | none |
| category_identified | query | string | false | none |
| only_coaches_already_intervened_on_series | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivityCreditProduct
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/products/activity-credit', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/products/activity-credit',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/products/activity-credit
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | formData | string | true | none |
| description | formData | string | true | none |
| price | formData | string | true | none |
| validity_duration | formData | string | true | none |
| credits_amount | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutActivityCreditProduct
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/admin/products/activity-credit', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/products/activity-credit',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT admin/products/activity-credit
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | formData | string | true | none |
| name | formData | string | true | none |
| description | formData | string | true | none |
| price | formData | string | true | none |
| validity_duration | formData | string | true | none |
| credits_amount | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProduct
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/products/{product}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/products/{product}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/products/{product}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProductCoachCommission
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/products/{product}/coach-commission', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/products/{product}/coach-commission',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/products/{product}/coach-commission
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product | path | string | true | none |
| for_customer | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| quantity | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSubscriptionServices
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/subscription-services', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/subscription-services
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| with_identifiers | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/customer-plans', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/customer-plans
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| plan | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| progressive_payment_type | formData | string | true | none |
| customer | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| payment_method | formData | string | false | Doit respecter le pattern #^(?:pm_[a-zA-Z0-9]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerPlans
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/subscription-services/customer-plans', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/subscription-services/customer-plans
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| status | query | string | false | none |
| customer | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| for_services | query | string | false | none |
| service | query | string | false | none |
| with_tags | query | string | false | none |
| with_mandatory_tags | query | string | false | none |
| service.owner | query | string | false | none |
| has_pending_new_mandate | query | string | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/subscription-services/customer-plans/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/subscription-services/customer-plans/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/subscription-services/customer-plans/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/subscription-services/customer-plans/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| will_renew_automatically | formData | integer | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| payment_method | formData | string | false | Doit respecter le pattern #^(?:pm_[a-zA-Z0-9]+)$#xsu |
| temp_payment_method | formData | string | false | Doit respecter le pattern #^(?:pm_[a-zA-Z0-9]+)$#xsu |
| new_mandate | formData | string | false | Doit respecter le pattern #^(?:[A-Z0-9]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCancelCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/customer-plans/{id}/cancel', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}/cancel',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/customer-plans/{id}/cancel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSuspendCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/customer-plans/{id}/suspend', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}/suspend',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/customer-plans/{id}/suspend
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| suspension_reason | formData | string | false | none |
| with_deadlines_suspension | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostUnsuspendCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/customer-plans/{id}/unsuspend', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}/unsuspend',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/customer-plans/{id}/unsuspend
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostValidateCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/customer-plans/{id}/validate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/customer-plans/{id}/validate',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/customer-plans/{id}/validate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| date_start | formData | string | true | none |
| deadline_day | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchPaymentDeadline
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/admin/subscription-services/payment-deadlines/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/payment-deadlines/{id}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH admin/subscription-services/payment-deadlines/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| amount | formData | string | false | Montant de l’écheance |
Responses
| Status | Meaning | Description | Schema |
|---|
PostRetryPaymentDeadlineCapture
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/admin/subscription-services/payment-deadlines/{id}/retry', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/payment-deadlines/{id}/retry',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST admin/subscription-services/payment-deadlines/{id}/retry
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSubscriptionServicePlans
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/admin/subscription-services/{id}/plans', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/admin/subscription-services/{id}/plans',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET admin/subscription-services/{id}/plans
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
athletes
GetAthletes
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/athletes?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[athlete][age_range] | query | undefined | false | none |
| extra_properties[athlete][archived] | query | undefined | false | none |
| extra_properties[athlete][attachment_date] | query | undefined | false | none |
| extra_properties[athlete][bo_tags] | query | undefined | false | none |
| extra_properties[athlete][chat_link] | query | undefined | false | none |
| extra_properties[athlete][customer_status] | query | undefined | false | none |
| extra_properties[athlete][done_lessons_corporate_number] | query | undefined | false | none |
| extra_properties[athlete][done_lessons_number] | query | undefined | false | none |
| extra_properties[athlete][filled_survey] | query | undefined | false | none |
| extra_properties[athlete][first_lesson] | query | undefined | false | none |
| extra_properties[athlete][groups] | query | undefined | false | none |
| extra_properties[athlete][hasDecathlonAccountLinked] | query | undefined | false | none |
| extra_properties[athlete][id] | query | undefined | false | none |
| extra_properties[athlete][last_corporate_lesson_start_date] | query | undefined | false | none |
| extra_properties[athlete][last_lesson] | query | undefined | false | none |
| extra_properties[athlete][last_lesson_with] | query | undefined | false | none |
| extra_properties[athlete][lesson_places] | query | undefined | false | none |
| extra_properties[athlete][next_lesson] | query | undefined | false | none |
| extra_properties[athlete][objectives] | query | undefined | false | none |
| extra_properties[athlete][pre_lesson_survey] | query | undefined | false | none |
| extra_properties[athlete][serie_participation_count] | query | undefined | false | none |
| extra_properties[athlete][tags] | query | undefined | false | none |
| extra_properties[athlete][unread_messages] | query | undefined | false | none |
| extra_properties[athlete][usable_activity_credits] | query | undefined | false | none |
| extra_properties[athlete][usable_cart_rules] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"age_range": "string",
"archived": "string",
"attachment_date": "string",
"bo_tags": "string",
"chat_link": "string",
"customer_status": "string",
"done_lessons_corporate_number": "string",
"done_lessons_number": "string",
"filled_survey": "string",
"first_lesson": "string",
"groups": "string",
"hasDecathlonAccountLinked": "string",
"id": "string",
"last_corporate_lesson_start_date": "string",
"last_lesson": "string",
"last_lesson_with": "string",
"lesson_places": "string",
"next_lesson": "string",
"objectives": "string",
"pre_lesson_survey": "string",
"serie_participation_count": "string",
"tags": "string",
"unread_messages": "string",
"usable_activity_credits": "string",
"usable_cart_rules": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Liste des athlètes | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Athlete] | false | none | none |
| »» age_range | string | false | none | extra_property |
| »» archived | string | false | none | extra_property |
| »» attachment_date | string | false | none | extra_property |
| »» bo_tags | string | false | none | extra_property |
| »» chat_link | string | false | none | extra_property |
| »» customer_status | string | false | none | extra_property |
| »» done_lessons_corporate_number | string | false | none | extra_property |
| »» done_lessons_number | string | false | none | extra_property |
| »» filled_survey | string | false | none | extra_property |
| »» first_lesson | string | false | none | extra_property |
| »» groups | string | false | none | extra_property |
| »» hasDecathlonAccountLinked | string | false | none | extra_property |
| »» id | string | false | none | extra_property |
| »» last_corporate_lesson_start_date | string | false | none | extra_property |
| »» last_lesson | string | false | none | extra_property |
| »» last_lesson_with | string | false | none | extra_property |
| »» lesson_places | string | false | none | extra_property |
| »» next_lesson | string | false | none | extra_property |
| »» objectives | string | false | none | extra_property |
| »» pre_lesson_survey | string | false | none | extra_property |
| »» serie_participation_count | string | false | none | extra_property |
| »» tags | string | false | none | extra_property |
| »» unread_messages | string | false | none | extra_property |
| »» usable_activity_credits | string | false | none | extra_property |
| »» usable_cart_rules | string | false | none | extra_property |
chat
GetMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/chat/messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/chat/messages?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET chat/messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| catalogs | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetTrainMeTemplateMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/chat/trainme-template-messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/chat/trainme-template-messages?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET chat/trainme-template-messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
cms
GetCms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/cms/{id_cms}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/cms/{id_cms}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET cms/{id_cms}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_cms | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
coach-activities
GetCoachActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/coach-activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/coach-activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET coach-activities
Liste des activités du coach
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| missing_post_status | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| sort | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/coach-activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/coach-activities/{activity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET coach-activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCoachActivityPostStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/coach-activities/{activity}/post-status', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/coach-activities/{activity}/post-status',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST coach-activities/{activity}/post-status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| code | formData | string | true | none |
| comment | formData | string | false | none |
| date | formData | string | false | none |
| triggers_coach_payout | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
corporate
GetContracts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/admin/contracts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/admin/contracts',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/admin/contracts
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| search | query | string | false | none |
| id_orga | query | string | false | none |
| having_address | query | string | false | none |
| having_stand_by_contract | query | string | false | none |
| account_manager | query | string | false | none |
| no_account_manager | query | string | false | none |
| account_csm | query | string | false | none |
| no_account_csm | query | string | false | none |
| account_ops | query | string | false | none |
| no_account_ops | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSeries
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/admin/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/admin/series?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/admin/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| with_future_activities | query | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAttachedOrganizations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/attached-organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/attached-organizations',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/attached-organizations
Responses
| Status | Meaning | Description | Schema |
|---|
PostAttachedOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/attached-organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/attached-organizations',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/attached-organizations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization_registration_code | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteAttachedOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/corporate/attached-organizations/{organization}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/attached-organizations/{organization}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE corporate/attached-organizations/{organization}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationCoaches
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/coaches', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/coaches',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/coaches
Responses
| Status | Meaning | Description | Schema |
|---|
GetConversations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/conversations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/conversations?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/conversations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetConversation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/conversations/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/conversations/{serie}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/conversations/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerieEventCancelSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/events/cancel-subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/events/cancel-subscription',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/events/cancel-subscription
Permet à un utilisateur de se désinscrire de plusieurs événements
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| events | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSerieEventSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/events/subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/events/subscription',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/events/subscription
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| events | formData | string | true | none |
| card | formData | string | false | none |
| address | formData | string | false | none |
| sharer_key | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerieEventSlotCancelSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/events/{activity}/slots/{slot}/cancel-subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/events/{activity}/slots/{slot}/cancel-subscription',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/events/{activity}/slots/{slot}/cancel-subscription
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| slot | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSerieEventSlotSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/events/{activity}/slots/{slot}/subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/events/{activity}/slots/{slot}/subscription',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/events/{activity}/slots/{slot}/subscription
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| slot | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetLeaderboardActions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/leaderboard/actions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/leaderboard/actions',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/leaderboard/actions
Responses
| Status | Meaning | Description | Schema |
|---|
GetManagedOrganizations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/managed-organizations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/managed-organizations',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/managed-organizations
Responses
| Status | Meaning | Description | Schema |
|---|
PostNewsletterSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/newsletter-subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/newsletter-subscription',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/newsletter-subscription
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| formData | string(email) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationContracts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{orga_id}/contracts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{orga_id}/contracts',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{orga_id}/contracts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orga_id | path | integer | true | none |
| in_progress | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{organization}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{organization}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/corporate/organizations/{organization}/activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/activities/{activity}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE corporate/organizations/{organization}/activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/organizations/{organization}/activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/activities/{activity}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/organizations/{organization}/activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| activity | path | integer | true | none |
| date | formData | string | true | none |
| time | formData | string | true | none |
| duration | formData | string | true | none |
| id_address | formData | string | false | none |
| external_subscription_link | formData | string | false | none |
| external_video_link | formData | string | false | none |
| capacity_override | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationActivityCreditsProducts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{organization}/activity-credit-products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/activity-credit-products',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{organization}/activity-credit-products
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutContextUsage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/organizations/{organization}/context-usage', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/context-usage',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/organizations/{organization}/context-usage
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/organizations/{organization}/myclub/address', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/myclub/address',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/organizations/{organization}/myclub/address
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| line1 | formData | string | true | none |
| city | formData | string | true | none |
| postal_code | formData | string | true | none |
| country | formData | string | true | none |
| complement | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/organizations/{organization}/myclub/address/{address}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/myclub/address/{address}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/organizations/{organization}/myclub/address/{address}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| address | path | integer | true | none |
| line1 | formData | string | true | none |
| city | formData | string | true | none |
| postal_code | formData | string | true | none |
| country | formData | string | true | none |
| complement | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetBannerTemplates
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{organization}/myclub/banner-templates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/myclub/banner-templates',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{organization}/myclub/banner-templates
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyclubCoachs
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{organization}/myclub/coachs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/myclub/coachs',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{organization}/myclub/coachs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orga_id | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| orgad_id | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| capacity | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| capacity_min | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| default_product_id | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| name | formData | string | true | none |
| next_events_display_limit | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| participation_limit | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| price | formData | string | true | Doit respecter le pattern #^(?:^\d+([.]\d+)*([.]\d+)?$)$#xsu |
| type | formData | string | true | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| operation_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| id_serie_category | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| contract_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| id_sport_identifier | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationSerieConveniences
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/organizations/{organization}/serie-conveniences', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/serie-conveniences',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/organizations/{organization}/serie-conveniences
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/corporate/organizations/{organization}/series/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/series/{serie}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE corporate/organizations/{organization}/series/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| serie | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/organizations/{organization}/series/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/series/{serie}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/organizations/{organization}/series/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| serie | path | integer | true | none |
| category_id | formData | string | false | none |
| capacity | formData | string | true | none |
| capacity_min | formData | string | true | none |
| name | formData | string | true | none |
| description | formData | string | true | none |
| type | formData | string | true | Doit respecter le pattern #^(?:0 OR 1 OR 2)$#xsu |
| id_serie_category | formData | string | false | none |
| difficulty_level | formData | string | false | none |
| address_id | formData | string | false | none |
| organizer_id | formData | string | false | none |
| default_external_video_link | formData | string | false | none |
| default_external_subscription_link | formData | string | false | none |
| additional_contact_information | formData | string | false | none |
| on_site_equipment | formData | string | false | none |
| equipment_to_bring | formData | string | false | none |
| banner_template_id | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostDuplicateSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/organizations/{organization}/series/{serie}/duplicate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/series/{serie}/duplicate',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/organizations/{organization}/series/{serie}/duplicate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| serie | path | integer | true | none |
| serie_name | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostEventDates
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/organizations/{organization}/series/{serie}/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/organizations/{organization}/series/{serie}/events',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/organizations/{organization}/series/{serie}/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| serie | path | integer | true | none |
| frequency | formData | string | true | none |
| start_hour | formData | string | true | none |
| start_date | formData | string | true | none |
| end_date | formData | string | true | none |
| repetition | formData | string | true | none |
| duration | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetBlogPosts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/posts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/posts',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/posts
Responses
| Status | Meaning | Description | Schema |
|---|
GetBlogPost
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/posts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/posts/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/posts/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSportIdentifiers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/product/sport-identifiers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/product/sport-identifiers',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/product/sport-identifiers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| only_B2B_sports | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostQuotationRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/quotation-requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/quotation-requests',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/quotation-requests
Responses
| Status | Meaning | Description | Schema |
|---|
GetQuotationRequestsSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/quotation-requests/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/quotation-requests/settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/quotation-requests/settings
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieEventsParticipationPrice
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/serie-events/participation-price', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/participation-price?event_ids=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/serie-events/participation-price
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| event_ids | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieEvent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/serie-events/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/serie-events/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutUnknownPresence
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/serie-events/{activity}/athlete/unknown/presence', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/athlete/unknown/presence',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/serie-events/{activity}/athlete/unknown/presence
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| count | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Opération réussie | None |
| 403 | Forbidden | Interdiction d’effectuer l’opération | None |
PutPresence
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/serie-events/{activity}/athlete/{athlete}/presence', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/athlete/{athlete}/presence',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/serie-events/{activity}/athlete/{athlete}/presence
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| athlete | path | integer | true | none |
| present | formData | string | true | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Opération réussie | None |
| 403 | Forbidden | Interdiction d’effectuer l’opération | None |
| 404 | Not Found | Inscription non trouvée | None |
PostVideoLink
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/serie-events/{activity}/athlete/{athlete}/send-video-link', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/athlete/{athlete}/send-video-link',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/serie-events/{activity}/athlete/{athlete}/send-video-link
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| athlete | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerieEventAthletesPresence
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/serie-events/{activity}/athletes/presence', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/athletes/presence',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/serie-events/{activity}/athletes/presence
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| athletes_present | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Opération réussie | None |
| 403 | Forbidden | Interdiction d’effectuer l’opération | None |
| 404 | Not Found | Inscription non trouvée | None |
PostSerieEventWaitingList
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/serie-events/{activity}/waiting-list', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/waiting-list',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/serie-events/{activity}/waiting-list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| address | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| card | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteSerieEventWaitingList
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/corporate/serie-events/{activity}/waiting-list', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{activity}/waiting-list',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE corporate/serie-events/{activity}/waiting-list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCancelParticipation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/serie-events/{serieEventId}/athlete/{athleteId}/cancel-participation', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie-events/{serieEventId}/athlete/{athleteId}/cancel-participation',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/serie-events/{serieEventId}/athlete/{athleteId}/cancel-participation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serieEventId | path | integer | true | none |
| athleteId | path | integer | true | none |
| slotId | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostFollow
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/corporate/serie/{id}/follow', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie/{id}/follow',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST corporate/serie/{id}/follow
Ajout de la serie dans mes cours
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteFollow
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/corporate/serie/{id}/follow', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/serie/{id}/follow',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE corporate/serie/{id}/follow
Suppression de la serie de mes cours
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetBusinessOperations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/business-operations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/business-operations',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/business-operations
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieDifficultyLevels
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/myclub/serie-difficulty-levels', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/myclub/serie-difficulty-levels',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/myclub/serie-difficulty-levels
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieCategories
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/serie-categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/serie-categories',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/serie-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| extended_list | query | integer | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| myclub | query | string | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/{id}/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/{id}/events?page=string&sort_by=string&sort_order=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/{id}/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| starting_before | query | string | false | none |
| starting_after | query | string | false | none |
| sort_by | query | string | true | Doit respecter le pattern #^(?:start_date OR end_date)$#xsu |
| sort_order | query | string | true | Doit respecter le pattern #^(?:asc OR desc)$#xsu |
| status | query | string | false | Statut ou tableau de statuts (PENDING_CONFIRMATION |
| in_the_future_or_in_progress | query | string | false | Doit respecter le pattern #^(?:true)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/{serie}/admin/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/{serie}/admin/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/{serie}/admin/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | string | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| period | query | string | false | none |
| sort | query | string | false | none |
| filter_query | query | string | false | none |
| date_range | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthletes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/series/{serie}/admin/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/{serie}/admin/athletes?page=string&activities=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/series/{serie}/admin/athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | string | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| activities | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerieConveniences
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/corporate/series/{serie}/serie-conveniences', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/series/{serie}/serie-conveniences',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT corporate/series/{serie}/serie-conveniences
Ajout et modification des commodités de la serie
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| convenienceIds | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetVideoConference
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/video-conferences/{uuid}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/video-conferences/{uuid}?customerCode=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/video-conferences/{uuid}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | true | none |
| customerCode | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetELearningVideos
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/corporate/videos/e-learning', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/corporate/videos/e-learning',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET corporate/videos/e-learning
Responses
| Status | Meaning | Description | Schema |
|---|
decathlon
PostSyncActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/decathlon/sync-activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/decathlon/sync-activities',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST decathlon/sync-activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from_date | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Synchronisation réussie | None |
| 400 | Bad Request | Erreur de validation ou compte Decathlon non connecté | None |
| 401 | Unauthorized | Utilisateur non authentifié | None |
| 500 | Internal Server Error | Erreur interne du serveur | None |
forms
PostForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/forms/{form}',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/forms/{form}?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | string | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchForm
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/forms/{form}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/forms/{form}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH forms/{form}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| form | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
generate-qr-code
PostGenerateQrCode
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/generate-qr-code', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/generate-qr-code',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST generate-qr-code
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| url | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | None |
holidays
GetZones
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/holidays/zones', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/holidays/zones',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET holidays/zones
Responses
| Status | Meaning | Description | Schema |
|---|
impact
GetImpact
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/impact', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/impact',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET impact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| met | formData | string | true | none |
| companyCommitment | formData | string | true | none |
| payroll | formData | string | false | none |
| participationRate | formData | string | false | none |
| costOfImplementation | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | None |
PutActivityTransportsEmissions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/impact/transports-emissions/{activityId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/impact/transports-emissions/{activityId}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT impact/transports-emissions/{activityId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer | true | none |
| originLat | formData | string | true | none |
| originLng | formData | string | true | none |
| transportSlug | formData | string | false | none |
| passengerCount | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Opération réussie | None |
location
GetCountries
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/location/countries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/location/countries',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET location/countries
Responses
| Status | Meaning | Description | Schema |
|---|
me/activities
GetMyActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| after | query | string | false | none |
| before | query | string | false | none |
| waiting_for_my_validation | query | string | false | none |
| canceled | query | string | false | none |
| offers | query | string | false | none |
| series | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivityParticipationSwap
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/activities/{activityId}/participation-swap', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activities/{activityId}/participation-swap',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/activities/{activityId}/participation-swap
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer | true | none |
| expires | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutActivityParticipationSwap
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/activities/{activityId}/participation-swap/{swapId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activities/{activityId}/participation-swap/{swapId}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/activities/{activityId}/participation-swap/{swapId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer | true | none |
| swapId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activities/{activity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/activity-credits
GetMyActivityCredits
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/activity-credits', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activity-credits?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/activity-credits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| expired | query | string | false | none |
| for_product | query | string | false | none |
| with_minimum_balance | query | string | false | none |
| for_offer | query | string | false | none |
| usable | query | string | false | none |
| being_pack | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyActivityCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/activity-credits/{credit}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/activity-credits/{credit}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/activity-credits/{credit}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| credit | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/addresses
GetAddresses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/addresses?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| matching_coach_area | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/addresses',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| last_name | formData | string | false | none |
| first_name | formData | string | false | none |
| line1 | formData | string | true | none |
| line2 | formData | string | false | none |
| city | formData | string | true | none |
| postal_code | formData | string | true | none |
| phone | formData | string | false | none |
| country | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| country_code | formData | string | false | none |
| complement | formData | string | false | none |
| label | formData | string | true | none |
| is_billing_default | formData | string | false | Doit respecter le pattern #^(?:1 OR 0 OR true OR false OR on OR off)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/addresses/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/addresses/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/me/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/addresses/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE me/addresses/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/addresses/{id}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/addresses/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| last_name | formData | string | false | none |
| first_name | formData | string | false | none |
| line1 | formData | string | true | none |
| line2 | formData | string | false | none |
| city | formData | string | true | none |
| postal_code | formData | string | true | none |
| phone | formData | string | false | none |
| country | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| country_code | formData | string | false | none |
| complement | formData | string | false | none |
| label | formData | string | true | none |
| is_billing_default | formData | string | false | Doit respecter le pattern #^(?:1 OR 0 OR true OR false OR on OR off)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/all-orders
GetMyOrders
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/all-orders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/all-orders?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/all-orders
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| coach_sales | query | string | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| created_after | query | string | false | none |
| created_before | query | string | false | none |
| with_payment_intent | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyOrdersActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/all-orders/{order}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/all-orders/{order}/activities',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/all-orders/{order}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| order | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyOrderInvoice
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/all-orders/{order}/invoice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/all-orders/{order}/invoice',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/all-orders/{order}/invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| order | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutConvertOrderToCommercialCredit
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/all-orders/{reference}/convert-commercial-credit', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/all-orders/{reference}/convert-commercial-credit',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/all-orders/{reference}/convert-commercial-credit
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| reference | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/attributes
PutBusinessCard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/attributes/business-card', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/attributes/business-card',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/attributes/business-card
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| value | formData | string | true | Doit respecter le pattern #^(?:[A-Z0-9]{10,20})$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutHealthStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/attributes/health', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/attributes/health',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/attributes/health
Responses
| Status | Meaning | Description | Schema |
|---|
me/calendar
GetCoachActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/calendar/coach-activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/coach-activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/calendar/coach-activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostEvent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/calendar/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/events',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/calendar/events
Responses
| Status | Meaning | Description | Schema |
|---|
GetEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/calendar/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/events?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/calendar/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteEvent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/me/calendar/events/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/events/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE me/calendar/events/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutEvent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/calendar/events/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/events/{id}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/calendar/events/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCalendarSlots
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/calendar/slots', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/calendar/slots?start=string&end=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/calendar/slots
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| start | query | string | true | none |
| end | query | string | true | none |
| type | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/carts
PostCart
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/carts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/carts',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/carts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | formData | string | true | none |
| id_product | formData | string | true | none |
| organization | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetLastPendingCart
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/carts/last-pending', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/carts/last-pending?type=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/carts/last-pending
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCartPaymentInstalmentPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/carts/{cartId}/payment-instalment-plan', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/carts/{cartId}/payment-instalment-plan',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/carts/{cartId}/payment-instalment-plan
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cartId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCart
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/me/carts/{cart}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/carts/{cart}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH me/carts/{cart}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cart | path | integer | true | none |
| use_activity_credit_instead | formData | string | false | none |
| id_product | formData | string | false | none |
| organization | formData | string | false | none |
| attach_cart_rule | formData | string | false | none |
| detach_cart_rule | formData | string | false | none |
| billing_address | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/chat
GetConversations
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/chat/conversations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/me/chat/conversations?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/chat/conversations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[conversation][interlocutor] | query | undefined | false | none |
| extra_properties[conversation][last_message] | query | undefined | false | none |
| extra_properties[conversation][unread_messages_count] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"interlocutor": "string",
"last_message": "string",
"unread_messages_count": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Conversation] | false | none | none |
| »» interlocutor | string | false | none | extra_property |
| »» last_message | string | false | none | extra_property |
| »» unread_messages_count | string | false | none | extra_property |
GetConversationMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/chat/conversations/{conversation}/messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/chat/conversations/{conversation}/messages',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/chat/conversations/{conversation}/messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| conversation | path | string | true | none |
| before_message | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/checkout
GetCards
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/checkout/cards', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/checkout/cards',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/checkout/cards
Responses
| Status | Meaning | Description | Schema |
|---|
PostCard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/checkout/cards', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/checkout/cards',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/checkout/cards
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| card_token | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/me/checkout/cards/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/checkout/cards/{id}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH me/checkout/cards/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| default | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteCard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/me/checkout/cards/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/checkout/cards/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE me/checkout/cards/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetDefaultCheckoutSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/checkout/default-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/checkout/default-settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/checkout/default-settings
Responses
| Status | Meaning | Description | Schema |
|---|
me/coach-activities
GetMyCoachActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/coach-activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/coach-activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/coach-activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| after | query | string | false | none |
| before | query | string | false | none |
| waiting_for_my_validation | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/coaches
GetCoaches
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/coaches', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/coaches',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/coaches
Responses
| Status | Meaning | Description | Schema |
|---|
me/coaching-requests
GetMyCoachingRequests
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/coaching-requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/coaching-requests?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/coaching-requests
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| status | query | string | false | none |
| only_history_request | query | string | false | none |
| filter_by_coaching_request_id | query | string | false | none |
| exclude_coaching_request_id | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoachingRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/coaching-requests/{request}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/coaching-requests/{request}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/coaching-requests/{request}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostCoachingRequestAnswer
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/coaching-requests/{request}/answer', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/coaching-requests/{request}/answer',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/coaching-requests/{request}/answer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | path | integer | true | none |
| answer | formData | string | true | Doit respecter le pattern #^(?:0 OR 1 OR true OR false OR yes OR no)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/debts
GetDebts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/debts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/debts',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/debts
Responses
| Status | Meaning | Description | Schema |
|---|
me/decat-club
GetMyPointsPerWeeks
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/decat-club/points/weeks', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/decat-club/points/weeks',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/decat-club/points/weeks
Responses
| Status | Meaning | Description | Schema |
|---|
me/membership-fees
GetMembershipFees
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/membership-fees', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/membership-fees?page=string&for_membership_fee=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/membership-fees
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| for_membership_fee | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/moving-area
PostMovingArea
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/moving-area', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/moving-area',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/moving-area
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| lat | formData | string | true | Doit respecter le pattern #^(?:[-]?[0-9]+.[0-9]+)$#xsu |
| lng | formData | string | true | Doit respecter le pattern #^(?:[-]?[0-9]+.[0-9]+)$#xsu |
| radius | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMovingArea
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/moving-area', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/moving-area',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/moving-area
Responses
| Status | Meaning | Description | Schema |
|---|
me/myclub
GetMyMyclubSeries
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/myclub/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/myclub/series?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/myclub/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyMyclubSerie
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/myclub/series/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/myclub/series/{serie}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/myclub/series/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyMyclubActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/myclub/series/{serie}/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/myclub/series/{serie}/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/myclub/series/{serie}/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| statuses | query | string | false | none |
| starting_before | query | string | false | none |
| starting_after | query | string | false | none |
| in_the_future_or_in_progress | query | string | false | Doit respecter le pattern #^(?:true)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/notifications
GetNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/notifications', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/notifications
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| filter_by_organization | query | string | false | none |
| seen | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutAllNotificationsAsClicked
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/notifications/all-clicked', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/all-clicked',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/notifications/all-clicked
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| zendesk_ticket_only | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutAllNotificationsAsSeen
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/notifications/all-seen', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/all-seen',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/notifications/all-seen
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyNotificationSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/notifications/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/notifications/settings
Responses
| Status | Meaning | Description | Schema |
|---|
PutMyNotificationSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/notifications/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/settings',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/notifications/settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| settings | formData | string | true | Array of notification preferences to update |
Responses
| Status | Meaning | Description | Schema |
|---|
GetZendeskNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/notifications/zendesk', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/zendesk',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/notifications/zendesk
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter_by_organization | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutNotificationClicked
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/notifications/{notification}/clicked', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/notifications/{notification}/clicked',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/notifications/{notification}/clicked
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notification | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/organizations
GetLastVisitedOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/organizations/last-visited', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/last-visited',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/organizations/last-visited
Responses
| Status | Meaning | Description | Schema |
|---|
GetMeOrganizationChildren
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/organizations/{id}/children', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{id}/children',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/organizations/{id}/children
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutMeOrganizationChildren
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/organizations/{organizationId}/children', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{organizationId}/children',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/organizations/{organizationId}/children
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | integer | true | none |
| childrenId | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostDisableOrgaMessageNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/organizations/{organizationId}/messages/disable-notifications', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{organizationId}/messages/disable-notifications',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/organizations/{organizationId}/messages/disable-notifications
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | integer | true | none |
| minutes_duration | formData | string | true | Doit respecter le pattern #^(?:^(-1 OR \d+)$)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostEnableOrgaMessageNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/organizations/{organizationId}/messages/enable-notifications', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{organizationId}/messages/enable-notifications',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/organizations/{organizationId}/messages/enable-notifications
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrgaMessageNotificationSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/organizations/{organizationId}/messages/notification-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{organizationId}/messages/notification-settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/organizations/{organizationId}/messages/notification-settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyB2bReviews
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/organizations/{organization}/reviews', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/organizations/{organization}/reviews',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/organizations/{organization}/reviews
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/payments
GetFuturePayments
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/payments/to-come', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payments/to-come',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/payments/to-come
Liste des paiements à venir avec statut erreur ou pas
Responses
| Status | Meaning | Description | Schema |
|---|
me/payout-information
GetPayoutInformation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/payout-information', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payout-information',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/payout-information
Responses
| Status | Meaning | Description | Schema |
|---|
PutAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/payout-information/address', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payout-information/address',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/payout-information/address
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address_id | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutBankAccount
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/payout-information/bank-account', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payout-information/bank-account',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/payout-information/bank-account
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| iban | formData | string | true | none |
| bic | formData | string | true | none |
| owner_name | formData | string | true | none |
| account_token | formData | string | true | Doit respecter le pattern #^(?:ct_[a-zA-Z0-9]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutDateOfBirth
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/payout-information/date-of-birth', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payout-information/date-of-birth',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/payout-information/date-of-birth
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| year | formData | string | true | none |
| month | formData | string | true | none |
| day | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutPersonToken
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/payout-information/person-token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payout-information/person-token',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/payout-information/person-token
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| token | formData | string | true | Doit respecter le pattern #^(?:cpt_[a-zA-Z0-9]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
me/payouts
GetFuturePayouts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/payouts/future-payouts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/payouts/future-payouts',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/payouts/future-payouts
Responses
| Status | Meaning | Description | Schema |
|---|
me/products
GetProducts
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/products?page=string&active=0',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/products
Liste des disciplines du coachs (actives ou pas)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| active | query | integer | true | Filtrer entre les disciplines actives ou non Doit respecter le pattern #^(?:0 OR 1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutProductPriority
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/products/{productId}/priority', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/products/{productId}/priority',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/products/{productId}/priority
Modifier la priorité d’une de ses disciplines
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productId | path | integer | true | ID discipline |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchProduct
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/me/products/{product}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/products/{product}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH me/products/{product}
Modifier les carractéristiques d’une de ses disciplines
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| price | formData | string | true | Prix du cours Doit respecter le pattern #^(?:[0-9]+(.\d+)?)$#xsu |
| keep-previous-price-for-customers | formData | string | false | Préserver l’ancien prix pour les clients Doit respecter le pattern #^(?:0 OR 1)$#xsu |
| update-price-reason | formData | string | false | Raison du changement |
Responses
| Status | Meaning | Description | Schema |
|---|
me/profile
GetProfile
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/profile', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/profile',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/profile
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization_activity_credits_balance | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchProfile
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/me/profile', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/profile',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH me/profile
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| first_name | formData | string | false | none |
| last_name | formData | string | false | none |
| corporate_get_commercial_offers | formData | string | false | none |
| corporate_get_platform_updates | formData | string | false | none |
| current_password | formData | string | false | none |
| new_password | formData | string | false | none |
| new_password_check | formData | string | false | none |
| accept_cgu | formData | string | false | none |
| locale | formData | string | false | none |
| timezone | formData | string | false | none |
| formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostConfirmPassword
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/profile/confirm-password', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/profile/confirm-password',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/profile/confirm-password
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| password | formData | string | true | none |
| reason | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProfileDeletionUrl
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/profile/deletion-url', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/profile/deletion-url?removal_key=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/profile/deletion-url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| removal_key | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProfileExportDataUrl
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/profile/export-data-url', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/profile/export-data-url?granted_key=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/profile/export-data-url
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| granted_key | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/series
GetSeries
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/me/series?page=string&serie_type=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| serie_type | query | string | true | Doit respecter le pattern #^(?:[a-z]+)$#xsu |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Serie] | false | none | none |
| »» additional_contact_information | string | false | none | extra_property |
| »» admin_notes | string | false | none | extra_property |
| »» chat_settings | string | false | none | extra_property |
| »» coach_notes | string | false | none | extra_property |
| »» conveniences | string | false | none | extra_property |
| »» files | string | false | none | extra_property |
| »» management_links | string | false | none | extra_property |
| »» managers | string | false | none | extra_property |
| »» mentionable_coaches | string | false | none | extra_property |
| »» past_lessons_count | string | false | none | extra_property |
| »» sport_identifier | string | false | none | extra_property |
| »» upcoming_lessons_count | string | false | none | extra_property |
GetSeriesEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/series/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/series/events?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/series/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutSerieEventTookPlace
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/me/series/events/{activity}/took-place', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/series/events/{activity}/took-place',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT me/series/events/{activity}/took-place
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostDisableSerieChatNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/series/{serieId}/chat/disable-notifications', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/series/{serieId}/chat/disable-notifications',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/series/{serieId}/chat/disable-notifications
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serieId | path | integer | true | none |
| minutes_duration | formData | string | true | Doit respecter le pattern #^(?:^(-1 OR \d+)$)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostEnableSerieChatNotifications
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/me/series/{serieId}/chat/enable-notifications', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/series/{serieId}/chat/enable-notifications',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST me/series/{serieId}/chat/enable-notifications
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serieId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieChatNotificationSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/series/{serieId}/chat/notification-settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/series/{serieId}/chat/notification-settings',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/series/{serieId}/chat/notification-settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serieId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerie
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/series/{serie}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/me/series/{serie}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/series/{serie}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » additional_contact_information | string | false | none | extra_property |
| » admin_notes | string | false | none | extra_property |
| » chat_settings | string | false | none | extra_property |
| » coach_notes | string | false | none | extra_property |
| » conveniences | string | false | none | extra_property |
| » files | string | false | none | extra_property |
| » management_links | string | false | none | extra_property |
| » managers | string | false | none | extra_property |
| » mentionable_coaches | string | false | none | extra_property |
| » past_lessons_count | string | false | none | extra_property |
| » sport_identifier | string | false | none | extra_property |
| » upcoming_lessons_count | string | false | none | extra_property |
me/subscription-services
GetMySubscriptionServicesPlans
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/subscription-services/plans', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/subscription-services/plans',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/subscription-services/plans
Responses
| Status | Meaning | Description | Schema |
|---|
PatchCustomerPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/me/subscription-services/plans/{customerPlan}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/subscription-services/plans/{customerPlan}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH me/subscription-services/plans/{customerPlan}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customerPlan | path | integer | true | none |
| will_renew_automatically | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
me/training-programs
GetMyTrainingPrograms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/training-programs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/training-programs',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/training-programs
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyTrainingProgram
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/training-programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/training-programs/{program}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/training-programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyTrainingProgramSubscribers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/me/training-programs/{program}/subscribers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/me/training-programs/{program}/subscribers?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET me/training-programs/{program}/subscribers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| status | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
medias
PostMedia
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/medias', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/medias',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST medias
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| extension | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | None |
GetMedia
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/medias/{media}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/medias/{media}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET medias/{media}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| media | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | None |
PatchMedia
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/medias/{media}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/medias/{media}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH medias/{media}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| media | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | None |
notifications
GetNotificationSettings
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/notifications/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/notifications/settings?client=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET notifications/settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| client | query | string | true | Client platform name (e.g. trainme-corporate-website) Doit respecter le pattern #^(?:[a-zA-Z0-9_-]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
orders
PostOrder
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/orders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/orders',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST orders
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| cart_id | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[order][activity] | query | undefined | false | none |
| extra_properties[order][cancellation_commercial_credit_available] | query | undefined | false | none |
| extra_properties[order][customer] | query | undefined | false | none |
| extra_properties[order][discounts] | query | undefined | false | none |
| extra_properties[order][history] | query | undefined | false | none |
| extra_properties[order][payment_instalment_plan] | query | undefined | false | none |
| extra_properties[order][permissions] | query | undefined | false | none |
| extra_properties[order][product] | query | undefined | false | none |
Example responses
201 Response
{
"activity": "string",
"cancellation_commercial_credit_available": "string",
"customer": "string",
"discounts": "string",
"history": "string",
"payment_instalment_plan": "string",
"permissions": "string",
"product": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Opération réussie | Inline |
| 400 | Bad Request | Panier non valide | None |
| 500 | Internal Server Error | Erreur durant la création de la commande | None |
Response Schema
Status Code 201
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » activity | string | false | none | extra_property |
| » cancellation_commercial_credit_available | string | false | none | extra_property |
| » customer | string | false | none | extra_property |
| » discounts | string | false | none | extra_property |
| » history | string | false | none | extra_property |
| » payment_instalment_plan | string | false | none | extra_property |
| » permissions | string | false | none | extra_property |
| » product | string | false | none | extra_property |
organizations
DeleteOrganizationContent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/organizations/contents/{content}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/contents/{content}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE organizations/contents/{content}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| content | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetStatuses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/customers/statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/customers/statuses',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/customers/statuses
Responses
| Status | Meaning | Description | Schema |
|---|
GetReactions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/messages/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/reactions',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/messages/reactions
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrgaMessage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/messages/{message}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/messages/{message}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteOrgaMessage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/organizations/messages/{message}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE organizations/messages/{message}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchOrgaMessage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/organizations/messages/{message}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH organizations/messages/{message}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
| text | formData | string | false | edited text |
| pinned | formData | string | false | 1 to pinned |
| pinned_title | formData | string | false | add pinned title |
Responses
| Status | Meaning | Description | Schema |
|---|
GetComments
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/messages/{message}/comments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}/comments?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/messages/{message}/comments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| before | query | string | false | Timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| deleted | query | string | false | 1 to print archived Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostComment
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/messages/{message}/comments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}/comments',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/messages/{message}/comments
Envoi d’un nouveau commentaire sur un message
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
| text | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetReactionsDetails
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/messages/{message}/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}/reactions?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/messages/{message}/reactions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| reactionId | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutReaction
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/organizations/messages/{message}/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}/reactions',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT organizations/messages/{message}/reactions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteReaction
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/organizations/messages/{message}/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/messages/{message}/reactions',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE organizations/messages/{message}/reactions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetB2bReviewStatus
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/reviews/status', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/reviews/status',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/reviews/status
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationAddresses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{id}/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{id}/addresses?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{id}/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{id}/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{id}/addresses',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{id}/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| given_name | formData | string | true | none |
| address_line1 | formData | string | true | none |
| address_line2 | formData | string | false | none |
| locality | formData | string | true | none |
| postal_code | formData | string | true | none |
| country_code | formData | string | true | none |
| further_information | formData | string | false | none |
| sorting_code | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationChildren
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{id}/children', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{id}/children?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{id}/children
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutOrganizationAddress
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/organizations/{organizationId}/addresses/{addressId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organizationId}/addresses/{addressId}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT organizations/{organizationId}/addresses/{addressId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organizationId | path | integer | true | none |
| addressId | path | integer | true | none |
| given_name | formData | string | true | none |
| address_line1 | formData | string | true | none |
| address_line2 | formData | string | false | none |
| locality | formData | string | true | none |
| postal_code | formData | string | true | none |
| country_code | formData | string | true | none |
| further_information | formData | string | false | none |
| sorting_code | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationSeries
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/series',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| serie | query | string | false | ID Serie Doit respecter le pattern #^(?:\d+)$#xsu |
| coach | query | string | false | ID Coach Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| date_range | query | string | false | none |
| at_date | query | string | false | none |
| video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| without_video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| serie_type | query | string | false | Type de la série lié à l’activité |
| with_myclub | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PutVimeoVideoStatistics
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/organizations/{organization_id}/videos/{video_id}/statistics', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization_id}/videos/{video_id}/statistics',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT organizations/{organization_id}/videos/{video_id}/statistics
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | integer | true | none |
| video_id | path | integer | true | none |
| id_customer | formData | string | true | none |
| action | formData | string | true | none |
| current_time | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| percent | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSendActivityInvitations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/activities/{activity}/invitations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/activities/{activity}/invitations',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/activities/{activity}/invitations
Invitation de plusieurs customers par email à rejoindre une activité
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| emails | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCampaigns
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/campaigns', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/campaigns?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/campaigns
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCampaignLeaderboardActions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/campaigns/{campaign}/actions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/campaigns/{campaign}/actions',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/campaigns/{campaign}/actions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| campaign | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationGroupLeaderboard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/group-leaderboard', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/group-leaderboard?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/group-leaderboard
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| month | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| year | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetIndividualLeaderboard
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/individual-leaderboard', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/individual-leaderboard?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/individual-leaderboard
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| month | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| year | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetLeaderboardForCustomer
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/leaderboard/{customer}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/leaderboard/{customer}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/leaderboard/{customer}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| customer | path | integer | true | none |
| month | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| year | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetLeaderboardDetailsForCustomer
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/leaderboard/{customer}/details', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/leaderboard/{customer}/details',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/leaderboard/{customer}/details
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| customer | path | integer | true | none |
| month | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| year | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationCGU
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/cgu', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/cgu',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/cgu
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationCoaches
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/coaches', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/coaches',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/coaches
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| serie | query | string | false | none |
| ending_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| date_range | query | string | false | none |
| at_date | query | string | false | none |
| activities | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationContent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/contents/{content}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/contents/{content}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/contents/{content}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| content | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrganizationContentResponse
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/contents/{content}/response', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/contents/{content}/response?responseId=string&formId=string',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/contents/{content}/response
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| content | path | integer | true | none |
| responseId | query | string | true | none |
| formId | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCustomers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/customers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/customers?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/customers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| search | query | string | false | none |
| status | query | string | false | none |
| groupsId | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutCustomer
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/organizations/{organization}/customers/{action}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/customers/{action}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT organizations/{organization}/customers/{action}
Modification de plusieurs customers d’une organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customers | formData | string | false | none |
| group_status | formData | string | false | none |
| group_groups | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationEventLocations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/event-locations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/event-locations',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/event-locations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| starting_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| starting_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| coach | query | string | false | ID Coach Doit respecter le pattern #^(?:\d+)$#xsu |
| sport | query | string | false | ID Category Doit respecter le pattern #^(?:\d+)$#xsu |
| serie | query | string | false | ID Serie Doit respecter le pattern #^(?:\d+)$#xsu |
| at_date | query | string | false | none |
| date_range | query | string | false | none |
| activities | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| new_activities | query | string | false | none |
| slot_available | query | string | false | none |
| location | query | string | false | object with latitude,longitude, and radius in km |
| serie_type | query | string | false | Type de la série lié à l’activité |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/events?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/events
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| with_organization | query | string | false | none |
| with_coaches | query | string | false | none |
| with_series | query | string | false | none |
| with_sports | query | string | false | none |
| sort | query | string | false | none |
| starting_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| starting_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| coach | query | string | false | ID Coach Doit respecter le pattern #^(?:\d+)$#xsu |
| sport | query | string | false | ID Category Doit respecter le pattern #^(?:\d+)$#xsu |
| serie | query | string | false | ID Serie Doit respecter le pattern #^(?:\d+)$#xsu |
| at_date | query | string | false | none |
| date_range | query | string | false | none |
| activities | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| without_video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| new_activities | query | string | false | none |
| slot_available | query | string | false | none |
| location | query | string | false | object with latitude,longitude, and radius in km |
| location_only | query | string | false | none |
| serie_type | query | string | false | Type de la série lié à l’activité |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationForms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/forms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/forms?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/forms
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationGroups
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/groups',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/groups
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationGymSlots
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/gym-slots', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/gym-slots',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/gym-slots
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| serie | query | string | false | ID Serie Doit respecter le pattern #^(?:\d+)$#xsu |
| date | query | string | false | Date YYYY-MM-DD Doit respecter le pattern #^(?:[0-9-]+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetInvitations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/invitations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/invitations?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/invitations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| search | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostInvitation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/invitations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/invitations',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/invitations
Invitation d’un nouveau customer sur une organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstname | formData | string | false | none |
| lastname | formData | string | false | none |
| formData | string | true | none | |
| custom_message | formData | string | false | none |
| preview_mail | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteInvitations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/organizations/{organization}/invitations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/invitations',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE organizations/{organization}/invitations
Suppression de plusieurs invitations d’une organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| invitations | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostImportInvitation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/invitations/import', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/invitations/import',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/invitations/import
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| file | formData | string | false | none |
| custom_message | formData | string | false | none |
| ignore_errors_and_send | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSendInvitations
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/invitations/send', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/invitations/send',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/invitations/send
Invitation de plusieurs customers par email à rejoindre une organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| invitations | formData | string | false | none |
| custom_message | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMentionableCustomers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/mentionable-customers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/mentionable-customers?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/mentionable-customers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| search | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrgaMessage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/organizations/{organization}/messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/messages',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST organizations/{organization}/messages
Envoi d’un nouveau message
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| text | formData | string | true | none |
| need_email_for_all | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrgaMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/messages?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| before | query | string | false | Timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| deleted | query | string | false | 1 to print archived Doit respecter le pattern #^(?:\d+)$#xsu |
| pinned | query | string | false | get pinned messages |
Responses
| Status | Meaning | Description | Schema |
|---|
GetPrograms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/programs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/programs?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/programs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| visible | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProgram
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/programs/{program}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutProgramsIntoOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/organizations/{organization}/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/programs/{program}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT organizations/{organization}/programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteProgramsFromOrganization
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/organizations/{organization}/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/programs/{program}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE organizations/{organization}/programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProgramVideos
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/programs/{program}/videos', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/programs/{program}/videos?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/programs/{program}/videos
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| program | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| filter_category | query | string | false | none |
| filter_new | query | string | false | none |
| filter_max_duration | query | string | false | none |
| filter_min_duration | query | string | false | none |
| filter_name | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetPDF
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/qr-code/pdf', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/qr-code/pdf',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/qr-code/pdf
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetB2bReview
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/reviews/{B2bReview}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/reviews/{B2bReview}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/reviews/{B2bReview}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| B2bReview | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchB2bReview
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/organizations/{organization}/reviews/{B2bReview}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/reviews/{B2bReview}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH organizations/{organization}/reviews/{B2bReview}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| B2bReview | path | integer | true | none |
| comment | formData | string | false | none |
| note | formData | string | false | none |
| postponed | formData | string | false | none |
| lastDisplay | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchB2bReviewDisplayed
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/organizations/{organization}/reviews/{B2bReview}/displayed', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/reviews/{B2bReview}/displayed',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH organizations/{organization}/reviews/{B2bReview}/displayed
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| B2bReview | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchB2bReviewPostponed
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/organizations/{organization}/reviews/{B2bReview}/postponed', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/reviews/{B2bReview}/postponed',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH organizations/{organization}/reviews/{B2bReview}/postponed
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
| B2bReview | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationSports
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/sports', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/sports',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/sports
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | string | true | none |
| ending_after | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| ending_before | query | string | false | timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| date_range | query | string | false | none |
| at_date | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetOrganizationVideoReplay
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/organizations/{organization}/videos-replay', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/organizations/{organization}/videos-replay',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET organizations/{organization}/videos-replay
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| organization | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
partners
GetUserAccessToken
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/partners/authenticate', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/partners/authenticate',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET partners/authenticate
Obtention d’un accessToken pour santéClair
Responses
| Status | Meaning | Description | Schema |
|---|
PostPartnerUser
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/partners/createUser', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/partners/createUser',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST partners/createUser
Création d’un utilisateur partenaire SantéClair
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstname | formData | string | true | Prénom de l’utilisateur |
| lastname | formData | string | true | none |
| formData | string(email) | true | none | |
| organism | formData | string | true | none |
| storageConsent | formData | string | false | Doit respecter le pattern #^(?:0 OR 1 OR true OR false)$#xsu |
| gender | formData | string | true | Doit respecter le pattern #^(?:1 OR 2)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostQuotationRequest
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/partners/ffa/quotation-requests', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/partners/ffa/quotation-requests',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST partners/ffa/quotation-requests
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| company | formData | string | true | none |
| day | formData | string | true | none |
| day2 | formData | string | false | none |
| duration | formData | string | true | none |
| formData | string(email) | true | none | |
| firstname | formData | string | true | none |
| lastname | formData | string | true | none |
| frequency | formData | string | true | none |
| hour | formData | string | true | none |
| hour2 | formData | string | false | none |
| offer | formData | string | true | none |
| person | formData | string | true | none |
| phone | formData | string | true | none |
| place | formData | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProduct
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/partners/fitness-park/product/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/partners/fitness-park/product/{id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET partners/fitness-park/product/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostUserEmail
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/partners/setEmail', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/partners/setEmail',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST partners/setEmail
Mise à jour d’un email pour un utilisateur partenaire (santéclair)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | formData | string | true | Doit respecter le pattern #^(?:[a-zA-Z0-9]+)$#xsu |
| formData | string(email) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
payments
GetPayments
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/payments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/payments?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET payments
Virements faits au coach
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| month | query | string | false | Doit respecter le pattern #^(?:[0-9]{1,2})$#xsu |
| year | query | string | false | Doit respecter le pattern #^(?:[0-9]{4})$#xsu |
| paid_before | query | string | false | Timestamp : payé avant le… Doit respecter le pattern #^(?:\d+)$#xsu |
| paid_after | query | string | false | Timestamp : payé après le… Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[payment][activity] | query | undefined | false | none |
| extra_properties[payment][activity_date] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"activity": "string",
"activity_date": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Payout] | false | none | none |
| »» activity | string | false | none | extra_property |
| »» activity_date | string | false | none | extra_property |
product_seen
PostProductSeen
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/product_seen', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/product_seen',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST product_seen
Remplacement d’une route legacy pour ajouter une vue à un produit
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_product | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
programs
GetPrograms
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/programs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET programs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| visible | query | string | false | none |
| for_all_organizations | query | string | false | none |
| archived | query | string | false | none |
| id | query | string | false | none |
| search | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetProgram
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs/{program}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchProgram
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs/{program}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
| name | formData | string | false | none |
| description | formData | string | false | none |
| categories | formData | string | false | none |
| visible | formData | string | false | none |
| for_all_organizations | formData | string | false | none |
| display_name | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteProgram
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/programs/{program}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs/{program}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE programs/{program}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostProgramCover
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/programs/{program}/cover', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs/{program}/cover',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST programs/{program}/cover
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteProgramCover
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/programs/{program}/cover', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/programs/{program}/cover',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE programs/{program}/cover
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| program | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
providers
GetEvents
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/providers/live-storm/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/providers/live-storm/events',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET providers/live-storm/events
Responses
| Status | Meaning | Description | Schema |
|---|
GetEventSessions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/providers/live-storm/events/{event}/sessions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/providers/live-storm/events/{event}/sessions',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET providers/live-storm/events/{event}/sessions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| event | path | string | true | none |
| status | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostImportActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/providers/live-storm/import/{session}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/providers/live-storm/import/{session}',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST providers/live-storm/import/{session}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| session | path | string | true | none |
| serie | formData | string | true | none |
| product | formData | string | true | none |
| duration | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| price | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
public-series
GetPublicSeries
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/public-series', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/public-series?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET public-series
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[serie][additional_contact_information] | query | undefined | false | none |
| extra_properties[serie][admin_notes] | query | undefined | false | none |
| extra_properties[serie][chat_settings] | query | undefined | false | none |
| extra_properties[serie][coach_notes] | query | undefined | false | none |
| extra_properties[serie][conveniences] | query | undefined | false | none |
| extra_properties[serie][files] | query | undefined | false | none |
| extra_properties[serie][management_links] | query | undefined | false | none |
| extra_properties[serie][managers] | query | undefined | false | none |
| extra_properties[serie][mentionable_coaches] | query | undefined | false | none |
| extra_properties[serie][past_lessons_count] | query | undefined | false | none |
| extra_properties[serie][sport_identifier] | query | undefined | false | none |
| extra_properties[serie][upcoming_lessons_count] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"additional_contact_information": "string",
"admin_notes": "string",
"chat_settings": "string",
"coach_notes": "string",
"conveniences": "string",
"files": "string",
"management_links": "string",
"managers": "string",
"mentionable_coaches": "string",
"past_lessons_count": "string",
"sport_identifier": "string",
"upcoming_lessons_count": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Serie] | false | none | none |
| »» additional_contact_information | string | false | none | extra_property |
| »» admin_notes | string | false | none | extra_property |
| »» chat_settings | string | false | none | extra_property |
| »» coach_notes | string | false | none | extra_property |
| »» conveniences | string | false | none | extra_property |
| »» files | string | false | none | extra_property |
| »» management_links | string | false | none | extra_property |
| »» managers | string | false | none | extra_property |
| »» mentionable_coaches | string | false | none | extra_property |
| »» past_lessons_count | string | false | none | extra_property |
| »» sport_identifier | string | false | none | extra_property |
| »» upcoming_lessons_count | string | false | none | extra_property |
santeclair
GetActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/santeclair/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/santeclair/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET santeclair/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| after | query | string | false | none |
| before | query | string | false | none |
| video_conference | query | string | false | none |
| without_video_conference | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
serie-messages
PostSerieMessage
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/serie-messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/serie-messages',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST serie-messages
Envoi d’un nouveau message Serie
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| text | formData | string | true | none |
| id_serie | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/serie-messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/serie-messages?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET serie-messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
series
GetInvoice
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/series/membership-fees/{membershipId}/invoice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/membership-fees/{membershipId}/invoice',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET series/membership-fees/{membershipId}/invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| membershipId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetReactions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/series/messages/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/messages/reactions',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET series/messages/reactions
Responses
| Status | Meaning | Description | Schema |
|---|
GetSerieMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/series/{serie}/messages', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/{serie}/messages?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET series/{serie}/messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| before | query | string | false | Timestamp Doit respecter le pattern #^(?:\d+)$#xsu |
| deleted | query | string | false | 1 to print archived Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteSerieMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/series/{serie}/messages/{message}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/{serie}/messages/{message}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE series/{serie}/messages/{message}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PatchSerieMessages
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/series/{serie}/messages/{message}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/{serie}/messages/{message}',
{
method: 'PATCH'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PATCH series/{serie}/messages/{message}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
DeleteReactions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/series/{serie}/messages/{message}/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/{serie}/messages/{message}/reactions',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE series/{serie}/messages/{message}/reactions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutReactions
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/series/{serie}/messages/{message}/reactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/series/{serie}/messages/{message}/reactions',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT series/{serie}/messages/{message}/reactions
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| serie | path | integer | true | none |
| message | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
sports
GetSports
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
sports-classes
GetSportsClasses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-classes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports-classes?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-classes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| query_filter | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetSportClassesAwaitingReview
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-classes/awaiting-review', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports-classes/awaiting-review',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-classes/awaiting-review
Responses
| Status | Meaning | Description | Schema |
|---|
GetSportClassCandidateAddresses
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-classes/{productId}/candidate-addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports-classes/{productId}/candidate-addresses',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-classes/{productId}/candidate-addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSportClassComment
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/sports-classes/{product}/comment', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports-classes/{product}/comment',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST sports-classes/{product}/comment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product | path | string | true | none |
| comment | formData | string | true | none |
| grade | formData | string | true | Doit respecter le pattern #^(?:[0-5])$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
sports-coaches
GetCoaches
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-coaches', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/sports-coaches?page=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-coaches
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| extra_properties[coach][address] | query | undefined | false | none |
| extra_properties[coach][athlete_exercises_count] | query | undefined | false | none |
| extra_properties[coach][b2b_note] | query | undefined | false | none |
| extra_properties[coach][catalogs] | query | undefined | false | none |
| extra_properties[coach][chat_link] | query | undefined | false | none |
| extra_properties[coach][city] | query | undefined | false | none |
| extra_properties[coach][comments] | query | undefined | false | none |
| extra_properties[coach][health] | query | undefined | false | none |
| extra_properties[coach][last_lesson_with] | query | undefined | false | none |
| extra_properties[coach][last_name] | query | undefined | false | none |
| extra_properties[coach][moving_area] | query | undefined | false | none |
| extra_properties[coach][phone] | query | undefined | false | none |
| extra_properties[coach][private_notes_count] | query | undefined | false | none |
| extra_properties[coach][products] | query | undefined | false | none |
| extra_properties[coach][rating] | query | undefined | false | none |
Example responses
200 Response
{
"page": 0,
"pagesCount": 0,
"resourcesPerPage": 0,
"recordsTotal": 0,
"recordsFiltered": 0,
"resources": [
{
"address": "string",
"athlete_exercises_count": "string",
"b2b_note": "string",
"catalogs": "string",
"chat_link": "string",
"city": "string",
"comments": "string",
"health": "string",
"last_lesson_with": "string",
"last_name": "string",
"moving_area": "string",
"phone": "string",
"private_notes_count": "string",
"products": "string",
"rating": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » page | integer | false | none | Page courante |
| » pagesCount | integer | false | none | Nombre de pages disponibles |
| » resourcesPerPage | integer | false | none | Nombre de resources par page |
| » recordsTotal | integer | false | none | Nombre de resources au total |
| » recordsFiltered | integer | false | none | Nombre de resources en fonction des filtres |
| » resources | [#/definitions/Coach] | false | none | none |
| »» address | string | false | none | extra_property |
| »» athlete_exercises_count | string | false | none | extra_property |
| »» b2b_note | string | false | none | extra_property |
| »» catalogs | string | false | none | extra_property |
| »» chat_link | string | false | none | extra_property |
| »» city | string | false | none | extra_property |
| »» comments | string | false | none | extra_property |
| »» health | string | false | none | extra_property |
| »» last_lesson_with | string | false | none | extra_property |
| »» last_name | string | false | none | extra_property |
| »» moving_area | string | false | none | extra_property |
| »» phone | string | false | none | extra_property |
| »» private_notes_count | string | false | none | extra_property |
| »» products | string | false | none | extra_property |
| »» rating | string | false | none | extra_property |
GetCoachAvailability
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-coaches/{coachId}/calendar/availability', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/sports-coaches/{coachId}/calendar/availability?start=string&end=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-coaches/{coachId}/calendar/availability
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| coachId | path | string | true | none |
| start | query | string | true | none |
| end | query | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetCoach
Code samples
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/sports-coaches/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('/sports-coaches/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET sports-coaches/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| extra_properties[coach][address] | query | undefined | false | none |
| extra_properties[coach][athlete_exercises_count] | query | undefined | false | none |
| extra_properties[coach][b2b_note] | query | undefined | false | none |
| extra_properties[coach][catalogs] | query | undefined | false | none |
| extra_properties[coach][chat_link] | query | undefined | false | none |
| extra_properties[coach][city] | query | undefined | false | none |
| extra_properties[coach][comments] | query | undefined | false | none |
| extra_properties[coach][health] | query | undefined | false | none |
| extra_properties[coach][last_lesson_with] | query | undefined | false | none |
| extra_properties[coach][last_name] | query | undefined | false | none |
| extra_properties[coach][moving_area] | query | undefined | false | none |
| extra_properties[coach][phone] | query | undefined | false | none |
| extra_properties[coach][private_notes_count] | query | undefined | false | none |
| extra_properties[coach][products] | query | undefined | false | none |
| extra_properties[coach][rating] | query | undefined | false | none |
Example responses
200 Response
{
"address": "string",
"athlete_exercises_count": "string",
"b2b_note": "string",
"catalogs": "string",
"chat_link": "string",
"city": "string",
"comments": "string",
"health": "string",
"last_lesson_with": "string",
"last_name": "string",
"moving_area": "string",
"phone": "string",
"private_notes_count": "string",
"products": "string",
"rating": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opération réussie | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » address | string | false | none | extra_property |
| » athlete_exercises_count | string | false | none | extra_property |
| » b2b_note | string | false | none | extra_property |
| » catalogs | string | false | none | extra_property |
| » chat_link | string | false | none | extra_property |
| » city | string | false | none | extra_property |
| » comments | string | false | none | extra_property |
| » health | string | false | none | extra_property |
| » last_lesson_with | string | false | none | extra_property |
| » last_name | string | false | none | extra_property |
| » moving_area | string | false | none | extra_property |
| » phone | string | false | none | extra_property |
| » private_notes_count | string | false | none | extra_property |
| » products | string | false | none | extra_property |
| » rating | string | false | none | extra_property |
stripe-wrapper
PostCorporateMembershipFeePaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/corporate-membership-fee', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/corporate-membership-fee',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/corporate-membership-fee
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| corporate_membership_fee_id | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostDebtPaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/debts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/debts',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/debts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostGiftCardPaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/gift-card', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/gift-card',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/gift-card
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| formData | string(email) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostOrderPaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/order', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/order',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/order
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | integer | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| cart | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostPaymentInstalmentPaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/payment-instalment', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/payment-instalment',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/payment-instalment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| cart | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSubscriptionServicePaymentIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/payment-intents/subscription-service', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/payment-intents/subscription-service',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/payment-intents/subscription-service
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payment_method | formData | string | false | none |
| amount | formData | string | true | none |
| currency | formData | string | true | Doit respecter le pattern #^(?:EUR OR eur)$#xsu |
| save_payment_method | formData | string | false | Doit respecter le pattern #^(?:1 OR 0)$#xsu |
| invoice_address_id | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| plan | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
PostSetupIntent
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/stripe-wrapper/setup-intent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/stripe-wrapper/setup-intent',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST stripe-wrapper/setup-intent
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Contient le client_secret de l’intent | None |
superuser
GetUsers
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/superuser/users', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/superuser/users?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET superuser/users
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| query_filter | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
timezones
GetTimezones
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/timezones', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/timezones',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET timezones
Responses
| Status | Meaning | Description | Schema |
|---|
training-book
GetAthletes
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-book/athletes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/athletes?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-book/athletes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthleteLessons
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-book/athletes/{athleteKey}/lessons', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/athletes/{athleteKey}/lessons',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-book/athletes/{athleteKey}/lessons
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athleteKey | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetAthleteLesson
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-book/athletes/{athleteKey}/lessons/{calendarEventId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/athletes/{athleteKey}/lessons/{calendarEventId}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-book/athletes/{athleteKey}/lessons/{calendarEventId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| athleteKey | path | integer | true | none |
| calendarEventId | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetPostLessonData
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-book/post-lesson-data', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/post-lesson-data?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-book/post-lesson-data
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| with_message_to_athlete | query | integer | false | Doit respecter le pattern #^(?:0 OR 1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetPostLessonsDataToFill
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-book/post-lesson-datas/to-fill', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/post-lesson-datas/to-fill',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-book/post-lesson-datas/to-fill
Responses
| Status | Meaning | Description | Schema |
|---|
PostPostLessonData
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/training-book/post-lesson-datas/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/post-lesson-datas/{activity}',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST training-book/post-lesson-datas/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
| took_place | formData | string | true | none |
| athletes_number | formData | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| self_message | formData | string | false | none |
| message_to_athlete | formData | string | false | none |
| athlete_exercises | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutPostLessonData
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/training-book/post-lesson-datas/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-book/post-lesson-datas/{activity}',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT training-book/post-lesson-datas/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
training-programs
GetTrainingProgramPlan
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/training-programs/plans/{plan}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-programs/plans/{plan}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET training-programs/plans/{plan}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| plan | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostTrainingProgramPlanSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/training-programs/plans/{plan}/subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/training-programs/plans/{plan}/subscription',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST training-programs/plans/{plan}/subscription
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| plan | path | integer | true | none |
| payment_method | formData | string | true | none |
| address | formData | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
uh
GetActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/uh/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/uh/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET uh/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| after | query | string | false | none |
| before | query | string | false | none |
| video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| without_video_conference | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
| without_athlete_participation | query | string | false | Doit respecter le pattern #^(?:1)$#xsu |
Responses
| Status | Meaning | Description | Schema |
|---|
GetActivity
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/uh/activities/{activity}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/uh/activities/{activity}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET uh/activities/{activity}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | integer | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PutActivityCancelSubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/uh/activities/{activity}/cancel-subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/uh/activities/{activity}/cancel-subscription',
{
method: 'PUT'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT uh/activities/{activity}/cancel-subscription
Permet à un utilisateur de se désinscrire d’un événement
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
PostActivitySubscription
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/uh/activities/{activity}/subscription', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/uh/activities/{activity}/subscription',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST uh/activities/{activity}/subscription
Permet à un utilisateur de s’inscrire à un événement
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activity | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|
GetMyActivities
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/uh/me/activities', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/uh/me/activities?page=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET uh/me/activities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | true | Doit respecter le pattern #^(?:\d+)$#xsu |
| limit | query | string | false | Doit respecter le pattern #^(?:\d+)$#xsu |
| sort | query | string | false | none |
| after | query | string | false | none |
| before | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
validation
PostCartValidation
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/validation/carts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/validation/carts/{id}',
{
method: 'POST'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST validation/carts/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | none |
| payment_intent | formData | string | false | none |
| payment_method | formData | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|
zendesk-jwt
GetZendeskJWT
Code samples
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/zendesk-jwt', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('/zendesk-jwt',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET zendesk-jwt
Responses
| Status | Meaning | Description | Schema |
|---|