GetPlanningInfo

Description

Cette opération vous permet de rechercher la liste des évènements liés à une ressource (collaborateur, salle de réunion, machine) entre 2 dates.

Requête

Pour cette opération, SIMAXService a besoin de l'identifiant de la ressource, des dates de début et de fin ainsi que du formulaire à partir duquel les évènements sont recherchés.

Liste des entêtes

Entête
CustomerInfos
SessionToken
UsernameToken
OptionDialogue
APIUser
APIUUID

Liste des paramètres

Paramètre
StartTime
EndTime
Table
Resource

Exemple

=> on recherche tous les éléments fils de "planification de ressource" lié à la ressource 330224... entre le 10 et le 20 août 2010.

<GetPlanningInfo>
<Resource>330224...</Resource>
<StartTime>20100810</StartTime>
<EndTime>20100820</EndTime>
<Table></Table>
</GetPlanningInfo>

Réponse

La réponse est composée principalement de :
un schema XSD : description d'un évènement + Mise en forme par type d'élement (c'est à dire par formulaire) dans la balise layout.
une représentation XML des évènements du planning correspondant aux critères (ressource, date de debut, date de fin, table) : représentation iCal des évènements du planning

Liste des entêtes

Entête
PlanningFilter
ReturnType
CustomerInfos
XSDSchema
Action
Form

Les valeurs de retour

Xml

Exemple

=> le service a trouvé 5 événèments correspondants aux critères de recherche
-

<env:Header>
<simax-schema:Schema>
<xs:element xs:name="event">
<xs:attribute xs:name="simax:uid" xs:use="required" simax:typeElement="xs:string"/>
<xs:attribute xs:name="simax:startTime" xs:use="required"
simax:typeElement="xs:datetime"/>
<xs:attribute xs:name="simax:endTime" simax:typeElement="xs:datetime"/>
<xs:attribute xs:name="simax:summary" xs:use="required"
simax:typeElement="xs:string"/>
<xs:attribute xs:name="simax:description" simax:typeElement="xs:string"/>
<xs:attribute xs:name="simax:resource" xs:use="required"
simax:typeElement="xs:string"/>
<xs:attribute xs:name="simax:typeOfEvent" xs:use="required"
simax:typeElement="xs:string"/>
<xs:attribute xs:name="simax:rrules" simax:typeElement="xs:string"/>
<simax:layout>
<xs:element simax:typeOfEvent="8372" simax:colorRGB="00C812"/>
<xs:element simax:typeOfEvent="3017" simax:colorRGB="BAEAF3"/>
<xs:element simax:typeOfEvent="37277179771439" simax:colorRGB="D3F5E2"/>
<xs:element simax:typeOfEvent="7945" simax:colorRGB="FCEB74"/>
<xs:element simax:typeOfEvent="7988" simax:colorRGB="96EBB1"/>
<xs:element simax:typeOfEvent="8579" simax:colorRGB="FFCACB"/>
<xs:element simax:typeOfEvent="36775521162035" simax:colorRGB="FF0000"/>
<xs:element simax:typeOfEvent="40967554613888" simax:colorRGB="9180FF"/>
<xs:element simax:typeOfEvent="42826576153195" simax:colorRGB="F4EE9D"/>
...
</simax:layout>
</xs:element>
</simax-schema:Schema>
<simax-action:Action title="" typeAction="" typeReturn="Planning">0</simax-action:Action>
</env:Header>
<env:Body>
<GetPlanningInfo>
<xml>
<event simax:uid="3288673532...."
simax:startTime="00000000090000"
simax:endTime="00000000090000" simax:summary="Données de paie"
simax:resource="3302241759..." simax:typeOfEvent="8372"
simax:rrules="FREQ=MONTHLY;BYDAY=-1MO"/>
<event simax:uid="32207279083..." simax:startTime="00000000183000"
simax:endTime="00000000183000"
simax:summary="18:30 20:00 M. Dupont Sport"
simax:resource="33022417..."
simax:typeOfEvent="7945"
simax:rrules="FREQ=WEEKLY;UNTIL=20080930000000;BYDAY=TU"/>
<event simax:uid="37523239586..." simax:startTime="00000000090000"
simax:endTime="00000000090000"
simax:summary="09:00 18:00 Admin et CPT"
simax:resource="330224175..."
simax:typeOfEvent="7945" simax:rrules="FREQ=WEEKLY;BYDAY=WE"/>
<event simax:uid="50923650992..." simax:startTime="00000000140000"
simax:endTime="00000000140000"
simax:summary="14:00 15:00 Balance agée"
simax:resource="33022417..." simax:typeOfEvent="8579"
simax:rrules="FREQ=MONTHLY;BYDAY=1MO"/>
<event simax:uid="52010277719..." simax:startTime="00000000140000"
simax:endTime="00000000140000"
simax:summary="14:00 15:00 Balance agée"
simax:resource="33022417..." simax:typeOfEvent="8579"
simax:rrules="FREQ=MONTHLY;BYDAY=3MO"/>
</xml>
</GetPlanningInfo>
</env:Body>