Documentation

Client
in package

Table of Contents

agendaDetailleListIdentifiants()  : array<string|int, mixed>
agendaDetailleListObjetsTouristiques()  : array<string|int, mixed>
agendaSimpleListIdentifiants()  : array<string|int, mixed>
agendaSimpleListObjetsTouristiques()  : array<string|int, mixed>
autorisationObjetTouristiqueModification()  : string
confirmExport()  : array<string|int, mixed>
deleteMetadata()  : array<string|int, mixed>
exportConfirmation()  : array<string|int, mixed>
getEditAutorisation()  : string
getMemberById()  : array<string|int, mixed>
getMembers()  : array<string|int, mixed>
getMetadata()  : array<string|int, mixed>
getObjectById()  : array<string|int, mixed>
getObjectByIdentifier()  : array<string|int, mixed>
getReferenceCity()  : array<string|int, mixed>
getReferenceElement()  : array<string|int, mixed>
getReferenceInternalCriteria()  : array<string|int, mixed>
getReferenceSelection()  : array<string|int, mixed>
getReferenceSelectionsByObject()  : array<string|int, mixed>
getSsoToken()  : array<string|int, mixed>
getUserById()  : array<string|int, mixed>
getUserByMail()  : array<string|int, mixed>
getUserPermissionOnObject()  : string
getUserProfile()  : array<string|int, mixed>
getUsersByMember()  : array<string|int, mixed>
membreGetById()  : array<string|int, mixed>
membreGetMembres()  : array<string|int, mixed>
oauthToken()  : array<string|int, mixed>
objetTouristiqueGetById()  : array<string|int, mixed>
objetTouristiqueGetByIdentifier()  : array<string|int, mixed>
putMetadata()  : array<string|int, mixed>
rechercheListIdentifiants()  : array<string|int, mixed>
rechercheListObjetsTouristiques()  : array<string|int, mixed>
referentielCommunes()  : array<string|int, mixed>
referentielCriteresInternes()  : array<string|int, mixed>
referentielElementsReference()  : array<string|int, mixed>
referentielSelections()  : array<string|int, mixed>
referentielSelectionsParObjet()  : array<string|int, mixed>
refreshSsoToken()  : array<string|int, mixed>
searchAgenda()  : array<string|int, mixed>
searchAgendaIdentifier()  : array<string|int, mixed>
searchDetailedAgenda()  : array<string|int, mixed>
searchDetailedAgendaIdentifier()  : array<string|int, mixed>
searchObject()  : array<string|int, mixed>
searchObjectIdentifier()  : array<string|int, mixed>
ssoUtilisateurAutorisationObjetTouristiqueModification()  : string
ssoUtilisateurProfil()  : array<string|int, mixed>
utilisateurGetById()  : array<string|int, mixed>
utilisateurGetByMail()  : array<string|int, mixed>
utilisateurGetByMembre()  : array<string|int, mixed>

Methods

agendaDetailleListIdentifiants()

public agendaDetailleListIdentifiants(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

agendaDetailleListObjetsTouristiques()

public agendaDetailleListObjetsTouristiques(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

agendaSimpleListIdentifiants()

public agendaSimpleListIdentifiants(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

agendaSimpleListObjetsTouristiques()

public agendaSimpleListObjetsTouristiques(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

autorisationObjetTouristiqueModification()

public autorisationObjetTouristiqueModification(int $id[, string $tokenSSO = '' ]) : string
Parameters
$id : int

[0-9]+

$tokenSSO : string = ''

(Optional) '...'

Tags
example 
$client->autorisationObjetTouristiqueModification([0-9]+, ?'...') ;
Return values
string —

confirmExport()

public confirmExport(string $hash) : array<string|int, mixed>
Parameters
$hash : string

'...'

Tags
example 
$client->confirmExport('...') ;
Return values
array<string|int, mixed> —

deleteMetadata()

public deleteMetadata(int $referenceId, string $nodeId[, string $targetType = '' ][, int $targetId = '' ]) : array<string|int, mixed>
Parameters
$referenceId : int

[0-9]+

$nodeId : string

'...'

$targetType : string = ''

(Optional) Available values : general,membre,projet

$targetId : int = ''

(Optional) [0-9]+

Tags
example 
$client->deleteMetadata([0-9]+, '...', ?'general|membre|projet', ?[0-9]+) ;
Return values
array<string|int, mixed> —

exportConfirmation()

public exportConfirmation(string $hash) : array<string|int, mixed>
Parameters
$hash : string

'...'

Tags
example 
$client->exportConfirmation('...') ;
Return values
array<string|int, mixed> —

getEditAutorisation()

public getEditAutorisation(int $id[, string $tokenSSO = '' ]) : string
Parameters
$id : int

[0-9]+

$tokenSSO : string = ''

(Optional) '...'

Tags
example 
$client->getEditAutorisation([0-9]+, ?'...') ;
Return values
string —

getMemberById()

public getMemberById(int $id) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

Tags
example 
$client->getMemberById([0-9]+) ;
Return values
array<string|int, mixed> —

getMembers()

public getMembers(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'filter' => ]

Return values
array<string|int, mixed> —

getMetadata()

public getMetadata(int $referenceId, string $nodeId[, string $targetType = '' ][, int $targetId = '' ]) : array<string|int, mixed>
Parameters
$referenceId : int

[0-9]+

$nodeId : string

'...'

$targetType : string = ''

(Optional) Available values : general,membre,projet

$targetId : int = ''

(Optional) [0-9]+

Tags
example 
$client->getMetadata([0-9]+, '...', ?'general|membre|projet', ?[0-9]+) ;
Return values
array<string|int, mixed> —

getObjectById()

public getObjectById(int $id[, string $responseFields = '' ][, string $locales = '' ]) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

$responseFields : string = ''

(Optional) https://dev.apidae-tourisme.com/fr/documentation-technique/v2/api-de-diffusion/filtrage-des-donnees

$locales : string = ''

(Optional) Languages, separated with a comma : fr,en Available values : fr,en,de,nl,it,es,ru,zh,pt-br,ja

Tags
example 
$client->getObjectById([0-9]+, ?'@all..', ?'fr|en|de|nl|it|es|ru|zh|pt-br|ja') ;
Return values
array<string|int, mixed> —

getObjectByIdentifier()

public getObjectByIdentifier(string $identifier[, string $responseFields = '' ][, string $locales = '' ]) : array<string|int, mixed>
Parameters
$identifier : string

Object Identifier as a string (do not mistake with regular id)

$responseFields : string = ''

(Optional) '@all..'

$locales : string = ''

(Optional) Languages, separated with a comma : fr,en Available values : fr,en,de,nl,it,es,ru,zh,pt-br,ja

Tags
example 
$client->getObjectByIdentifier('sitra1234..', ?'@all..', ?'fr|en|de|nl|it|es|ru|zh|pt-br|ja') ;
Return values
array<string|int, mixed> —

getReferenceCity()

public getReferenceCity(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'communeIds' => [0,1,2...], ?'codesInsee' => ['abc','def',...] ]

Return values
array<string|int, mixed> —

getReferenceElement()

public getReferenceElement(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'elementReferenceIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

getReferenceInternalCriteria()

public getReferenceInternalCriteria(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'critereInterneIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

getReferenceSelection()

public getReferenceSelection(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'selectionIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

getReferenceSelectionsByObject()

public getReferenceSelectionsByObject(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'selectionIds' => [0,1,2...], ?'referenceIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

getSsoToken()

public getSsoToken(string $grant_type, string $code, string $redirect_uri) : array<string|int, mixed>
Parameters
$grant_type : string

Available values : authorization_code,client_credentials,refresh_token

$code : string

'...'

$redirect_uri : string

'https://myapp.com/..'

Tags
example 
$client->getSsoToken('authorization_code|client_credentials|refresh_token', '...', 'https://myapp.com/..') ;
Return values
array<string|int, mixed> —

getUserById()

public getUserById(int $id) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

Tags
example 
$client->getUserById([0-9]+) ;
Return values
array<string|int, mixed> —

getUserByMail()

public getUserByMail(string $eMail) : array<string|int, mixed>
Parameters
$eMail : string

'test@test.com'

Tags
example 
$client->getUserByMail('test@test.com') ;
Return values
array<string|int, mixed> —

getUserPermissionOnObject()

public getUserPermissionOnObject(int $id) : string
Parameters
$id : int

[0-9]+

Tags
example 
$client->getUserPermissionOnObject([0-9]+) ;
Return values
string —

getUserProfile()

public getUserProfile() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUsersByMember()

public getUsersByMember(int $membre_id) : array<string|int, mixed>
Parameters
$membre_id : int

[0-9]+

Tags
example 
$client->getUsersByMember([0-9]+) ;
Return values
array<string|int, mixed> —

membreGetById()

public membreGetById(int $id) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

Tags
example 
$client->membreGetById([0-9]+) ;
Return values
array<string|int, mixed> —

membreGetMembres()

public membreGetMembres(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'filter' => ]

Return values
array<string|int, mixed> —

oauthToken()

public oauthToken(string $grant_type, string $code, string $redirect_uri) : array<string|int, mixed>
Parameters
$grant_type : string

Available values : authorization_code,client_credentials,refresh_token

$code : string

'...'

$redirect_uri : string

'https://myapp.com/..'

Tags
example 
$client->oauthToken('authorization_code|client_credentials|refresh_token', '...', 'https://myapp.com/..') ;
Return values
array<string|int, mixed> —

objetTouristiqueGetById()

public objetTouristiqueGetById(int $id[, string $responseFields = '' ][, string $locales = '' ]) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

$responseFields : string = ''

(Optional) https://dev.apidae-tourisme.com/fr/documentation-technique/v2/api-de-diffusion/filtrage-des-donnees

$locales : string = ''

(Optional) Languages, separated with a comma : fr,en Available values : fr,en,de,nl,it,es,ru,zh,pt-br,ja

Tags
example 
$client->objetTouristiqueGetById([0-9]+, ?'@all..', ?'fr|en|de|nl|it|es|ru|zh|pt-br|ja') ;
Return values
array<string|int, mixed> —

objetTouristiqueGetByIdentifier()

public objetTouristiqueGetByIdentifier(string $identifier[, string $responseFields = '' ][, string $locales = '' ]) : array<string|int, mixed>
Parameters
$identifier : string

Object Identifier as a string (do not mistake with regular id)

$responseFields : string = ''

(Optional) '@all..'

$locales : string = ''

(Optional) Languages, separated with a comma : fr,en Available values : fr,en,de,nl,it,es,ru,zh,pt-br,ja

Tags
example 
$client->objetTouristiqueGetByIdentifier('sitra1234..', ?'@all..', ?'fr|en|de|nl|it|es|ru|zh|pt-br|ja') ;
Return values
array<string|int, mixed> —

putMetadata()

public putMetadata(int $referenceId, string $nodeId[, string $general = '' ][, string $membres = '' ][, string $projets = '' ][, string $node = '' ]) : array<string|int, mixed>
Parameters
$referenceId : int

[0-9]+

$nodeId : string

Available values : tripadvisor,opensystem,...

$general : string = ''

(Optional) '...'

$membres : string = ''

(Optional) '...'

$projets : string = ''

(Optional) '...'

$node : string = ''

(Optional) '...'

Tags
example 
$client->putMetadata([0-9]+, 'tripadvisor|opensystem|...', ?'...', ?'...', ?'...', ?'...') ;
Return values
array<string|int, mixed> —

rechercheListIdentifiants()

public rechercheListIdentifiants(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

rechercheListObjetsTouristiques()

public rechercheListObjetsTouristiques(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

referentielCommunes()

public referentielCommunes(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'communeIds' => [0,1,2...], ?'codesInsee' => ['abc','def',...] ]

Return values
array<string|int, mixed> —

referentielCriteresInternes()

public referentielCriteresInternes(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'critereInterneIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

referentielElementsReference()

public referentielElementsReference(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'elementReferenceIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

referentielSelections()

public referentielSelections(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'selectionIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

referentielSelectionsParObjet()

public referentielSelectionsParObjet(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'selectionIds' => [0,1,2...], ?'referenceIds' => [0,1,2...] ]

Return values
array<string|int, mixed> —

refreshSsoToken()

public refreshSsoToken(string $grant_type, string $refresh_token, string $redirect_uri) : array<string|int, mixed>
Parameters
$grant_type : string

Available values : authorization_code,client_credentials,refresh_token

$refresh_token : string

'...'

$redirect_uri : string

'https://myapp.com/..'

Tags
example 
$client->refreshSsoToken('authorization_code|client_credentials|refresh_token', '...', 'https://myapp.com/..') ;
Return values
array<string|int, mixed> —

searchAgenda()

public searchAgenda(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

searchAgendaIdentifier()

public searchAgendaIdentifier(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

searchDetailedAgenda()

public searchDetailedAgenda(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

searchDetailedAgendaIdentifier()

public searchDetailedAgendaIdentifier(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

searchObject()

public searchObject(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

searchObjectIdentifier()

public searchObjectIdentifier(array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed>

[ ?'identifiants' => [0,1,2...], ?'identifiers' => ['abc','def',...], ?'listeEnregistreeId' => 1234, ?'selectionIds' => [0,1,2...], ?'center' => ['type' => 'Point', 'coordinates' => [4.8 (lon), 45.3 (lat)]], ?'radius' => 1234, ?'communeCodesInsee' => ['abc','def',...], ?'territoireIds' => [0,1,2...], ?'searchQuery' => 'abcd...', ?'searchFields' => 'NOM|NOM_DESCRIPTION|NOM_DESCRIPTION_CRITERES', ?'criteresQuery' => 'abcd...', ?'dateDebut' => '2022-05-06', ?'dateFin' => '2022-05-06', ?'first' => 1234, ?'count' => 1234, ?'order' => 'PERTINENCE|NOM|DISTANCE|IDENTIFIANT|DATE_OUVERTURE|RANDOM', ?'asc' => , ?'locales' => ['abc','def',...], ?'responseFields' => ['@all','informations.moyensCommunication','...'], ?'apiKey' => 'abcd...', ?'projetId' => 1234, ?'randomSeed' => 'abcd...', ?'membreProprietaireIds' => [0,1,2...], ?'searchLocale' => 'abcd...' ]

Return values
array<string|int, mixed> —

ssoUtilisateurAutorisationObjetTouristiqueModification()

public ssoUtilisateurAutorisationObjetTouristiqueModification(int $id) : string
Parameters
$id : int

[0-9]+

Tags
example 
$client->ssoUtilisateurAutorisationObjetTouristiqueModification([0-9]+) ;
Return values
string —

ssoUtilisateurProfil()

public ssoUtilisateurProfil() : array<string|int, mixed>
Return values
array<string|int, mixed> —

utilisateurGetById()

public utilisateurGetById(int $id) : array<string|int, mixed>
Parameters
$id : int

[0-9]+

Tags
example 
$client->utilisateurGetById([0-9]+) ;
Return values
array<string|int, mixed> —

utilisateurGetByMail()

public utilisateurGetByMail(string $eMail) : array<string|int, mixed>
Parameters
$eMail : string

'test@test.com'

Tags
example 
$client->utilisateurGetByMail('test@test.com') ;
Return values
array<string|int, mixed> —

utilisateurGetByMembre()

public utilisateurGetByMembre(int $membre_id) : array<string|int, mixed>
Parameters
$membre_id : int

[0-9]+

Tags
example 
$client->utilisateurGetByMembre([0-9]+) ;
Return values
array<string|int, mixed> —

Search results