Web Shop - Web Services by xuyuzhu

VIEWS: 8 PAGES: 211

									ReCreateX Web Shop
     Web Services 2.0
Inhoudsopgave
1                       HISTORIEK ..............................................................................................................................17

2                       INLEIDING ..............................................................................................................................18

3                       ALGEMENE PRINCIPES ..........................................................................................................19

    3.1                 DE SERVICE CONTEXT ...................................................................................................................... 19
    3.2                 HET GEBRUIK VAN DE DOMAINOBJECTEN ............................................................................................ 19
    3.3                 DE BASKET OPERATIES ....................................................................................................................... 19
      3.3.1             Check-out .................................................................................................................................. 20
      3.3.2             Validatie ..................................................................................................................................... 20
      3.3.3             Lock en Unlock van basket-items .......................................................................................... 20
    3.4                 HET AANMAKEN VAN BASKET-ITEMS .................................................................................................... 21
                                                                                                                                                                              2
4                       ALGEMENE WEBSERVICES ....................................................................................................22

    4.1                 XXXSPECIFIEDFIELD ........................................................................................................................... 22

    4.2                 PAGING CRITERIA ............................................................................................................................ 22
    4.3                 SORTING CRITERIA ........................................................................................................................... 22

5                       ARTICLES................................................................................................................................23

    5.1                 FIND ARTICLES .................................................................................................................................. 23
      5.1.1             Request ....................................................................................................................................... 23
          5.1.1.1       ArticleSearchCriteria ................................................................................................................ 23
          5.1.1.2       ArticleIncludes ........................................................................................................................... 24
      5.1.2             Response .................................................................................................................................... 25
    5.2                 LISTARTICLEGROUPS ........................................................................................................................ 26
      5.2.1             Request ....................................................................................................................................... 26
          5.2.1.1       ArticleGroupSearchCriteria..................................................................................................... 26
      5.2.2             Response .................................................................................................................................... 26
          5.2.2.1       ArticleGroup .............................................................................................................................. 27
    5.3                 FIND ARTICLECATEGORIES................................................................................................................. 27
      5.3.1             Request ....................................................................................................................................... 27
          5.3.1.1       ArticleCategorySearchCriteria ............................................................................................... 27
      5.3.1             Response .................................................................................................................................... 27
    5.4                 FINDPRICEGROUPS.......................................................................................................................... 28
      5.4.1             Request ....................................................................................................................................... 28
      5.4.2             Response .................................................................................................................................... 28
    5.5                 FIND ARTICLESALESORDERS ............................................................................................................... 28
      5.5.1             Request ....................................................................................................................................... 28
          5.5.1.1       ArticleSalesOrderSearchCriteria ............................................................................................. 28

Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
      5.5.2             Response .................................................................................................................................... 29
          5.5.2.1       ArticleGroup .............................................................................................................................. 29

6                       BASKET (WINKELMANDJE) ....................................................................................................31

    6.1                 BEKNOPT OVERZICHT ........................................................................................................................ 31
    6.2                 VALIDATEBASKET ............................................................................................................................. 31
      6.2.1             Request ....................................................................................................................................... 31
          6.2.1.1       Basket .......................................................................................................................................... 31
          6.2.1.2       BasketItem .................................................................................................................................. 31
          6.2.1.3       Payments .................................................................................................................................... 38
      6.2.2             Response .................................................................................................................................... 38
          6.2.2.1       BasketValidationResult ............................................................................................................. 39
          6.2.2.2       BasketItemValidationResult ..................................................................................................... 39
    6.3                 VALIDATEBASKETITEM ....................................................................................................................... 39          3
    6.4                 RECALCULATEBASKET ....................................................................................................................... 39
      6.4.1             Request ....................................................................................................................................... 40
      6.4.2             Response .................................................................................................................................... 40
    6.5                 CHECKOUTBASKET ........................................................................................................................... 40
      6.5.1             Request ....................................................................................................................................... 40
      6.5.2             Response .................................................................................................................................... 40
          6.5.2.1       SalesItems ................................................................................................................................... 40
    6.6                 LOCKBASKETITEMS ........................................................................................................................... 41
      6.6.1             Request ....................................................................................................................................... 41
      6.6.2             Response .................................................................................................................................... 41
          6.6.2.1       LockTicket ................................................................................................................................... 42
          6.6.2.2       CultureEventReservationLockTicket. ..................................................................................... 42
    6.7                 UNLOCKBASKETITEMS....................................................................................................................... 43
      6.7.1             Request ....................................................................................................................................... 43
    6.8                 EXTENDLOCKPERIOD ....................................................................................................................... 43
      6.8.1             Request ....................................................................................................................................... 43
    6.9                 LISTPAYMENTMETHODS .................................................................................................................... 43
      6.9.1             Request ....................................................................................................................................... 43
      6.9.2             Response .................................................................................................................................... 43

7                       PROFIEL ..................................................................................................................................45

    7.1                 BEKNOPT OVERZICHT ........................................................................................................................ 45
    7.2                 VALIDATEUSERNAME ....................................................................................................................... 45
      7.2.1             Request ....................................................................................................................................... 45
      7.2.2             Response .................................................................................................................................... 45
    7.3                 AUTHENTICATEUSER.......................................................................................................................... 45


Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
      7.3.1             Request ....................................................................................................................................... 46
      7.3.2             Response .................................................................................................................................... 46
   7.4                  AUTHENTICATENATIONALNUMBER ..................................................................................................... 46
      7.4.1             Request ....................................................................................................................................... 46
      7.4.2             Response .................................................................................................................................... 47
   7.5                  AUTHENTICATEMANAGER ................................................................................................................. 47
      7.5.1             Request ....................................................................................................................................... 47
      7.5.2             Response .................................................................................................................................... 47
   7.6                  SAVEPERSON .................................................................................................................................. 48
      7.6.1             Request ....................................................................................................................................... 48
          7.6.1.1       Person .......................................................................................................................................... 48
          7.6.1.2       PersonName .............................................................................................................................. 49
          7.6.1.3       Address ....................................................................................................................................... 49
          7.6.1.4       PersonSettings ............................................................................................................................ 50         4

          7.6.1.5       PersonPriceGroup ..................................................................................................................... 50
          7.6.1.6       PersonLLVInfo ............................................................................................................................. 51
          7.6.1.7       PersonLLVTransferHistory .......................................................................................................... 51
          7.6.1.8       PersonChildCareInfo ................................................................................................................ 52
          7.6.1.9       ChildCareSchool ....................................................................................................................... 52
          7.6.1.10      ChildCareTariff........................................................................................................................... 53
          7.6.1.11      Credential .................................................................................................................................. 53
      7.6.2             Response .................................................................................................................................... 53
          7.6.2.1       SavePersonResult ...................................................................................................................... 53
          7.6.2.2       ValidationResult......................................................................................................................... 53
   7.7                  SAVEPERSONCONTACTS .................................................................................................................. 54
      7.7.1             Request ....................................................................................................................................... 54
          7.7.1.1       Person .......................................................................................................................................... 54
      7.7.2             Response .................................................................................................................................... 54
          7.7.2.1       Person .......................................................................................................................................... 54
          7.7.2.2       ValidationResult......................................................................................................................... 54
   7.8                  SAVEPERSONPRICEGROUPS ............................................................................................................. 55
      7.8.1             Request ....................................................................................................................................... 55
      7.8.2             Response .................................................................................................................................... 55
   7.9                  SAVEPERSONRELATION .................................................................................................................... 55
      7.9.1             Request ....................................................................................................................................... 55
      7.9.2             Response .................................................................................................................................... 55
   7.10                 DELETEPERSONRELATION .................................................................................................................. 56
      7.10.1            Request ....................................................................................................................................... 56
      7.10.2            Response .................................................................................................................................... 56



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
    7.11                FINDPERSON ................................................................................................................................... 56
      7.11.1            Request ....................................................................................................................................... 56
           7.11.1.1     FindPersonsCriteria .................................................................................................................... 56
           7.11.1.2     PersonIncludes........................................................................................................................... 57
      7.11.2            Response .................................................................................................................................... 57
    7.12                FORGOTPASSWORD ......................................................................................................................... 57
      7.12.1            Request ....................................................................................................................................... 57
      7.12.2            Response .................................................................................................................................... 58
    7.13                FINDPERSONDELIVERYADDRESSES ..................................................................................................... 58
      7.13.1            Request ....................................................................................................................................... 58
      7.13.2            Response .................................................................................................................................... 58
    7.14                DELETEPERSONDELIVERYADDRESS ..................................................................................................... 59
      7.14.1            Request ....................................................................................................................................... 59
      7.14.2            Response .................................................................................................................................... 59     5

    7.15                SAVEPERSONDELIVERY ADDRESS ....................................................................................................... 59
      7.15.1            Request ....................................................................................................................................... 59
      7.15.2            Response .................................................................................................................................... 60
           7.15.2.1     SavePersonDeliveryAddressResult ......................................................................................... 60
           7.15.2.2     ValidationResult......................................................................................................................... 60
    7.16                GETPERSONCHIPKNIP ...................................................................................................................... 60
      7.16.1            Request ....................................................................................................................................... 60
      7.16.2            Response .................................................................................................................................... 60
    7.17                GETPERSONCREDITS ........................................................................................................................ 61
      7.17.1            Request ....................................................................................................................................... 61
      7.17.2            Response .................................................................................................................................... 61

8                       MODULE LEERLINGENVOLGSYSTEEM (VANAF RCX 5.0.5) ..................................................63

    8.1                 BEKNOPT OVERZICHT ........................................................................................................................ 63
    8.2                 LISTLESSONGROUPS ......................................................................................................................... 63
      8.2.1             Request ....................................................................................................................................... 63
           8.2.1.1      LessonGroupSearchCriteria .................................................................................................... 63
      8.2.2             Response .................................................................................................................................... 64
    8.3                 LISTABSENTREASONS ........................................................................................................................ 65
      8.3.1             Request ....................................................................................................................................... 65
           8.3.1.1      AbsentReasonSearchCriteria .................................................................................................. 65
      8.3.2             Response .................................................................................................................................... 65
    8.4                 LISTSTUDENTPRESENCES .................................................................................................................... 65
      8.4.1             Request ....................................................................................................................................... 65
           8.4.1.1      StudentPresenceSearchCriteria ............................................................................................. 65
      8.4.2             Response .................................................................................................................................... 66


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
   8.5                  LISTNORMS ..................................................................................................................................... 66
      8.5.1             Request ....................................................................................................................................... 66
          8.5.1.1       NormSearchCriteria .................................................................................................................. 66
      8.5.2             Response .................................................................................................................................... 66
   8.6                  LISTSTUDENTFOLLOWSCORES ............................................................................................................ 67
      8.6.1             Request ....................................................................................................................................... 67
          8.6.1.1       StudentFollowScoreSearchCriteria ........................................................................................ 67
      8.6.2             Response .................................................................................................................................... 67
   8.7                  LISTWAITINGLISTS .............................................................................................................................. 68
      8.7.1             Request ....................................................................................................................................... 68
          8.7.1.1       WaitingListSearchCriteria ......................................................................................................... 68
      8.7.2             Response .................................................................................................................................... 68
   8.8                  LISTSWIMMINGLEVELS ....................................................................................................................... 69
      8.8.1             Request ....................................................................................................................................... 69   6

          8.8.1.1       SwimmingLevelSearchCriteria ................................................................................................ 69
      8.8.2             Response .................................................................................................................................... 69
   8.9                  SAVELLVINFOTODB ........................................................................................................................ 69
      8.9.1             Request ....................................................................................................................................... 69
      8.9.2             Response .................................................................................................................................... 70
   8.10                 SAVESTUDENTTRANSFER .................................................................................................................... 70
      8.10.1            Request ....................................................................................................................................... 70
      8.10.2            Response .................................................................................................................................... 70
   8.11                 LLVMESSAGETRANSLATIONS ............................................................................................................. 70
      8.11.1            Request ....................................................................................................................................... 70
      8.11.2            Response .................................................................................................................................... 71
   8.12                 GETPERSONLLVINFOBYLESSONGROUP ............................................................................................. 71
      8.12.1            Request ....................................................................................................................................... 71
          8.12.1.1      PersonLLVInfoSearchCriteria ................................................................................................... 71
      8.12.2            Response .................................................................................................................................... 71
   8.13                 LISTSWIMMINGDIPLOMAS ................................................................................................................. 71
      8.13.1            Request ....................................................................................................................................... 71
          8.13.1.1      SwimmingDiplomaSearchCriteria .......................................................................................... 71
      8.13.2            Response .................................................................................................................................... 72
   8.14                 FINDWAITINGLISTSTUDENTOVERVIEW .................................................................................................. 72
      8.14.1            Request ....................................................................................................................................... 72
          8.14.1.1      WaitingListStudentSearchCriteria ........................................................................................... 72
      8.14.2            Response .................................................................................................................................... 72
   8.15                 DELETEWAITINGLISTSTUDENT ............................................................................................................. 73
      8.15.1            Request ....................................................................................................................................... 73



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
      8.15.2            Response .................................................................................................................................... 73

9                       MODULE FITNESS (VANAF RCX 5.0.5) ..................................................................................74

    9.1                 BEKNOPT OVERZICHT ........................................................................................................................ 74
    9.2                 FINDPERSONCARDS......................................................................................................................... 74
      9.2.1             Request ....................................................................................................................................... 74
      9.2.2             Response .................................................................................................................................... 75
    9.3                 FINDSUBSCRIPTIONS ......................................................................................................................... 76
      9.3.1             Request ....................................................................................................................................... 76
      9.3.2             Response .................................................................................................................................... 77
    9.4                 GETFITNESSNONMEMBERPERSON ..................................................................................................... 77
      9.4.1             Request ....................................................................................................................................... 77
      9.4.2             Response .................................................................................................................................... 77
    9.5                 FINDFITNESS ACTIVITIES ...................................................................................................................... 77     7
      9.5.1             Request ....................................................................................................................................... 77
      9.5.2             Response .................................................................................................................................... 79
    9.6                 FINDFITNESS ACTIVITYRESERVATIONS ................................................................................................... 80
      9.6.1             Request ....................................................................................................................................... 80
      9.6.2             Response .................................................................................................................................... 82
    9.7                 CONFIRMFITNESS ACTIVITYRESERVATION ............................................................................................. 83
      9.7.1             Request ....................................................................................................................................... 83
      9.7.2             Response .................................................................................................................................... 83
    9.8                 CANCELFITNESSACTIVITYRESERVATION .............................................................................................. 84
      9.8.1             Request ....................................................................................................................................... 84
      9.8.2             Response .................................................................................................................................... 84
    9.9                 GETFITNESS ACTIVITY ........................................................................................................................ 84
      9.9.1             Request ....................................................................................................................................... 84
      9.9.2             Response .................................................................................................................................... 84
    9.10                GETFITNESS ACTIVITYRESERVATION ..................................................................................................... 85
      9.10.1            Request ....................................................................................................................................... 85
      9.10.2            Response .................................................................................................................................... 85

10                      MODULE EXPOSITIES .............................................................................................................86

    10.1                BEKNOPT OVERZICHT ........................................................................................................................ 86
    10.2                LISTEXPOSITIONTYPES ........................................................................................................................ 86
      10.2.1            Request ....................................................................................................................................... 86
      10.2.2            Response .................................................................................................................................... 86
           10.2.2.1     ExpositionType ........................................................................................................................... 86
    10.3                FINDEXPOSITIONS ............................................................................................................................. 86
      10.3.1            Request ....................................................................................................................................... 86


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
          10.3.1.1      ExpositionSearchCriteria .......................................................................................................... 86
          10.3.1.2      ExpositionIncludes ..................................................................................................................... 87
      10.3.2            Response .................................................................................................................................... 87
          10.3.2.1      Exposition .................................................................................................................................... 87
          10.3.2.2      ExpositionPeriod ........................................................................................................................ 88
          10.3.2.3      ExpositionPrice ........................................................................................................................... 89
          10.3.2.4      PriceGroup ................................................................................................................................. 89
   10.4                 LISTEXPOSITIONPERIODS ................................................................................................................... 90
      10.4.1            Request ....................................................................................................................................... 90
          10.4.1.1      ExpositionPeriodSearchCriteria .............................................................................................. 90
      10.4.2            Response .................................................................................................................................... 90
   10.5                 LISTAUDIENCES ................................................................................................................................ 90
      10.5.1            Request ....................................................................................................................................... 90
      10.5.2            Response .................................................................................................................................... 90     8

   10.6                 FINDORGANISEDVISITS ..................................................................................................................... 91
      10.6.1            Request ....................................................................................................................................... 91
          10.6.1.1      FindOrganisedVisitsRequest .................................................................................................... 91
          10.6.1.2      OrganisedVisitIncludes ............................................................................................................. 91
      10.6.2            Response .................................................................................................................................... 92
          10.6.2.1      OrganisedVisit ............................................................................................................................ 92
          10.6.2.2      OrganisedVisitPriceGroupPeriodReservation ...................................................................... 92
          10.6.2.3      OrganisedVisitArticlePeriodReservation................................................................................ 93
          10.6.2.4      OrganisedVisitArticle ................................................................................................................ 93

11                      MODULE TICKETING ..............................................................................................................95

   11.1                 BEKNOPT OVERZICHT ........................................................................................................................ 95
   11.2                 LISTCULTUREACTIVITIES ..................................................................................................................... 95
      11.2.1            Request ....................................................................................................................................... 95
      11.2.2            Response .................................................................................................................................... 95
          11.2.2.1      CultureActivity ........................................................................................................................... 95
   11.3                 FINDCULTUREEVENTS........................................................................................................................ 95
      11.3.1            Request ....................................................................................................................................... 95
          11.3.1.1      CultureEventSearchCriteria..................................................................................................... 95
          11.3.1.2      CultureEventIncludes ............................................................................................................... 96
      11.3.2            Response .................................................................................................................................... 96
          11.3.2.1      CultureEvent .............................................................................................................................. 96
          11.3.2.2      CultureEventPrice ..................................................................................................................... 97
   11.4                 LISTCULTUREEVENTOPTIONS .............................................................................................................. 98
      11.4.1            Request ....................................................................................................................................... 98
      11.4.2            Response .................................................................................................................................... 98


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
   11.5                 GETHALLSEATING ............................................................................................................................ 99
      11.5.1            Request ....................................................................................................................................... 100
      11.5.2            Response .................................................................................................................................... 100
   11.6                 GETCULTUREEVENTSEATING.............................................................................................................. 100
      11.6.1            Request ....................................................................................................................................... 100
      11.6.2            Response .................................................................................................................................... 100
   11.7                 GETSEAT ALLOCATIONS .................................................................................................................... 101
      11.7.1            Request ....................................................................................................................................... 101
      11.7.2            Response .................................................................................................................................... 101

12                      MODULE ZAALRESERVERINGEN............................................................................................103

   12.1                 BEKNOPT OVERZICHT ........................................................................................................................ 103
   12.2                 FINDRESERVATIONACTIVITIES ............................................................................................................. 103
      12.2.1            Request ....................................................................................................................................... 103     9
          12.2.1.1      ReservationActivityIncludes .................................................................................................... 103
      12.2.2            Response .................................................................................................................................... 103
   12.3                 FINDINFRASTRUCTURES ...................................................................................................................... 104
      12.3.1            Request ....................................................................................................................................... 104
          12.3.1.1      InfrastructureIncludes ............................................................................................................... 105
      12.3.2            Response .................................................................................................................................... 105
          12.3.2.1      Address ....................................................................................................................................... 105
          12.3.2.2      Place ........................................................................................................................................... 106
          12.3.2.3      Division ........................................................................................................................................ 106
          12.3.2.4      Credentials ................................................................................................................................. 107
   12.4                 FINDINFRASTRUCTUREOPENINGS ........................................................................................................ 107
      12.4.1            Request ....................................................................................................................................... 107
          12.4.1.1      InfrastructureOpeningsSearchCriteria................................................................................... 107
      12.4.2            Response .................................................................................................................................... 108
          12.4.2.1      InfrastructureOpenings ............................................................................................................ 108
          12.4.2.2      InfrastructureOpeningHours .................................................................................................... 108
          12.4.2.3      OpeningHour ............................................................................................................................. 108
   12.5                 FINDPLACES .................................................................................................................................... 108
      12.5.1            Request ....................................................................................................................................... 108
          12.5.1.1      PlaceIncludes ............................................................................................................................ 109
      12.5.2            Response .................................................................................................................................... 110
          12.5.2.1      Infrastructure .............................................................................................................................. 110
          12.5.2.2      ReservationActivity ................................................................................................................... 111
   12.6                 FINDRESERVATIONS .......................................................................................................................... 111
      12.6.1            Request ....................................................................................................................................... 111
          12.6.1.1      ReservationIncludes ................................................................................................................. 112


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
      12.6.2            Response .................................................................................................................................... 113
          12.6.2.1      Place ........................................................................................................................................... 114
          12.6.2.2      Infrastructure .............................................................................................................................. 115
          12.6.2.3      ReservationActivity ................................................................................................................... 115
          12.6.2.4      Person .......................................................................................................................................... 116
          12.6.2.5      PersonName .............................................................................................................................. 117
          12.6.2.6      Address ....................................................................................................................................... 117
          12.6.2.7      Relation ....................................................................................................................................... 118
   12.7                 FINDCOUNTIES ................................................................................................................................ 118
      12.7.1            Request ....................................................................................................................................... 118
      12.7.2            Response .................................................................................................................................... 118
   12.8                 CANCELRESERVATION ...................................................................................................................... 119
      12.8.1            Request ....................................................................................................................................... 119
      12.8.2            Response .................................................................................................................................... 119       10

13                      MODULE BUSVERVOER .........................................................................................................120

   13.1                 BEKNOPT OVERZICHT ........................................................................................................................ 120
   13.2                 LISTCOUNTRIES ................................................................................................................................ 120
      13.2.1            Request ....................................................................................................................................... 121
          13.2.1.1      Includes....................................................................................................................................... 121
      13.2.2            Response .................................................................................................................................... 121
   13.3                 LISTZIPCODES .................................................................................................................................. 121
      13.3.1            Request ....................................................................................................................................... 121
          13.3.1.1      Includes....................................................................................................................................... 122
      13.3.2            Response .................................................................................................................................... 122
          13.3.2.1      Country ....................................................................................................................................... 122
   13.4                 LISTZIPCODESTREETS ......................................................................................................................... 122
      13.4.1            Request ....................................................................................................................................... 122
      13.4.2            Response .................................................................................................................................... 123
          13.4.2.1      Zipcode....................................................................................................................................... 123
   13.5                 LISTZIPCODECENDRISSTREETS ............................................................................................................ 123
      13.5.1            Request ....................................................................................................................................... 123
      13.5.2            Response .................................................................................................................................... 124
   13.6                 GETBUSTRIPREQUEST ........................................................................................................................ 124
      13.6.1            Request ....................................................................................................................................... 125
      13.6.2            Response .................................................................................................................................... 125
          13.6.2.1      Person .......................................................................................................................................... 126
          13.6.2.2      Contact ...................................................................................................................................... 126
          13.6.2.3      Address ....................................................................................................................................... 126
          13.6.2.4      BustripStates ............................................................................................................................... 126


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
   13.7                 LISTBUSTRIPREQUESTS ....................................................................................................................... 126
      13.7.1            Request ....................................................................................................................................... 126
          13.7.1.1      BusTripIncludes ........................................................................................................................... 127
      13.7.2            Response .................................................................................................................................... 127
          13.7.2.1      BusTripRequest ........................................................................................................................... 128
   13.8                 GETBUSTRIPSERIEREQUEST ............................................................................................................... 128
      13.8.1            Request ....................................................................................................................................... 128
      13.8.2            Response .................................................................................................................................... 128
          13.8.2.1      WeekDayRange ........................................................................................................................ 129
          13.8.2.2      SerieMonthPattern .................................................................................................................... 129
          13.8.2.3      SerieYearPattern ....................................................................................................................... 129
          13.8.2.4      SerieFrequency.......................................................................................................................... 129
          13.8.2.5      WeekDays .................................................................................................................................. 130
          13.8.2.6      FrequencyTypes ........................................................................................................................ 130           11

          13.8.2.7      BusTripRequest ........................................................................................................................... 130
   13.9                 SAVEBUSTRIPREQUEST ...................................................................................................................... 130
      13.9.1            Request ....................................................................................................................................... 130
      13.9.2            Response .................................................................................................................................... 130
          13.9.2.1      BusTripCompositeValidationResult ......................................................................................... 131
          13.9.2.2      BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 131
          13.9.2.3      BusTripRequest ........................................................................................................................... 131
   13.10                SAVEBUSTRIPSERIEREQUEST ............................................................................................................. 131
      13.10.1           Request ....................................................................................................................................... 131
      13.10.2           Response .................................................................................................................................... 132
          13.10.2.1     BusTripCompositeValidationResult ......................................................................................... 132
          13.10.2.2     BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 132
          13.10.2.3     BusTripSerieRequest .................................................................................................................. 132
   13.11                CANCELBUSTRIP .............................................................................................................................. 132
      13.11.1           Request ....................................................................................................................................... 133
      13.11.2           Response .................................................................................................................................... 133
          13.11.2.1     BusTripCompositeValidationResult ......................................................................................... 133
          13.11.2.2     BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 133
          13.11.2.3     BusTripRequest ........................................................................................................................... 133
   13.12                CANCELBUSTRIPSERIE ...................................................................................................................... 134
      13.12.1           Request ....................................................................................................................................... 134
      13.12.2           Response .................................................................................................................................... 134
          13.12.2.1     BusTripSerieCompositeValidationResult ................................................................................ 134
          13.12.2.2     BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 134
          13.12.2.3     BusTripSerieRequest .................................................................................................................. 135



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
   13.13                DELETEBUSTRIP ................................................................................................................................ 135
      13.13.1           Request ....................................................................................................................................... 135
      13.13.2           Response .................................................................................................................................... 135
          13.13.2.1     BusTripCompositeValidationResult ......................................................................................... 135
          13.13.2.2     BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 135
          13.13.2.3     BusTripRequest ........................................................................................................................... 136
   13.14                DELETEBUSTRIPSERIE ......................................................................................................................... 136
      13.14.1           Request ....................................................................................................................................... 136
      13.14.2           Response .................................................................................................................................... 136
          13.14.2.1     BusTripSerieCompositeValidationResult ................................................................................ 136
          13.14.2.2     BusTripValidationResult (=afgeleid van ValidationResult) ................................................. 137
          13.14.2.3     BusTripSerieRequest .................................................................................................................. 137

14                      WERKNEMERS ........................................................................................................................138
                                                                                                                                                                                  12
   14.1                 BEKNOPT OVERZICHT ........................................................................................................................ 138
   14.2                 FINDEMPLOYEES .............................................................................................................................. 138
      14.2.1            Request ....................................................................................................................................... 138
          14.2.1.1      EmployeeIncludes .................................................................................................................... 139
      14.2.2            Response .................................................................................................................................... 139
      14.2.3            Department ............................................................................................................................... 140
      14.2.4            Function ...................................................................................................................................... 140
   14.3                 AUTHENTICATEEMPLOYEE.................................................................................................................. 140
      14.3.1            Request ....................................................................................................................................... 140
      14.3.2            Response .................................................................................................................................... 140

15                      AANKOOP MODULE .............................................................................................................142

   15.1                 INLEIDING........................................................................................................................................ 142
   15.2                 FINDVENDORS................................................................................................................................. 143
      15.2.1            Request ....................................................................................................................................... 143
          15.2.1.1      VendorIncludes ......................................................................................................................... 144
      15.2.2            Response .................................................................................................................................... 144
          15.2.2.1      VendorState ............................................................................................................................... 146
          15.2.2.2      VendorGroup ............................................................................................................................ 146
          15.2.2.3      VatRegime ................................................................................................................................. 147
          15.2.2.4      Vat ............................................................................................................................................... 147
          15.2.2.5      VendorContact ......................................................................................................................... 147
   15.3                 FINDVENDORSGROUPS .................................................................................................................... 149
      15.3.1            Request ....................................................................................................................................... 149
      15.3.2            Response .................................................................................................................................... 149
   15.4                 FINDPURCHASEARTICLES .................................................................................................................. 150


Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
      15.4.1            Request ....................................................................................................................................... 150
          15.4.1.1      PurchaseArticleIncludes .......................................................................................................... 151
      15.4.2            Response .................................................................................................................................... 151
          15.4.2.1      VendorArticle............................................................................................................................. 153
          15.4.2.2      ArticleUnit ................................................................................................................................... 153
   15.5                 FINDSTOCKLOCATIONS .................................................................................................................... 154
      15.5.1            Request ....................................................................................................................................... 154
      15.5.2            Response .................................................................................................................................... 154
   15.6                 FINDPURCHASEORDERS ................................................................................................................... 155
      15.6.1            Request ....................................................................................................................................... 155
      15.6.2            Response .................................................................................................................................... 155
          15.6.2.1      PurchaseOrderRequest............................................................................................................ 155
          15.6.2.2      PurchaseOrder .......................................................................................................................... 156
          15.6.2.3      PurchaseLineRequest ............................................................................................................... 157               13

          15.6.2.4      PurchaseLine.............................................................................................................................. 158
   15.7                 VALIDATEPURCHASEORDER .............................................................................................................. 159
      15.7.1            Request ....................................................................................................................................... 159
      15.7.2            Response .................................................................................................................................... 159
   15.8                 VALIDATEPURCHASELINE .................................................................................................................. 160
      15.8.1            Request ....................................................................................................................................... 160
      15.8.2            Response .................................................................................................................................... 160
   15.9                 SAVEPURCHASEORDER .................................................................................................................... 161
      15.9.1            Request ....................................................................................................................................... 161
      15.9.2            Response .................................................................................................................................... 161
   15.10                DELETEPURCHASEORDER.................................................................................................................. 162
      15.10.1           Request ....................................................................................................................................... 162
      15.10.2           Response .................................................................................................................................... 162
   15.11                SAVEPURCHASELINE ........................................................................................................................ 163
      15.11.1           Request ....................................................................................................................................... 163
      15.11.2           Response .................................................................................................................................... 163
   15.12                DELETEPURCHASELINE ...................................................................................................................... 164
      15.12.1           Request ....................................................................................................................................... 164
      15.12.2           Response .................................................................................................................................... 164

16                      MODULE VERHUUR(VANAF RCX 5.0.5) ................................................................................165

   16.1                 BEKNOPT OVERZICHT ........................................................................................................................ 165
   16.2                 FINDRENTAL ARTICLES ....................................................................................................................... 165
      16.2.1            Request ....................................................................................................................................... 165
      16.2.2            Response .................................................................................................................................... 167
   16.3                 FINDRENTALORDERS ........................................................................................................................ 168


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
      16.3.1            Request ....................................................................................................................................... 168
      16.3.2            Response .................................................................................................................................... 170
   16.4                 GETRENTALORDER .......................................................................................................................... 171
      16.4.1            Request ....................................................................................................................................... 171
      16.4.2            Response .................................................................................................................................... 172
   16.5                 CANCELRENTALORDER .................................................................................................................... 172
      16.5.1            Request ....................................................................................................................................... 172
      16.5.2            Response .................................................................................................................................... 172

17                      MODULE INSCHRIJVINGEN (VANAF RCX 5.0.5) .................................................................174

   17.1                 BEKNOPT OVERZICHT ........................................................................................................................ 174
   17.2                 LISTACTIVITYTYPES ............................................................................................................................ 174
      17.2.1            Request ....................................................................................................................................... 174
      17.2.2            Response .................................................................................................................................... 174       14
   17.3                 FIND ACTIVITIES ................................................................................................................................ 174
      17.3.1            Request ....................................................................................................................................... 174
          17.3.1.1      ActivitySearchCriteria............................................................................................................... 175
          17.3.1.2      ActivityIncludes ......................................................................................................................... 175
      17.3.2            Response .................................................................................................................................... 175
          17.3.2.1      Period .......................................................................................................................................... 176
          17.3.2.2      ActivityPart ................................................................................................................................. 176
          17.3.2.3      ActivityOption ............................................................................................................................ 176
          17.3.2.4      AgeCategory ............................................................................................................................ 176
   17.4                 FINDPRICEGROUP ACTIVITYBY ACTIVITY .............................................................................................. 177
      17.4.1            Request ....................................................................................................................................... 177
          17.4.1.1      ActivitySearchCriteria............................................................................................................... 177
      17.4.2            Response .................................................................................................................................... 177
   17.5                 FINDENTRYOVERVIEW ...................................................................................................................... 178
      17.5.1            Request ....................................................................................................................................... 178
          17.5.1.1      EntrySearchCriteria ................................................................................................................... 178
      17.5.2            Response .................................................................................................................................... 178
   17.6                 CANCELENTRY ................................................................................................................................ 178
      17.6.1            Request ....................................................................................................................................... 179
      17.6.2            Response .................................................................................................................................... 179

18                      MODULE BKO (VANAF RCX 5.1.0) .......................................................................................180

   18.1                 BEKNOPT OVERZICHT ........................................................................................................................ 180
   18.2                 AUTHENTICATECHILDCARECENTRE .................................................................................................... 180
      18.2.1            Request ....................................................................................................................................... 180
      18.2.2            Response .................................................................................................................................... 180


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
   18.3                 FINDCHILDCARECENTRES ................................................................................................................ 181
      18.3.1            Request ....................................................................................................................................... 181
          18.3.1.1      ChildCareCentreIncludes ....................................................................................................... 182
      18.3.2            Response .................................................................................................................................... 182
   18.4                 FINDCHILDCARECENTREPERIODS ..................................................................................................... 182
      18.4.1            Request ....................................................................................................................................... 182
      18.4.2            Response .................................................................................................................................... 183
   18.5                 FINDCHILDCARECENTREENTRIES ....................................................................................................... 183
      18.5.1            Request ....................................................................................................................................... 183
          18.5.1.1      ChildCareCentreEntryIncludes ............................................................................................... 184
      18.5.2            Response .................................................................................................................................... 184
   18.6                 FINDCHILDCARECENTREPRESENCES.................................................................................................. 184
      18.6.1            Request ....................................................................................................................................... 184
      18.6.2            Response .................................................................................................................................... 185       15

   18.7                 SAVECHILDCARECENTREPRESENCE .................................................................................................. 185
      18.7.1            Request ....................................................................................................................................... 185
      18.7.2            Response .................................................................................................................................... 185
          18.7.2.1      ValidationResult......................................................................................................................... 186
   18.8                 DELETECHILDCAREPRESENCE ........................................................................................................... 186
      18.8.1            Request ....................................................................................................................................... 186
      18.8.2            Response .................................................................................................................................... 186

19                      OPHALEN VAN AFBEELDINGEN VIA WEBSERVICES.............................................................187

   19.1                 EEN VOORBEELD: ............................................................................................................................. 187

20                      OPHALEN VAN DOCUMENTEN VIA WEBSERVICES..............................................................188

   20.1                 ALGEMEEN ..................................................................................................................................... 188
   20.2                 CULTUREEVENT TICKETS .................................................................................................................... 189
   20.3                 ETICKETS VAN EXPOSITIES .................................................................................................................. 190
   20.4                 TICKETS VAN INSCHRIJVINGEN ........................................................................................................... 190
   20.5                 FITNESS TICKETS ................................................................................................................................ 193
   20.6                 TICKETS VOOR VERHUUR BESTELLINGEN ............................................................................................... 194

21                      OPMERKINGEN .....................................................................................................................196

22                      VOORBEELDEN ......................................................................................................................197

   22.1                 BIJHOUDEN VAN BASKET ITEMS ........................................................................................................... 197
      22.1.1            Helper classes ............................................................................................................................ 197
      22.1.2            Statebag..................................................................................................................................... 198
   22.2                 CREATIE CONTEXT ITEM ..................................................................................................................... 199
   22.3                 EXPOSITIES....................................................................................................................................... 200


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
      22.3.1            Ophalen van de klanten ......................................................................................................... 200
      22.3.2            Ophalen van exposities, periodes en prijzen ....................................................................... 200
      22.3.3            Reserveringsobject aanmaken .............................................................................................. 201
      22.3.4            Reservering toevoegen aan winkelmandje ........................................................................ 201
      22.3.5            Tijdelijke reservering aanmaken in de database ................................................................ 202
      22.3.6            Prijs van het winkelmandje herberekenen ........................................................................... 203
      22.3.7            Betalingen aanmaken ............................................................................................................. 203
      22.3.8            Validatie ..................................................................................................................................... 204
      22.3.9            Boeken ........................................................................................................................................ 204
      22.3.10           Ophalen van ETickets ............................................................................................................... 205




                                                                                                                                                                              16




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
1        Historiek
          Frederic – 31/10/2011: v1.0.1
                       Toevoeging verplichte velden
          Frederic – 12/01/2012: v1.1.0
                       Bijgewerkt met WSDL 1.1 versie
          Frederic – 23/01/2012: v1.2.0
          Jannick – 13/02/2012: v1.3.0
          Frederic – 2012-05-30: v1.5.0
                       Aanpassing CultureEventPrice
          Patrick : 15/03/2012: v2.0.0
          Patrick : 12/06/2012: v2.0.0
                       Busvervoer module toegevoegd
          Dieter : 08/10/2012: v2.1.0                                  17

                       BKO module toegevoegd
          Jannick : 22/10/2012: v2.1.0
                       CultureEventWaitingListReservation toegevoegd




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
2       Inleiding
De ReCreateX Web Shop Web Services laten ontwikkelaars toe om een eigen web shop te creëren
bovenop een bestaand ReCreateX systeem. De web services abstraheren de ReCreateX domeinlogica
en database toegang in een simpele interface.


De web services laten je toe een basket (winkelmandje) te vullen om uiteindelijk een check-out
(verkoop) te doen.


De web services zijn geïmplementeerd als SOAP Web Services om interoperabiliteit toe te laten.
Sommige web service operaties zijn ook als REST Web Services geïmplementeerd om bepaalde
overhead te vermijden (vb. toegang tot binaire gegevens zoals afbeeldingen).
Dit document bevat geen diepe details over de web services, enkel de algemene principes.
Voor meer details verwijzen we naar de gepaste documenten.                                       18




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
3         Algemene Principes
3.1       DE SERVICE CONTEXT
Alle requests naar de web service bevatten een service context. De service context bepaalt de
context waaronder de web services hun werk zullen doen.
Aangezien de web services kunnen worden geconfigureerd voor meerdere ReCreateX systemen
(databases), kan het noodzakelijk zijn om te vermelden welk systeem je wilt aanspreken.
Indien de web services maar in de context van één ReCreateX systeem draaien, is de context niet
relevant.
Op dit moment bestaat de request uit de volgende eigenschappen :
          ShopId : Indien deze niet is ingevuld, dan zal de ShopID worden gebruikt die is opgegeven in de
           webservice configuratie file.
          DivisionId
          Language (ISO639-1) (Indien deze niet is ingevuld zal de standaard taal gebruikt worden (NL))      19

          SessionId: Bij het gebruiken van de basket functionaliteit dient de SessionId opgevuld te worden
           met een unieke GUID per winkelmandje! Indien twee verschillende gebruikers simultaan werken
           op dezelfde web site, is het noodzakelijk om te weten welke requests er bij welk winkelmandje
           horen.


3.2       HET GEBRUIK VAN DE DOMAINOBJECTEN
De web service operaties werken altijd met domainobjecten (onderliggend meestal als XML
gerepresenteerd). Zo een domeinobject, kan veel nuttige informatie bevatten wanneer het wordt
teruggestuurd naar de cliënt in een response. Doch, wanneer een domeinobject in de request wordt
doorgestuurd als referentie, is de meeste informatie hierin niet relevant en is het voldoende de
identificatie van het object (ID eigenschap/property) in te vullen.
vb. Wanneer je alle artikelcategorieën opvraagt krijg je in elk categorieobject een ID, naam,
beschrijving en optioneel een afbeelding terug (allemaal nuttige informatie). Doch wanneer je wilt
zoeken naar artikelen in een bepaalde artikelcategorie is het voldoende om enkel de ID van die groep
in te vullen in het object.


3.3       DE BASKET OPERATIES
De basket bevat alle dingen die een web shop klant wil kopen (huren, reserveren, ..). Een ding dat kan
worden toegevoegd aan de basket wordt een basket-item genoemd. Afhankelijk van de ReCreateX
modules die je wil/kan gebruiken, zijn er verschillende soorten basket-items:
          De aankoop van een artikel
          De verhuur van een artikel
          De inschrijving op een activiteit
          …




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Uiteindelijk komt het er op neer de basket te vullen met basket-items om een uiteindelijke verkoop te
doen (check-out).


De inhoud van de basket is de verantwoordelijkheid van de gebruikers (clients) van de web service.
Enkel na check-out wordt de basket een verkoop.


3.3.1      Check-out
Dit is de enige operatie die echt noodzakelijk is om een verkoop te doen.
De basket wordt eerst gevalideerd en indien er geen validatiefouten zijn, wordt de verkoop verwerkt.
Indien er echter wel validatiefouten optreden, moeten die eerst worden opgelost waarna de check-
out operatie opnieuw moet worden aangeroepen.


3.3.2      Validatie
Niet alle baskets kunnen worden verkocht. Bepaalde domainregels (rules) kunnen er toe leiden dat de        20
verkoop van de basket niet kan doorgaan.
De validatie van de basket bestaat uit twee delen:
          Validatie van alle basket-items
           vb. het maximaal aankoopaantal is overschreden
          Validatie op het niveau van de basket in zijn geheel
           vb. het maximaal verkoopbedrag is overschreden


Het resultaat van een validatie (op de gehele basket of op een individueel basket-item) omvat twee
eigenschappen:
          De naam van de domain/business regel die werd geschonden
          Een tekst die aangeeft waarover het gaat
Praktisch zal het erop neer komen dat je de tekst weergeeft aan de gebruiker, zodat hij de nodige
stappen kan ondernemen. (vb. het basket-item verwijderen uit de basket).
Indien dit onvoldoende is (voor de clients van de web service), kan je aan de hand van de naam van
de regel andere acties ondernemen. (momenteel is er geen lijst van regels beschikbaar)


Validatie van basket items is een optionele stap die het mogelijk maakt om al feedback te geven naar
de koper voordat hij de basket volledig uitcheckt.
Per basket-item krijg je maximaal één gebroken regel terug, het is best mogelijk dat na het oplossen van
een gebroken regel er een nieuwe gebroken regel wordt teruggegeven na validatie.


3.3.3      Lock en Unlock van basket-items
In veel gevallen willen we op een basket-item al een verkoopoptie nemen voordat we een check-out
van de basket doen. Laten we dit wat verduidelijken aan de hand van een voorbeeld waar we een
artikel kopen (en we een stock bijhouden van die artikels). We willen voorkomen dat de koper pas bij
check-out verneemt dat het artikel niet meer beschikbaar is (hoewel er op het moment dat hij zijn


Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
artikel toevoegde aan de basket nog voldoende stock was). Om dit te voorkomen is het mogelijk om
een artikel (of ander basket-item) te vergrendelen voor een bepaalde tijd. In het geval van een artikel
wordt de stock tijdelijk verminderd.


De lock-operatie geeft voor ieder Basket Item een lock-ticket terug. Dit ticket is een bewijs dat een
basket-item werd gelokt.
De lock heeft een vervaltijd. De vervaltijd zorgt ervoor dat het lock-systeem schaalbaar blijft.
De lock-tickets moeten bij check-out worden meegeleverd in de basket. Indien een lock al is vervallen,
wordt het basket-item verwerkt alsof hij geen lock had.


De unlock-operatie is een optionele operatie die je toelaat om een lock vroeger vrij te geven.
Locks worden altijd automatisch vrijgegeven na de vervaltijd. Maar, indien mogelijk is het altijd beter
om een onnodige lock zo vroeg mogelijk weer vrij te geven.
                                                                                                          21

3.4       HET AANMAKEN VAN BASKET-ITEMS
Het aanmaken van basket-items is de verantwoordelijkheid van de client van de web services.
Doch, om een basket item te kunnen aanmaken zijn bepaalde start-gegevens noodzakelijk (afhankelijk
van de soort basket-item).


Uiteindelijk zijn er twee manieren om aan de nodige informatie te geraken:
          Bladeren (Browse)
          Zoeken (Search)
De web services geven je voldoende operaties om beide methodes toe te laten. Globaal gezien komt
dit neer op:
          Opvragen van lijsten van categorieën/types/… die kunnen worden gebruikt als zoek criteria
          Het zoeken van items aan de hand van een zoekcriteria
           Pagineren (paging) wordt steeds ondersteund wanneer grote resultaatlijsten mogelijk zijn.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
4       Algemene webservices
In onderstaande tekst zal van elke web service operatie in detail besproken worden hoe deze moet
aangesproken worden.


4.1     XXXSPECIFIEDFIELD
Als er gebruik gemaakt wordt van een DotNet client om de webservices aan te spreken, dan is het
belangrijk om bij het aanroepobject de eventuele velden xxxSpecifiedField ook in te vullen waar de
bijhorende velden (de xxx) gebruikt worden.
Zonder deze boolean op “True” te zetten, zal de waarde van het eigenlijke veld niet gebruikt worden.
Dit heeft te maken met de manier waarop DotNet het request serializeerd en nullable types.
Dit hoeft niet te gebeuren vanuit een andere programmeertaal of omgeving (Java – PHP – etc.)


4.2     PAGING CRITERIA                                                                                22
Dit is een standaard object die zal gebruikt worden om paginering op web pagina’s toe te laten.
Het object is opgebouwd als volgt.
Naam                        Type                    Omschrijving             Opmerkingen

PageIndex                   Integer                 Het paginanummer         Default = 1
                                                    waarop men zich
                                                    bevindt.
PageSize                    Integer                 Het aantal items dat     Default = 10
                                                    moet weergegeven
                                                    worden.
Sorting                     SortingCriteria         De manier waarop de
                                                    resultaten zullen
                                                    gesorteerd worden.


4.3     SORTING CRITERIA
Naam                        Type                    Omschrijving             Opmerkingen

PropertyName                String                  De naam van de           Verplicht in te vullen.
                                                    property waarop
                                                    gesorteerd moet
                                                    worden.
IsAscending                 Boolean                 True indien oplopend     Default = false
                                                    sorteren, false indien
                                                    aflopend.




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
5         Articles
5.1       FINDARTICLES
Het aanroepen van deze web service operatie zal aan de hand van de bijhorende parameters de
gevraagde Articles weergeven.


5.1.1      Request
De FindArticlesRequest bestaat uit de service context en uit een ArticleSearchCriteria object. Dit laatste
zal bepalen welke Articles er zullen terug gevonden worden.


5.1.1.1      ArticleSearchCriteria
Naam                     Type                  Omschrijving                               Opmerkingen

ArticleID                Guid                  Indien ingevuld : Enkel het artikel
                                               ophalen met deze ID.                                                  23

ArticleGroupId           Guid                  Indien ingevuld: Enkel artikelen uit de    Default = leeg
                                               ArticleGroup met het bijgeleverde id       (artikelen uit alle
                                               worden teruggegeven.                       groepen).
NamePattern              String                Indien ingevuld : Enkel artikelen waarin   Default = leeg
                                               een het naam patroon voorkomt              (geen
                                               worden teruggegeven.                       naambeperking).
BuyerId                  Guid                  Indien ingevuld: Enkel artikelen die       Nog niet in gebruik
                                               relevant zijn voor de bepaalde koper       Geeft de mogelijkheid
                                               worden getoond.                            om artikelen te filteren
                                                                                          op vb: leeftijd
                                                                                          (alcoholische dranken).
ArticleTypes             ArticleTypes          Enumeratie van artikelTypes.               Wanneer je
                                               Volgende waarden zijn mogelijk :           bijvoorbeeld enkel de
                                                         Sale                            geldbeugelartikelen
                                                         Rental                          wenst op te halen,
                                                         All                             plaats je deze op None
                                                         None                            en zet je de
                                                                                          ChipKnipArticles onder
                                                                                          de Includes op true.
IncludeDetail            Boolean               Indien true dan worden ook de opties,
                                               ingredienten en voorraadlocaties
                                               opgehaald.
                                               (Zie 5.1.2 Response)
Includes                 ArticleIncludes       Dit object zal bepalen welke
                                               eigenschappen er van de artiklen zullen



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
                                               worden opgehaald.
                                               (zie 5.1.1.2 : ArticleIncludes)
Paging                  PagingCriteria         Zie 4.2 Paging Criteria
StockLocationId         Guid                   Indien niet ingevuld, wordt de totale
                                               voorraad berekend per artikel over alle
                                               voorraadlocaties heen.
                                               Indien ingevuld, wordt enkel de
                                               voorraad voor de opgegeven
                                               voorraadlocatie berekend.
ArticleCategoryId       Guid                   Alleen artikels van een bepaalde            Default = Leeg
                                               categorie worden opgehaald.                 (Artikels van alle
                                                                                           categorieën).

                                                                                                                24
5.1.1.2      ArticleIncludes
Dit object zal bepalen eigenschappen er van de Articles zullen worden opgehaald. Dit is wensbaar
omdat in bepaalde web pagina’s maar bepaalde eigenschappen moeten getoond worden terwijl in
andere gevallen uitgebreide informatie nodig is .
Naam                    Type                 Omschrijving                                  Opmerkingen

Price                   Boolean              Ophalen van prijs ja of neen.
ImageUrl                Boolean              Ophalen van de Image URL van het
                                             Article.
Image                   Boolean              Ophalen van de Image van het Article.
Group                   Boolean              Ophalen van de ArticleGroup van het
                                             Article.
FreeArticles            Boolean              Indien False dan worden Articles waarvan
                                             de prijs 0 is, niet opgehaald.
Ingrediënts             Boolean              Wordt niet meer gebruikt. Is vervangen
                                             door de ArticleSearchCriteria.IncludeDetail
Locations               Boolean              Wordt niet meer gebruikt. Is vervangen
                                             door de ArticleSearchCriteria.IncludeDetail
Options                 Boolean              Wordt niet meer gebruikt. Is vervangen
                                             door de ArticleSearchCriteria.IncludeDetail
SoldOutArticles         Boolean              Indien False, dan worden artikels waarvan
                                             de huidige voorraad 0 is, niet opgehaald.
RentArticles            Boolean              Indien False, dan worden verhuurartikels
                                             niet opgehaald.
SaleArticles            Boolean              Indien False, dan worden
                                             verkoopsartikelen niet opgehaald.



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Stock                     Boolean                  Wordt niet meer gebruikt. Is vervangen
                                                   door de ArticleSearchCriteria.IncludeDetail
ArticleCategories         Boolean                  Indien False, dan worden de categorieën
                                                   niet mee opgehaald.
ChipKnipArticles          Boolean                  Indien False, dan worden geldbeugel-
                                                   artikels niet opgehaald.


5.1.2      Response
De response is een lijst van Articles.
Naam                    Type                              Omschrijving                            Opmerkingen

Id                      Guid                              De Unieke identifier van het Article.
Code                    String                            De code van het Article.
Name                    String                            De naam van het Article.
                                                                                                                25
Description             String                            De omschrijving van het Article.
Price                   Decimal                           De verkoopprijs van het Article op
                                                          vandaag, zonder rekening te
                                                          houden met prijsgroepen.
Stock                   Decimal                           Het huidig aantal in voorraad.
                                                          Indien in de request een
                                                          vorraadlocatie is opgegeven, dan
                                                          bevat dit enkel het aantal voorradig
                                                          op de huidige voorraadlocatie.
                                                          Indien geen voorraadlocatie is
                                                          opgegeven, dan bevat dit het
                                                          totaal aantal artikels op voorraad,
                                                          over alle locaties heen.
Image                   Picture                           De afbeelding van het Article.
ImageUrl                string                            De link waarop een image terug te
                                                          vinden is van het ArticleGroup.
IsRental                Bool                              Geeft aan of het artikel een
                                                          verhuurartiel is of niet.
Group                   ArticleGroup                      De ArticleGroup waartoe het artikel
                                                          behoort.
IsStockItem             Bool                              Geeft aan of het artikel een
                                                          voorraadartikel is of niet.
DivisionId              Guid                              De financiële divisie waartoe het
                                                          artikel behoort. Verkopen van dit
                                                          artikel worden geboekt op deze



Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
                                                       divisie.
Ingredients             IList<ArticleIngredient>       De lijst van ingrediënten waaruit dit
                                                       artikel bestaat.
Options                 IList<ArticleOption>           De exclusieve opties waaruit kunnen
                                                       gekozen bij het verkopen van dit
                                                       artikel.
StockLocations          IList<StockLocation>           De voorraad locaties waar dit artikel
                                                       beschikbaar is.
Categories              IList<Category>                De lijst van categorieën waartoe dit
                                                       artikel behoort. De categorieën
                                                       kunnen een hierarchy delen
                                                       onderling.

                                                                                                                 26
5.2       LISTARTICLEGROUPS
Deze web service operatie geeft de mogelijkheid aan de gebruiker om de groepen van artikelen terug
te geven.


5.2.1      Request
De request bestaat de ServiceContext en de ArticleGroupSearchCriteria parameter. De Service
Context is hierboven reeds beschreven (zie 3.1: De Service Context).


5.2.1.1      ArticleGroupSearchCriteria
Deze parameter geeft aan wat er juist moet opgehaald worden.
Naam                               Type                  Omschrijving                          Opmerkingen

ArticleTypes                       ArticleTypes          Dit is een enumeratie bestaande uit   Default = Sale
                                                         volgende waarden:
                                                         - Sale = 0
                                                         - Rental = 1
                                                         - All = 2


IncludeImage                       Bool                  Bepaalt of de image moet mee          Default = false
                                                         opgehaald worden of niet.
IncludeImageUrl                    Bool                  Bepaalt of de link naar de image      Default = true
                                                         moet mee opgehaald worden of
                                                         niet .


5.2.2      Response
De response is een lijst van ArticleGroups. ArticleGroup bestaat uit de volgende velden.




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
5.2.2.1      ArticleGroup
Naam                 Type                  Omschrijving                                        Opmerkingen

Id                   Guid                  De Unieke identifier van de ArticleGroup.
Code                 String                De code van de ArticleGroup.
Name                 String                De naam van de ArticleGroup.
Description          String                De omschrijving van de ArticleGroup.
Image                Picture               De afbeelding van de ArticleGroup.
ImageUrl             string                De link waarop een image terug te vinden is
                                           van de ArticleGroup.


5.3       FINDARTICLECATEGORIES
Het aanroepen van deze web service operatie zal aan de hand van de bijhorende parameters de
gevraagde ArticleCategories weergeven.
                                                                                                                        27

5.3.1      Request
De FindArticlescategories bestaat uit de service context en uit een ArticleCategorySearchCriteria
object. Dit laatste zal bepalen welke ArticleCategories er zullen terug gevonden worden.


5.3.1.1      ArticleCategorySearchCriteria
Naam                          Type                  Omschrijving                                 Opmerkingen

ArticleCategoryId             Guid                  Indien ingevuld : Enkel de categorie
                                                    ophalen met deze ID.
NamePattern                   String                Indien ingevuld : Enkel artikelen waarin     Default = leeg
                                                    een het naam patroon voorkomt worden         (geen naambeperking)
                                                    teruggegeven.
Paging                        PagingCriteria        Zie 4.2 Paging Criteria


5.3.1      Response
De response is een lijst van ArticleCategorieën.
Naam                     Type                  Omschrijving                                    Opmerkingen

Id                       Guid                  De Unieke identifier van het Article.
ShortName                String                De code of verkorte naam van de
                                               categorie.
Description              String                De omschrijving van de categorie.
Level                    Int                   Het niveau binnen een hiërarchie.
ParentCategory           Guid                  Indien bestaand, de bovenliggende               Indien leeg dan is dit
                                               categorie in de hierarchie.                     het hoogste niveau.




Syx Automations BE                Syx Automations NL
Rozendaalstraat 53                Meesterstraat 2
8900 Ieper                        3861 RE Nijkerk
T. +32 (0)57 22 44 00             T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01             F. +31 (0)33 46 109 33
www.syx.be                        www.syx.nl
5.4       FINDPRICEGROUPS
5.4.1      Request
De request bestaat uit de Service Context en een PriceGroupSearchCriteria object
Naam                    Type                            Omschrijving                                          Opmerkingen

Id                      Guid                            Id van de specifieke prijsgroep.                      Nullable voor
                                                                                                              alle
                                                                                                              prijsgroepen.
Type                    PriceGroupType                  Type van de prijsgroep. Een prijsgroep is altijd      Nullable voor
                                                        van een bepaald type. Éen van deze types is           alle types.
                                                        “algemeen”. Dit type betekend dat de
                                                        prijsgroep overal actief is. Dit is van belang voor
                                                        deze PriceGroupType selectie omdat bij
                                                        selectie van bv prijsgroepen van het type
                                                                                                                              28
                                                        “Ticketing” er een lijst van prijsgroepen van het
                                                        type “algemeen” en “Ticketing” zal
                                                        geretourneerd worden.


5.4.2      Response
De response zal een lijst van prijsgroepen bevatten dat voldoet aan de criteria.


5.5       FINDARTICLESALESORDERS
Deze web service operatie geeft de mogelijkheid om een overzicht of historiek te krijgen van verkochte
artikelen. Dit wordt vooral gebruikt bij de visualisatie van ‘Mijn gekochte artikelen’.


5.5.1      Request
De request bestaat de ServiceContext en het ArticleSalesOrderSearchCriteria object.


5.5.1.1      ArticleSalesOrderSearchCriteria
Dit object geeft aan wat er juist moet opgehaald worden.
Naam                    Type                             Omschrijving                                 Opmerkingen

Id                      Guid?                            Unieke ID van de verkoop
PersonId                Guid?                            Unieke ID van de klant
From                    DateTime?                        Indien ingevuld: Enkel verkopen
                                                         ophalen die later werden geregistreerd
                                                         dan de opgegeven datum.
Until                   DateTime?                        Indien ingevuld: Enkel verkopen
                                                         ophalen die vroeger werden
                                                         geregistreerd dan de opgegeven
                                                         datum



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Type                    ArticleSalesOrderType            Enumeratie die bepaalt welk type            Zie 5.5.1.2
                                                         artikels worden opgehaald:
                                                                All (= alle types)
                                                                Sales (= verkoopsartikelen)
                                                                Warranty
                                                                WaitingList
                                                                Service
                                                                ChipKnip
                                                                LessonGroup
                                                                Purchase
                                                                PriceGroup
                                                                Credit
                                                                Rental
                                                                                                                           29
                                                                Subscription
                                                                PurchaseCredit
                                                                Family
                                                                GiftCertificate
                                                                ConsumptionCoupon
                                                                FollowUp
                                                                SpendingCredit
                                                                ETicket
Paging                  PagingCriteria                   Zie 4.2 Paging Criteria


5.5.2      Response
De response is een lijst van ArticleSalesOrder objecten. ArticleSalesOrder bestaat uit de volgende
velden.


5.5.2.1      ArticleGroup
Naam                      Type                           Omschrijving                                Opmerkingen

Id                        Guid                           De Unieke identifier van de verkoopslijn.
Description               String                         Omschrijving van de verkoopslijn.           Wordt meestal
                                                                                                     overgenomen
                                                                                                     vanuit het artikel
Date                      DateTime                       Registratiedatum van de verkoopslijn.
PersonId                  Guid                           Unieke ID van de persoon aan wie de
                                                         verkoop doorgevoerd werd.
Number                    Long                           Verkoopslijnnummer
SequenceNumber            Int                            Volgnummer van de verkoopslijn              Voor verkoopslijnen
                                                                                                     binnen eenzelfde


Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
                                                                                     verkoop
Quantity                Decimal                    Hoeveelheid verkochte artikelen
UnitPrice               Decimal                    Eenheidsprijs van het artikel
TotalPrice              Decimal                    Totaalprijs van de verkoopslijn




                                                                                               30




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
6         Basket (winkelmandje)
6.1       BEKNOPT OVERZICHT
INVULLEN


6.2       VALIDATEBASKET
Indien het winkelmandje op de client side is ingevuld, dan moet er een validatie gebeuren om te kijken
of we dit winkelmandje wel degelijk kunnen afhandelen. Hiervoor dient de validateBasket operatie.


6.2.1      Request
De request bestaat uit de service Context en het Basket object zelf.


6.2.1.1      Basket
Een basket is het geheel van Basket Items, betaalwijzes en een koper(indien deze al gekend is).                       31
Naam                    Type                    Omschrijving                                Opmerkingen

Items                   List<BasketItems>       Een lijst van items die zich in het         Zie ook verder.
                                                winkelmandje bevinden.
Price                   Decimal                 De totaalprijs van het winkelmandje.        Moet hetzelfde zijn als
                                                                                            het totaalbedrag van
                                                                                            de betalingen.
Payments                List<Payments>          Een lijst van betaalswijzen en bijhorend    Zie ook verder
                                                bedrag.                                     Er moet minimum 1
                                                                                            betaling aanwezig zijn
                                                                                            voor de validatie.
CustomerId              Guid                    Unieke identifier die gebruikt zal          Verplicht veld bij het
                                                worden om de koper te identificeren.        valideren.
                                                     Het Person Id van de
                                                          ingelogde gebruiker.
DeliveryAddressId       Guid                    Unieke identifier die gebruikt wordt        Niet verplicht op te
                                                voor het registreren van een                vullen.
                                                afleveradres.


6.2.1.2      BasketItem
Een basket Item is een item die zich in het winkelmandje bevindt. Echter is een basket item de
generieke term die gebruikt wordt voor de verschillende soorten zoals daar zijn ArticleSale,
ExpositionPeriodReservation, ActivityReservation, CultureEventReservation, WaitingListSale …


Naam                      Type               Omschrijving                             Opmerkingen

Id                        Guid               Unieke Identifier van het



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                  BasketItem.
Quantity                     Integer              Het aantal.
DivisionId                   Guid                 De divisie waar het item tot
                                                  behoort.
Name                         String               De omschrijving van het artikel.        Readonly
                                                                                          Wordt enkel ondersteund bij
                                                                                                 ActivityReservation
                                                                                                 ArticleSale
RuleNamesToIgnore            List<String>         De lijst van validatieregels die niet
                                                  moeten worden getest bij
                                                  valideren van het winkelmandje.
UnitPrice                    Decimal

                                                                                                                            32
6.2.1.2.1      ArticleSale
Een articleSale is een specifiek basketitem dat gebruikt wordt voor de verkoop van Articles.
Naam                    Type                     Omschrijving                                    Opmerkingen

Id                      Guid                     Unieke Identifier van het BasketItem
Quantity                Integer                  Het aantal.
DivisionId              Guid                     De divisie waar het item tot behoort.
Article                 Article                  Het Article dat verkocht wordt.                 Hiervan dient enkel de
                                                                                                 Id ingevuld te zijn.


6.2.1.2.2      ExpositionPeriodreservation
Een expositionPeriodReservation is een specifiek basketItem dat enkel gebruikt wordt voor de verkoop
van reserveringen van een specifieke expositie periode.
Naam                    Type                            Omschrijving                                    Opmerkingen

Id                      Guid                            Unieke Identifier van het BasketItem.
Quantity                Integer                         Het aantal.                                     Is niet bruikbaar
                                                                                                        in dit specifiek
                                                                                                        geval.
UnitPrice               Decimal                         De eenheidsprijs.                               Is niet bruikbaar
                                                                                                        in dit specifiek
                                                                                                        geval.
DivisionId              Guid                            De divisie waar het item tot behoort.
ExpositionPeriodI       Guid                            Het id van de Expositie Periode waarvoor
d                                                       men een reservatie wenst te maken.
Entries                 List                            Indien men wenst een reservatie te
                        <ExpositionPeriodRe             maken voor een expostiePeriode, kan



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                        servationEntry>                men zich inschrijven op basis van
                                                       verschillende prijzen. Dit object zal dit
                                                       mogelijk maken. (zie verder)
LockTicket              LockTicket                     Zie 3.3.3 : Lock en Unlock van basket-
                                                       items.


6.2.1.2.3      ExpositionPeriodReservationEntry
Dit object omvat een aantal en een bijhorende prijsgroep.
Naam                    Type                           Omschrijving                                Opmerkingen

ParticipantCount        Int                            Het aantal deelnemers voor een
                                                       bepaalde prijsgroep.
PriceGroupId            Guid                           Het id van de bepaalde prijsgroep.

                                                                                                                    33
6.2.1.2.4      CultureEventReservation
Een cultureEventReservation is een specifiek basketItem dat enkel gebruikt wordt voor de verkoop van
tickets voor een cultuur event.
Een CultureEventReservation moet altijd locked worden vooraleer er een Checkout of Validate
gebeurt.
Dit object bevat de volgende elementen.
Naam                    Type                           Omschrijving                                Opmerkingen

Id                      Guid                           Unieke Identifier van het BasketItem.
CultureEventId          Guid                           De unieke identifier van het cultuur
                                                       evenement.
ReservationDate         DateTime                       De datum van de reservatie.
Comments                String                         Commentaar die kan toegevoegd
                                                       worden aan de reservatie.
Entries                 CultureEventReserv             Een lijst van
                        ationEntry                     cultureEventReservationEntries.
Lockticket              LockTicket                     Zie 3.3.3 : Lock en Unlock van basket-
                                                       items.
Options                 List<CultureEventOp            De lijst van opties die toegevoegd zijn     Wordt nog niet
                        tionReservation>               aan deze reservering.                       gebruikt.


6.2.1.2.5      CultureEventReservationEntry
Een CultureEventReservationEntry is het abstracte klasse dat de data zal bevatten die specifieert
hoeveel en welke tickets er precies zullen aangekocht worden voor dat specifieke cultuur evenement.
Er zijn twee mogelijkheden om zitjes te reserveren:
           Best-Available Seats
            De zitjes worden toegewezen volgens een bepaald algorithme. Je zegt hoeveel zitjes je wilt in


Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
            welke prijsklasse en het algoritme probeert die zo goed mogelijk voor jou uit te kiezen. (Liefst
            naast/dicht bij elkaar.
           Expliciete Zitjes
            Je kiest zelf het zitje dat je wilt (exacte plaats)
BestAvailableSeatsCultureEventReservationEntry
Naam                     Type                            Omschrijving                             Opmerkingen

ParticipantCount         Int                             Het aantal deelnemers.
PriceGroupId             Guid                            De unieke identifier van de prijsgroep
                                                         voor dit entry.


ExplicitSeatsCultureEventReservationEntry
Naam                     Type                            Omschrijving                             Opmerkingen

SeatId                   Guid                            De ID van het zitje dat je wil                         34
                                                         locken/reserveren.
PriceGroupId             Guid                            De unieke identifier van de prijsgroep
                                                         voor dit entry.


Voorbeeld van entries : Een vader koopt 3 tickets voor een voorstelling. Hiervan is er 1 voor zichzelf en 2
voor zijn kinderen. Als gevolg heeft hij 2 cultureEventReservationEntries namelijk 1 met prijsgroep
volwassenen en participantCount 1, en een tweede entry met prijsgroep kinderen en participantcount
2.


6.2.1.2.6      CultureEventWaitingListReservation (vanaf RCX 5.0.5)
Een cultureEventWaitingListReservation is een specifiek basketItem dat enkel gebruikt wordt voor het
inschrijven op de wachtlijst van een cultuur event. Dit type basketItem is altijd gratis en kan niet gelockt
worden. Dit object bevat de volgende elementen.
Naam                     Type                            Omschrijving                             Opmerkingen

Id                       Guid                            Unieke Identifier van het BasketItem.
CultureEventId           Guid                            De unieke identifier van het cultuur
                                                         evenement.
ReservationDate          DateTime                        De datum van de inschrijving.
Comments                 String                          Commentaar die kan toegevoegd
                                                         worden aan de inschrijving.
Quantity                 Int                             Aantal zitjes dat gewest is.




6.2.1.2.7      WaitingListSale (vanaf RCX 5.0.5)

Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
Een WaitingListSale is een specifiek basketItem dat enkel gebruikt wordt bij het inschrijven van een
persoon op een wachtlijst.
Een WaitingListSale moet altijd locked worden vooraleer er een Checkout of Validate gebeurt.
Dit object bevat de volgende elementen.
Naam                    Type                        Omschrijving                                 Opmerkingen

Id                      Guid                        Unieke Identifier van het BasketItem.
Quantity                integer                     Aantal in te schrijven leerlingen per        Moet altijd 1 zijn.
                                                    object.
UnitPrice               decimal                     De eenheidsprijs van het gekoppelde
                                                    prijsartikel.
WaitingListID           Guid                        Id van de wachtlijst waarop er inschreven
                                                    wordt.
ItemID                  Guid                        Id van het prijsartikel (uit WaitingList).
                                                                                                                       35
WaitingListLesson       List <LessonGroup>          Lijst van gekozen voorkeurlesgroepen met
Groups                                              ingevulde prioriteit.
Lockticket              LockTicket                  Zie 3.3.3 : Lock en Unlock van basket-
                                                    items.
PersonID                Guid                        Indien dit ingevuld is wordt deze persoon    Vanaf Service
                                                    ingeschreven op de wachtlijst, indien dit    v2.0.1 met
                                                    leeg blijft wordt de ingelogde klant         Storage v5.0.5.2
                                                    ingeschreven bij de CheckOut.


6.2.1.2.8      FitnessActivityDayReservation (vanaf RCX 5.0.5)
Een FitnessActivityDayReservation is een specifiek basketItem dat enkel gebruikt wordt bij het inschrijven
op een bepaalde fitness activiteit.
Een FitnessActivityDayReservation moet altijd locked worden vooraleer er een Checkout of Validate
gebeurt.
Dit object bevat de volgende elementen.
Naam                    Type                        Omschrijving                                 Opmerkingen

Id                      Guid                        Unieke Identifier van het BasketItem.
Quantity                integer                     Aantal inschrijvingen                        Moet altijd 1 zijn
UnitPrice               decimal                     De eenheidsprijs van de gekoppelde
                                                    fitness activiteit.
FitnessActivityDay      Guid                        Id van de fitness activiteitsdag waarop er
Id                                                  inschreven wordt.
FitnessActivitySlot     IList<Guid>                 Lijst van gekozen slots                      Niet verplicht
s
PersonId                Guid?                       Id van de persoon die zich inschrijft        Voor non-



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                                                             members zie 9.4
SubscriptionId          Guid?                       Id van het abonnement warmee de          Niet gebruikt bij
                                                    persoon zich inschrijft                  non-members
WaitingList             Bool                        Inschrijven op wachtlijst of niet?       True wanneer
                                                                                             een dag volzet is
                                                                                             en er op de
                                                                                             wachtlijst wil
                                                                                             gereserveerd
                                                                                             worden
Lockticket              LockTicket                  Zie 3.3.3 : Lock en Unlock van basket-
                                                    items.


6.2.1.2.9      RentalReservation
                                                                                                                 36
Een RentalReservation is een specifiek basketItem dat enkel gebruikt wordt bij het inschrijven op een
bepaalde fitness activiteit.
Een RentalReservation moet altijd locked worden vooraleer er een Checkout of Validate gebeurt.
Dit object bevat de volgende elementen.
Naam                    Type                        Omschrijving                             Opmerkingen

Id                      Guid                        Unieke Identifier van het BasketItem.
Quantity                integer                     Aantal artikelen
UnitPrice               decimal                     De eenheidsprijs van het gekoppelde
                                                    huurartikel.
ArticleId               Guid                        Id van het huurartikel.
From                    DateTime                    Startdatum en –tijd van de verhuring.
Until                   DateTime                    Einddatum en –tijd van de verhuring.
Delivery                DateTime?                   Datum en tijd van de afhaling van de     Niet verplicht
                                                    huurartikels
Return                  DateTime?                   Datum en tijd van de teruggave van de    Niet verplicht
                                                    huurartikels
Lockticket              LockTicket                  Zie 3.3.3 : Lock en Unlock van basket-
                                                    items.
OrderWithoutPay         Bool                        True = enkel bestellen ZONDER betaling
ment                                                False = MET betaling
RentalPrice             decimal                     De huurprijs van de totale reservering


6.2.1.2.10     ActivityReservation (vanaf RCX 5.0.5)
Een ActivityReservation is een specifiek basketItem dat enkel gebruikt wordt bij het inschrijven van een
persoon op een activiteit.
Een ActivityReservation moet altijd locked worden vooraleer er een Checkout of Validate gebeurt.

Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Dit object bevat de volgende elementen.
Naam                    Type                         Omschrijving                                    Opmerkingen

Id                      Guid                         Unieke Identifier van het BasketItem.
Activity                Activity                     Activity object waarop men wenst in
                                                     te schrijven
Customer                Person                       Facturatieklant van de inschrijving.            NULL indien anonieme
                                                                                                     inschrijving
ActivityParticipantR    List<ActivityParticipantr    Lijst van ActivityParticipantReservation.
eservations
                        eservation>                  Zie 6.2.1.2.9.1

Comments                string                       Commentaar op de inschrijving
TotalPrice              decimal                      Voorlopig totale prijs van de
                                                     inschrijving, kan bij anonieme
                                                     inschrijvingen nog aangepast worden
                                                     na het inloggen.
                                                                                                                                       37
OptionPrice             decimal                      Voorlopig optie prijs van de
                                                     inschrijving, kan bij anonieme
                                                     inschrijvingen nog aangepast worden
                                                     na het inloggen.
UnitPrice               decimal                      Eenheidsprijs van de activiteit
Lockticket              LockTicket                   Zie 3.3.3 : Lock en Unlock van basket-
                                                     items.
Quantity                integer                      Aantal artikelen                                Niet van toepassing
Status                  integer                      0 = voorlopig gereserveerd                      Enkel bij Status = 2 wordt er
                                                     1 = wachtlijst                                  een bedrag gekoppeld en
                                                     2 = gereserveerd (default)                      zal het resultaat een
                                                                                                     geboekte inschrijving zijn,
                                                                                                     andere een ongeboekte


6.2.1.2.10.1 ActivityParticipantReservation
Een ActivityParticipantReservation is in feite de reservering van een deelnemer binnen een inschrijving.
Er zijn meerdere deelnemers per inschrijving mogelijk (bv : vader schrijft zijn 3 kinderen in op 1 activiteit)
Naam                    Type                         Omschrijving                                    Opmerkingen

ParticipantId           Guid                         Id van de deelnemer                             PersonId
Comment                 string                       Commentaar op de deelnemer van
                                                     een inschrijving
PriceGroupId            Guid                         Id van de prijsgroep van deze                     Guid.Empty: bij inschrijven

                                                     deelnemer                                          op activiteitsprijs
                                                                                                       NULL: bij prijsberekening op
                                                                                                        prijsgroep van klant
                                                                                                       Ingevulde Guid: bij een
                                                                                                        door de klant gekozen
                                                                                                        prijsgroep
                                                                                                 Zie punt 17.4



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
ParticipantActivityD    List<ActivityPartReserv      Lijst van ingeschreven dagen met
ays                     ation>                       telkens de gekoezen opties. Zie
                                                     6.2.1.2.9.1.1


6.2.1.2.10.1.1          ActivityPartReservation
Een ActivityPartReservation is de combinatie van een activiteitsdag met een lijst van gekozen opties.
Naam                    Type                         Omschrijving                                Opmerkingen

ActivityPart            ActivityPart                 Zie 17.3.2.2
ActivityOptions         List<ActivityOption>         Lijst van opties. Zie 17.3.2.3
IsSelected              Bool                         Aanwezig op die bepaalde dag?




6.2.1.3      Payments                                                                                             38


De gebruiker heeft de mogelijkheid om een of meerdere betaalwijzes te koppelen aan de Basket.
Hiervoor worden BasketPayments gebruikt. Een Basketpayment ziet er als volgt uit.
Belangrijk : Indien gekozen is voor een IncassoBetaling moet er ook een IncassoBasketPayment
gebruikt worden! Indien dit niet gedaan wordt zal er geen incassocontract worden aangemaakt en zal
dit lijden tot ongeldige betalingen.
Naam                           Type                  Omschrijving                                Opmerkingen

Amount                         Decimal               Het bedrag van de betaling.
Currency                       String                De naam van de currency.                    Wordt nog niet
                                                                                                 gebruikt.
PaymentMethodId                Guid                  Het id van de betaalwijze zoals gekend in
                                                     ReCreateX.


IncassoBasketPayment
Een incassoBasketPayment bestaat uit een BasketPayment maar heeft een aantal extra
eigenschappen.
Naam                           Type                  Omschrijving                                Opmerkingen

NumberOfIncassoPay             int                   Het aantal incassobetalingen dat de
ments                                                gebruiker gekozen heeft.


6.2.2      Response
Het valideren van een basket zal een ValidateBasketResponse teruggeven welk een
BasketValidationResult omvat. Een BasketValidationResult bestaat uit een brokenrulename, message en
BasketItemValidationResults.




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
De brokenRuleName zal telkens de naam van de validatieRegel teruggeven waaraan niet voldaan kon
worden.
Indien de brokenRuleName leeg is, dan mag men besluiten dat aan elke validatieregel kon voldaan
worden en dat de validatie gelukt is. Vervolgens hoeft men dan ook geen rekening te houden met de
BasketItemValidationResults en /of de message.


6.2.2.1      BasketValidationResult
Het valideren van een basket bestaat uit het valideren van het Basket op zich en van de basketItems.
Naam                    Type                        Omschrijving                               Opmerkingen

BrokenRuleName          String                      Bevat de naam van de regel waaraan
                                                    niet voldaan kon worden. Leeg indien
                                                    succesvol gevalideerd.
Message                 String                      Message die hoort bij de
                                                                                                             39
                                                    brokenRuleName.
BasketItemValida        Lijst<BasketItemVali        Lijst met validaties van BasketItems die
tResults                dationResults>              niet succesvol konden gevalideerd
                                                    worden. (zie verder)


6.2.2.2      BasketItemValidationResult
Net zoals BasketValidationResult omvat ook dit object, een brokenRuleName en een bijhorende
message. Extra hierbij is het ValidatedBasketItem welk het basketItem omvat dat gevalideerd is.
Naam                       Type                     Omschrijving                               Opmerkingen

BrokenRuleName             String                   Bevat de naam van de regel waaraan
                                                    niet voldaan kon worden. Leeg indien
                                                    succesvol gevalideerd.
Message                    String                   Message die hoort bij de
                                                    brokenRuleName.
ValidatedBasketItem        BasketItem               Het BasketItem dat niet succesvol kon
                                                    gevalideerd worden.


6.3       VALIDATEBASKETITEM
Deze functie is gelijkaardig aan ValidateBasket, enkel dat men hier 1 item meegeeft ipv meerdere bij
ValidateBasket.


6.4       RECALCULATEBASKET
Deze functie zal op basis van een gegeven basket, de juiste prijs van de basket berekenen en deze
dan teruggeven met de juiste prijzen in de response




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
6.4.1      Request
De request van de recalculateBasket bestaat uit een service Context en een Basket


6.4.2      Response
De Response is de herberekende Basket.


6.5       CHECKOUTBASKET
Deze operatie zal op basis van het winkelmandje de verkoop gaan genereren. Vooraleer dat de
verkoop zal gegeneerd worden, zal dezelfde validatie plaatsvinden die ook bij ValidateBasket
plaatsvindt. Bijkomend moet er nu op het basket wel een CustomerId (Het Id van de Person) ingevuld
zijn.
De Checkout zal rekening houden met locktickets indien deze aanwezig zijn op het BasketItem.


6.5.1      Request                                                                                             40
De request bestaat uit de Service Context en de Basket die zal uitgechecked worden.


6.5.2      Response
De response is een CheckoutBasketResult. Dit bestaat uit een BasketValidationResult en een
CheckoutResultState.
Naam                        Type                     Omschrijving                                Opmerkingen

BasketValidationResult      BasketValidationResult   Zie 6.2.2.2 : BasketItemValidationResult.
ResultState                 CheckOutResult           Een enumeratie die het resultaat
                                                     weergeeft van het checkout proces:
                                                               None
                                                               Success
                                                               Failed
SalesItems                  List<SalesItems>         Een lijst van aangekochte items.


6.5.2.1      SalesItems
Een salesitem een item dat verkocht is in de webshop. Aan de hand van deze salesitems kan er een
overzicht aangemaakt worden van de verkochte artikelen.
Verder zullen in deze salesitems ook de barcodes of verwijzingen naar barcodes vervat zitten.
Naam                        Type                     Omschrijving                                Opmerkingen

Id                          Guid                     De unieke identifier van het verkochte
                                                     artikel.
Quantity                    Int                      De hoeveelheid.
Name                        String                   De naam van het verkochte artikel.
UnitPrice                   Decimal                  De unitprijs van het verkochte artikel.
BarCodes                    List<string>             Een lijst met barcodes horend bij het



Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
                                                    verkochte artikel.


Per artikel type kan er een specifiek salesitem zijn dat enkel extra eigenschappen heeft.


6.5.2.1.1      ExpositionSalesItem
Naam                         Type                   Omschrijving                             Opmerkingen

ExpositionId                 Guid                   De unieke identifier van de expositie.


ExpositionPeriodId           Guid                   De unieke identifier van de expositie
                                                    periode.


6.5.2.1.2      ArticleSalesItem
Naam                         Type                   Omschrijving                             Opmerkingen
                                                                                                             41
ArticleId                    Guid                   De unieke identifier van het verkochte
                                                    artikel.


6.5.2.1.3      CultureEventReservationSalesItem
Naam                         Type                   Omschrijving                             Opmerkingen

Seats                        List<SeatAllocation>   Een lijst van gereserveerde zitjes.


CultureEventReservatio       Guid                   Het id van de aangemaakte reservatie.    Dit id wordt
nId                                                                                          gebruikt door
                                                                                             de
                                                                                             documentSer
                                                                                             vice om
                                                                                             tickets te
                                                                                             genereren.


6.6     LOCKBASKETITEMS
De Service Methode Lock Basket items zal de items die kunnen gelocked worden, locken. Om deze te
locken zal er vooraf validatie af gaan.


6.6.1       Request
De request bestaat uit de service context en uit een lijst van Basket Items die gelocked moeten worden.


6.6.2       Response
De response bestaat uit een LockBasketResult
Naam                         Type                   Omschrijving                             Opmerkingen

IsLocked                     Boolean                Geeft aan of het item gelocked is of



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                    niet.
List<BasketItem>             List<BasketItem>       Een lijst van basketItems waarbij het
                                                    lockticket zal ingevuld zijn op het
                                                    basketItem.
ValidationResult             ValidationResult


Het lockticket type dat toegevoegd wordt op het basketItem is afhankelijk van het basketitem zelf.
Een basis lockticket ziet er als volgt uit.


6.6.2.1      LockTicket
Naam                         Type                   Omschrijving                               Opmerkingen

ExperationTime               DateTime               Datum tot wanneer de lock geldig is.
Id                           Guid                   Het id van de reservatie.
                                                                                                             42

6.6.2.2      CultureEventReservationLockTicket.
Dit lockticket heeft alle eigenschappen van een basis lockticket met als extra een Lijst met
SeatAllocations. Dit geeft aan welke zitjes er voorlopig gereserveerd zijn door deze lockoperatie.


6.6.2.2.1      SeatAllocation
Een SeatAllocation is een toegewezen (allocated) zitje voor een cultuur evenement en ziet er als volgt
uit
Naam                                    Type        Omschrijving                               Opmerkingen

CardNumber                              String      Het kaartnummer dat gekoppeld is aan
                                                    de reservering.
CultureEventID                          Guid        De identifier van het evenement
                                                    waarvoor er gereserveerd is.
CultureEventReservationId               Guid        De unieke identifier waarvoor het zitje
                                                    gereserveerd is.
CustomerID                              Guid        De identifier van de klant die
                                                    gereserveerd heeft.
Price                                   Decimal     De prijs van het gereserveerde zitje.
SeatBlockCode                           String      De zone waarin het zitje zich bevindt.
SeatCode                                String      De unieke code van het zitje binnen de
                                                    rij.
SeatId                                  Guid        De unieke identifier van het zitje in de   SeatId
                                                    zaal.
SeatRowCode                             String      De unieke code van de rijk.
Status                                  Enum        Zie 11.7 voor meer uitleg over de



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                      verschillende statussen.


6.7     UNLOCKBASKETITEMS
Deze methode zal van de basketitems die een lock hebben, de lock verwijderen. Voor meer informatie
over het locken en unlocken zie 3.3.3 : Lock en Unlock van basket-items


6.7.1      Request
De request bestaat uit de service Context en een lijst van LockTickets. Van elk LockTicket dient enkel het
Id ingevuld te worden.


6.8     EXTENDLOCKPERIOD
Deze operatie maakt het voor de eindgebruiker mogelijk om een lockticket te verlengen in tijd.


6.8.1      Request                                                                                           43
De request bestaat uit een service context en een lijst van lockTickets. De locktickets dienen
meegegeven te worden met het juiste type.


6.9     LISTPAYMENTMETHODS
Deze operatie geeft een lijst weer van de betaalwijzen die gekend zijn in ReCreateX (vb Visa,
BankContact, …).


6.9.1      Request
De Request bestaat enkel uit de Service Context.


6.9.2      Response
De response bestaat uit een lijst van BasketPaymentmethods
Zo een BasketPaymentMethod ziet er uit als volgt:
Naam                       Type        Omschrijving                                        Opmerkingen

Id                         Guid        De unieke Identifier van de BasketPaymentMethod.
Code                       String      De unieke code van de BasketPaymentMethod.
Name                       String      De omschrijving van de basketPaymentMethod.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
Indien een PaymentMethod incassoverwerking heeft, dan ziet een IncassoBasketPaymentMethod er als
volgt uit:
Naam                         Type                    Omschrijving                       Opmerkingen

Id                           Guid                    De unieke Identifier van de
                                                     IncassoBasketPaymentMethod.
Code                         String                  De unieke code van de
                                                     IncassoBasketPaymentMethod.
Name                         String                  De omschrijving van de
                                                     IncassoBasketPaymentMethod.
AdditionalIncassoCosts       List<IncassoCost>       Lijst met kosten die met Incasso   Extra kosten
                                                     meekomen.                          voor Incasso in
                                                                                        1x, 2x of 3x

                                                                                                          44
Een incassoverwerking is enkel mogelijk bij het reserveren van een Cultuurevenement en dit kan niet
gecombineerd worden met andere betalingen of met andere soorten BasketItems.
Een AdditionalCost of IncassoCost ziet er als volgt uit
Naam                       Type            Omschrijving                                   Opmerkingen

Name                       String          De naam van de IncassoCost.
Cost                       decimal         De waarde van de IncassoCost.
NumberOfPayments           Int32           Het aantal keer waarin betaald worde.          Is 1, 2 of 3




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
7       Profiel
7.1     BEKNOPT OVERZICHT
INVULLEN


7.2     VALIDATEUSERNAME
Deze operatie zal controleren indien een gebruikersnaam al dan niet reeds gebruikt wordt.


7.2.1      Request
De Request bestaat uit een Service Context en een tekst object voor de gebruikersnaam.
Naam                    Type                            Omschrijving                                    Opmerkingen

UserName                String                          De gebruikersnaam die gevalideerd moet
                                                        worden.
                                                                                                                        45
7.2.2      Response
De response bestaat uit een AuthenticationResult die aangeeft of de gebruikersnaam al dan niet
bestaat.
Naam                    Type                            Omschrijving                                    Opmerkingen

HasSucceeded            Boolean                         Geeft aan of de gebruikersnaam al in gebruik
                                                        is.
                                                                 True = nog niet in gebruik
                                                                 False = in gebruik
Error                   AuthenticationError             Een enumeratie die de fout teruggeeft van het   Voor
                                                        authenticatieProces.                            securitydoel
                                                        Mogelijke waarden zijn :                        einden wordt
                                                                 None                                  hier geen
                                                                 InvalidParameters                     correcte
                                                                 UserNameExists                        informatie in
                                                                                                        geplaatst.
PersonId                Guid                            Steeds Guid.Empty in dit geval.                 Wordt niet
                                                                                                        gebruikt in
                                                                                                        deze
                                                                                                        methode.
LastLoginDate           DateTime?                       Geeft aan wanneer de gebruiker zich de          Indien leeg:
                                                        laatste keer authenticeerde.                    eerste keer.


7.3     AUTHENTICATEUSER
Deze operatie zal een gebruiker authenticeren aan de hand van zijn username en paswoord.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
7.3.1      Request
De Request bestaat uit een Service Context en een Credential. De Credentials zien er als volgt uit.
Naam                    Type                            Omschrijving                                    Opmerkingen

Username                String                          De Login waarmee de gebruiker zal
                                                        authenticeren.
Password                String                          Het passwoord waarmee de gebruiker zal
                                                        authenticeren.


7.3.2      Response
De response bestaat uit een authenticationresult die aangeeft of de gebruiker al dan niet succesvol is
geauthenticeerd.
Naam                    Type                            Omschrijving                                    Opmerkingen

HasSucceeded            Boolean                         Geeft aan of de gebruiker al dan niet
                                                                                                                        46
                                                        succesvol is geauthenticeerd.
Error                   AuthenticationError             Een enumeratie die de fout teruggeeft van het   Voor
                                                        authenticatieProces.                            securitydoel
                                                        Mogelijke waarden zijn :                        einden wordt
                                                               None                                    hier geen
                                                               InvalidParameters                       correcte
                                                               UnknownUser                             informatie in
                                                               BlockedUser                             geplaatst.
                                                               InvalidCredential
PersonId                Guid                            Het id van de geauthenticeerde gebruiker.
LastLoginDate           DateTime?                       Geeft aan wanneer de gebruiker zich de          Indien leeg:
                                                        laatste keer authenticeerde..                   eerste keer.


7.4     AUTHENTICATENATIONALNUMBER
Deze operatie zal een gebruiker authenticeren aan de hand van zijn rijksregisternummer. Het is de
verantwoordelijkheid van de web site om het gebruik van deze methode te beperken tot eenmalig
gebruik. Dit kan door de gebruiker bij zijn eerste login via deze methode verplicht een gebruikersnaam
en wachtwoord te doen kiezen! Wanneer een gebruiker reeds een gebruikersnaam heeft binnen
ReCreateX, zal niet via deze methode kunnen geauthenticeerd worden.


7.4.1      Request
De Request bestaat uit een Service Context en een tekst object voor het rijksregisternummer.
Naam                    Type                            Omschrijving                                    Opmerkingen

NationalNumber          String                          Het rijksregisternummer waarmee de gebruiker
                                                        zal authenticeren.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
7.4.2      Response
De response bestaat uit een authenticationresult die aangeeft of de gebruiker al dan niet succesvol is
geauthenticeerd.
Naam                    Type                            Omschrijving                                    Opmerkingen

HasSucceeded            Boolean                         Geeft aan of de gebruiker al dan niet
                                                        succesvol is geauthenticeerd.
Error                   AuthenticationError             Een enumeratie die de fout teruggeeft van het   Voor
                                                        authenticatieProces.                            securitydoel
                                                        Mogelijke waarden zijn :                        einden wordt
                                                               None                                    hier geen
                                                               InvalidParameters                       correcte
                                                               UnknownUser                             informatie in
                                                               BlockedUser                             geplaatst.
                                                                                                                        47
                                                               HasUserName
PersonId                Guid                            Het id van de geauthenticeerde gebruiker.
LastLoginDate           DateTime?                       Geeft aan wanneer de gebruiker zich de          Indien leeg:
                                                        laatste keer authenticeerde.                    eerste keer


7.5     AUTHENTICATEMANAGER
Deze operatie zal een manager authenticeren aan de hand van zijn username en paswoord. De
manager authenticatie wordt gebruikt voor extra configuraties betreffende de web site. (CMS beheer)


7.5.1      Request
De Request bestaat uit een Service Context en een Credential object. Het Credential object ziet er als
volgt uit.
Naam                    Type                            Omschrijving                                    Opmerkingen

UserName                String                          De Login waarmee de manager zal
                                                        authenticeren.
Password                String                          Het passwoord waarmee de manager zal
                                                        authenticeren.


7.5.2      Response
De response bestaat uit een AuthenticationResult die aangeeft of de gebruiker al dan niet succesvol is
geauthenticeerd.
Naam                    Type                            Omschrijving                                    Opmerkingen

HasSucceeded            Boolean                         Geeft aan of de gebruiker al dan niet
                                                        succesvol is geauthenticeerd.
Error                   AuthenticationError             Een enumeratie die de fout teruggeeft van het   Voor
                                                        authenticatieProces.                            securitydoel


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        Mogelijke waarden zijn :                          einden wordt
                                                               None                                      hier geen
                                                               InvalidParameters                         correcte
                                                               InvalidCredential                         informatie in
                                                                                                          geplaatst.
PersonId                Guid                                                                              Wordt niet
                                                                                                          gebruikt.
LastLoginDate           DateTime?                                                                         Wordt niet
                                                                                                          gebruikt.


7.6       SAVEPERSON
Deze operatie wordt gebruikt om een gebruiker aan te maken of te wijzigen in het ReCreateX systeem.


7.6.1      Request                                                                                                        48

De Request bestaat uit een Service Context, een Person object en een SavePersonOptions object.
De gebruikte eigenschappen voor een Person object zien er als volgt uit.


7.6.1.1      Person
Name                    Type                            Omschrijving                             Opmerkingen

ActivationID            Guid                            Uniek ID om user account te activeren.   Wordt niet gebruikt in
                                                                                                 WebServices.
Id                      Guid                            De Unieke Identifier van de gebruiker.   Bij aanmaak zal dit
                                                                                                 leeg zijn.
Code                    String                          Een unieke code van de gebruiker.
Name                    PersonName                      De naam van de gebruiker.
Address                 Address                         Het adres van de gebruiker.
Settings                PersonSettings                  Extra instellingen van de gebruiker.
Email                   String                          Het email adres van de gebruiker.
BirthDate               DateTime?                       De geboortedatum van de gebruiker.       Nullable
Gender                  Gender                          Het geslacht van de gebruiker.           Enumerator: Male=0,
                                                                                                 Female=1,
                                                                                                 Unknown=2
Language                String                          De iso code van de taal van de           Vb: “NL”, “FR”, …
                                                        gebruiker.
Picture                 Byte array                      De afbeelding van de gebruiker.          Wordt nog niet
                                                                                                 gebruikt.
Phone                   String                          Telefoon van de gebruiker.
CellPhone               String                          Mobiele telefoon van de gebruiker.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
BankAccount             String                          Bankrekening nummer van de
                                                        gebruiker.
NationalNumber          String                          Bevolkings register nummer van de          Rijksregisternummer in
                                                        gebruiker.                                 België.
Comments                String                          Opmerkingen van de gebruiker.
Credential              Credential                      Aanmeldgegevens van de gebruiker.          Verplicht mee te
                                                                                                   geven.
IsBlocked               Boolean                         Geeft aan of de gebruiker al dan niet
                                                        geblokkeerd is.
Type                    PersonType                      Geeft aan om welk type het gaat:
                                                            -   Unknown
                                                            -   Individu
                                                            -   Group
                                                                                                                            49
                                                            -   Company
                                                            -   Location
                                                            -   Physician
Parent                  Boolean                         Geeft aan of de gebruiker al dan niet
                                                        een ouder is.
Disabled                Boolean                         Geeft aan of de gebruiker al dan niet
                                                        mindervalide is.
HeadOfFamily            Boolean                         Geeft aan of de gebruiker al dan niet
                                                        gezinshoofd is.
Relations               List<Relation>                  Gezinsrelaties van de gebruiker.           Wordt nog niet
                                                                                                   gebruikt.


7.6.1.2      PersonName
Naam                    Type                            Omschrijving                                         Opmerkingen

First                   String                          De voornaam van de gebruiker.
Middle                  String                          De tussennaam van de gebruilker.
Last                    String                          De familienaam van de gebruiker.


7.6.1.3      Address
Naam                    Type                            Omschrijving                                         Opmerkingen

Street                  String                          Straat Adres van de gebruiker.
Number                  String                          Nummer van het adres van de gebruiker.
Box                     String                          Bus van het adres van de gebruiker.
ZipCode                 String                          Postcode van het adres van de gebruiker.
Town                    String                          Stad van het adres van de gebruiker.



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Country                 String                        Iso code van het land van het adres van de          Vb.: “BE”,
                                                      gebruiker.                                          “NL”, “FR”, …
LocationName            String                        Naam van de locatie, wordt voorlopig enkel
                                                      ingevuld bij de Location op Activity-niveau


7.6.1.4      PersonSettings
Naam                       Type                           Omschrijving                              Opmerkingen

SubscribeMailingLis        Boolean                        Inschrijven voor de nieuwsbrief.          Wordt nog niet
t                                                                                                   gebruikt.
Subcategories              List<Subcategory>              Lijst met subcategories waartoe de
                                                          persoon behoort.
PriceGroups                List<PersonPriceGrou           Lijst van prijsgroepen dat de
                           p>                             persoon heeft.
                                                                                                                          50
PersonLLVInfos             List<PersonLLVInfo>            Lijst specifieke zwemles – informatie.    Vanaf RCX 5.0.5
PersonLLVTransferHi        List<PersonLLVTransfer         Lijst met transferhistoriek van de        Vanaf RCX 5.0.5
stories                    History>                       klant.
PersonLLVCurrentLe         List<LessonGroup>              Lijst van de alle Lesgroepen waar         Vanaf RCX 5.0.5
ssonGroups                                                de persoon registraties heeft.
PersonChildCareInf         PersonChildCareInfo            Object met extra informatie
o                                                         betreffende buitenschoolse
                                                          kinderopvang


7.6.1.5      PersonPriceGroup
Naam                     Type                             Omschrijving                              Opmerkingen

Id                       Guid                             Uniek ID
Type                     PersonPriceGroupType             Enumeratie van de ReCreateX                Zaalreserveringen
                                                          module waar deze prijsgroep actief         Ticketing
                                                          is.                                        Inschrijvingen
                                                                    PlaceReservations = 0           Verkoop (&
                                                                    Ticketing = 1                    exposities)
                                                                    Entries = 2                     Verhuur
                                                                    Sales = 3                       Fitness/wellness
                                                                    Rental = 4
                                                                    Wellness = 5
PriceGroup               PriceGroup                       De prijsgroep.
StartDate                DateTime                         Startdatum van period waarin de           Nullable
                                                          prijsgroep actief is.
EndDate                  DateTime                         Einddatum van deze periode.               Nullable



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
WeekDay                 WeekDay                       Enumeratie van de dag van de            Iedere dag
                                                      week waarop de prijsgroep actief is.    Maandag
                                                                 EveryDay                    Dinsdag
                                                                 Monday                      Woensdag
                                                                 Tuesday                     Donderdag
                                                                 WednesDay                   Vrijdag
                                                                 Thursday                    Zaterdag
                                                                 Friday                      Zondag
                                                                 Saturday
                                                                 Sunday
From                    String                        String notatie van het uur deze        Notatie 00:00:00 =
                                                      prijsgroep actief wordt.               PT00H00M00S


                                                                                                                  51
Till                    String                        Eindtijd.                              Notatie 23:59:59 =
                                                                                             PT23H59M59S




7.6.1.6      PersonLLVInfo
Naam                         Type                     Omschrijving                           Opmerkingen

Id                           Guid                     Uniek ID.
NumberPresent                Int                      # aanwezigheden in lesgroep.
StartDate                    Datetime                 Begindatum lesgroep.
LastDate                     Datetime                 Laatste registratie.
StartDateLLV                 Datetime                 Startdatum leszwemmen.
NumberPresentLevel           Int                      # aanwezigheden op dit niveau.


StartDateLevel               Datetime                 Begindatum op dit niveau.


NumberAbsent                 Int                      # afwezigheden in lesgroep.


NumberRegistrations          Int                      # registraties op dit niveau.


SwimmingComment              String                   Zwemles commentaar van leerling.




7.6.1.7      PersonLLVTransferHistory
Naam                         Type                     Omschrijving                           Opmerkingen

Id                           Guid                     Uniek ID.



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
Date                      Datetime                 Datum van transfer.

FromGroup                 string                   Omschrijving van de lesgroep waaruit
                                                   de leerling getransfereerd werd.

FromGroupCode             string                   Code van de lesgroep waaruit de
                                                   leerling getransfereerd werd.

ToGroup                   string                   Omschrijving van de lesgroep naar waar
                                                   de leerling getransfereerd werd.

ToGroupCode               string                   Code van de lesgroep naar waar de
                                                   leerling getransfereerd werd.


7.6.1.8      PersonChildCareInfo
Naam                      Type                     Omschrijving                                Opmerkingen

Id                        Guid                     Unieke ID van de persoon
School                    ChildCareSchool          Details betreffende de school van de                      52
                                                   persoon

Tariff                    ChildCareTariff          Details betreffende het tarief dat wordt
                                                   gebruikt bij de prijsberekening voor deze
                                                   persoon

LeaveAlone                Bool                     Mag het kind de opvang alleen
                                                   verlaten?

HasMedication             Bool                     Neemt het kind medicatie?

MedicationName            String                   Naam van de medicatie

MedicationDose            String                   Dosis van de medicatie

MedicationExtraInfo       String                   Extra informatie omtrent de medicatie

HasAllergy                String                   Heeft het kind een allergie?

AllergyName               String                   Naam van de allergie

AllergyExtraInfo          String                   Extra informatie omtrent de allergie

OtherMedicalInfo          String                   Extra algmene informatie omtrent de
                                                   medische gegevens


7.6.1.9      ChildCareSchool
Naam                      Type                     Omschrijving                                Opmerkingen

Id                        Guid                     De unieke Identifier van de school
Code                      String                   Code van de school
Name                      String                   De naam van de school
Location                  AddressLocation          Locatie van de school                       Zie 9.5.2




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
7.6.1.10     ChildCareTariff
Naam                         Type                         Omschrijving                          Opmerkingen

Id                           Guid                         De unieke Identifier van het tarief
Code                         String                       Code van het tarief
Name                         String                       Naam van het tarief
Description                  String                       Omschrijving van het tarief


7.6.1.11     Credential
Naam                         Type                     Omschrijving                              Opmerkingen

UserName                     String                   Gebruikersnaam van de gebruiker.          Moet uniek zijn.
Password                     String                   Wachtwoord van de gebruiker.


Het SavePersonOptions object ziet er als volgt uit:                                                                53


Naam                         Type                     Omschrijving                              Opmerkingen

CreateZipcodes               Bool                     Moeten ongekende landen en                Zipcodes worden
                                                      postcodes aangemaakt worden in            enkel aangemaakt
                                                      ReCreateX? Default gebeurt dit niet.      indien zowel
                                                                                                ZipCode, Town en
                                                                                                Country zijn
                                                                                                ingevuld.


7.6.2      Response
De response zal een SavePersonResult object teruggeven. Dit object bevat het Person object en
eventuele ValidationResults die aangeven wat er fout gelopen is.


7.6.2.1      SavePersonResult
Naam                      Type                           Omschrijving                                Opmerkingen

Person                    Person                         Het gemanipuleerde Person object.
ValidationResults         List<ValidationResult>


7.6.2.2      ValidationResult
Naam                      Type                           Omschrijving                                Opmerkingen

BrokenRuleName            String                         De code van de foutmelding.
Message                   String                         De standaard foutmelding.
IsValid                   Bool                           Geeft weer of dit een geldig
                                                         ValidationResult is.




Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
7.7       SAVEPERSONCONTACTS
7.7.1      Request
Het Request bestaat uit een Service Context en een Person object. Belangrijk hierin is dat de Contacts
binnen dit Person object correct worden meegegeven.
Optioneel kan er worden gekozen om reeds bestaande contacten bij te werken of op te kuisen.
          Bij het bijwerken wordt de regel gehanteerd: Contacten aanwezig in zowel het Person object
           als in de Backoffice worden bijgewerkt. (Anders worden bestaande contacten ongemoeid
           gelaten.)
          Bij het opkuisen worden de regel gehanteerd: Contacten niet aanwezig in het Person object
           maar wel in ReCreateX, worden verwijderd in ReCreateX. (Anders worden bestaande
           contacten, niet aanwezig in het Person object ongemoeid gelaten).
          Combinaties van beide instellingen zijn mogelijk.
Naam                    Type                        Omschrijving                                  Opmerkingen
                                                                                                                54
Person                  Person                      De input : Person object met een lijst van
                                                    de bij te werken Contacten (Nieuwe en
                                                    bestaande).
UpdateExisting          Bool                        Bestaande contacten worden bijgewerkt.
Contacts
CleanupExisting         Bool                        Ontbrekende bestaande contacten
Contacts                                            worden opgekuist.


7.7.1.1      Person
Zie 48


7.7.2      Response
Het response zal een SavePersonResult object weergeven (Alhoewel alleen de contacten worden
upgedate)
Naam                    Type                        Omschrijving                                  Opmerkingen

Person                  Person                      De output : Person object met een lijst van
                                                    de bijgewerkte Contacten.
ValidationResults       List<ValidationResult>      Lijst met eventuele validatie fouten.


7.7.2.1      Person
Zie 48


7.7.2.2      ValidationResult
Zie 53




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
7.8       SAVEPERSONPRICEGROUPS
7.8.1      Request
De Request bestaat uit een Service Context en een Person object. Belangrijk hierin is dat de
PriceGroups binnen de PersonSettings object correct meegegeven worden.


7.8.2      Response
De response zal een SavePersonResult object teruggeven. Dit object bevat het Person object en
eventuele ValidationResults die aangeven wat er fout gelopen is.
Voor de SavePersonPriceGroups zijn volgende testen actief:
          PersonPriceGroup met een geldige Pricegroep (Id) bevatten
          Het type van de prijsgroep moet geldig zijn binnen het type van de PersonPriceGroup
          De combinatie type, startdatum, einddatum, van, tot en dag van de week moet uniek zijn


                                                                                                                    55
7.9       SAVEPERSONRELATION
7.9.1      Request
De Request bestaat uit de Service Context, 2 verschillende Ids van personen, het type relatie en extra
commentaar.
Naam                    Type                        Omschrijving                               Opmerkingen

PersonId1               Guid                        ID van de hoofdpersoon.
PersonId2               Guid                        ID van de gerelateerde persoon.
Comment                 String                      Extra commentaar betreffende de relatie
                                                    tussen beide personen.
RelationType            RelationType?               Geeft aan om welk type relatie het gaat:
                                                        -   Unknown
                                                        -   Household (=gezin)
                                                        -   Family (=familie)
                                                        -   Business (=bedrijfsrelatie)


7.9.2      Response
De response bevat een ValidationResult object. Dit object ziet er als volgt uit.
Naam                    Type                        Omschrijving                               Opmerkingen

BrokenRuleName          String                      Naam van de validatie regel.
Message                 String                      Foutboodschap.
IsValid                 Bool                        Regel is succesvol verwerkt.               Wanneer dit
                                                                                               false is, bevatten
                                                                                               de overige
                                                                                               properties
                                                                                               verdere details.



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
7.10     DELETEPERSONRELATION
7.10.1     Request
De Request bestaat uit de Service Context en de unieke Id van de relatie die via de FindPerson
methode kan bekomen worden.
Naam                    Type                        Omschrijving                                   Opmerkingen

RelationId              Guid                        ID van de relatie.


7.10.2     Response
De response bevat een ValidationResult object. Dit object ziet er als volgt uit.
Naam                    Type                        Omschrijving                                   Opmerkingen

BrokenRuleName          String                      Naam van de validatie regel.
Message                 String                      Foutboodschap.
IsValid                 Bool                        Regel is succesvol verwerkt.                   Wanneer dit
                                                                                                                        56
                                                                                                   false is, bevatten
                                                                                                   de overige
                                                                                                   properties
                                                                                                   verdere details.


7.11     FINDPERSON
7.11.1     Request
De Request bestaat uit een Service Context, een FindPersonsCriteria object.
De gebruikte eigenschappen voor een FindPersonsCriteria object zien er als volgt uit.


7.11.1.1     FindPersonsCriteria
Naam                    Type                        Omschrijving                                   Opmerkingen

ActivationID            Guid?                       ID om de user account te activeren.            Wordt nog niet
                                                                                                   gebruikt.
Id                      Guid?                       Het unieke Id van de gebruiker die je wil      Nullable, niet
                                                    zoeken.                                        verplicht.
UserName                String                      De gebruikersnaam van de gebruiker die je      Niet verplicht.
                                                    wil zoeken.
                                                    Dit is de zelfde UserName uit het Credential
                                                    object.
Paging                  PagingCriteria              Zie 4.2 Paging Criteria
Email                   String                      Het emailadres van de persoon die je wil
                                                    zoeken.
Includes                PersonIncludes              Bepaalt welke delen van de persoon mee
                                                    opgehaald zullen worden.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
IsBlocked                Boolean                        Bepaalt of geblokkeerde personen moeten
                                                        worden opgehaald.
NationalNumber           String                         Bevolkings register nummer van de
                                                        gebruiker die je wil zoeken.
ResetPasswordID          Guid?                          De unieke code om een passwoord reset uit
                                                        te voeren, waarop je wenst te zoeken.
LessonGroupId            Guid?                          Indien ingevuld worden de leerlingen van
                                                        deze lesgroep opgehaald.
IncludeImage             Bool?                          Indien true wordt de afbeelding opgehaald.
Name                     String                         Alle personen waar het ingegeven gedeelte
                                                        in hun familienaam voorkomt worden
                                                        opgehaald.
FirstName                String                         Alle personen waar het ingegeven gedeelte
                                                                                                                    57
                                                        in hun voornaam voorkomt worden
                                                        opgehaald.


7.11.1.2     PersonIncludes
Dit object laat toe om bepaalde delen van een person al dan niet op te halen.
Naam                    Type                            Omschrijving                                  Opmerkingen

Categories              Bool                            Haalt de Subcategory van een persoon op.
PriceGroups             Bool                            Haalt de prijsgroepen van een persoon op.
PersonLLVInfos          Bool                            Haalt de specifieke lesgroep info op van de
                                                        persoon op.
PersonLLVTransf         Bool                            Haalt de LLV transferhistoriek op van een
erHistories                                             persoon.
PersonLLVCurren         Bool                            Haalt de huidige lesgroepen op van een
tLessonGroups                                           persoon.
Relations               Bool                            Haalt alle relaties op van een persoon op.
ChildCareInfo           Bool                            Haalt extra info betreffende buitenschoolse
                                                        kinderopvang op .


7.11.2     Response
De response geeft een lijst van Person objecten terug die voldoen aan de FindPersonsCriteria.


7.12     FORGOTPASSWORD
7.12.1     Request
De Request bestaat uit een Service Context en de login van de gebruiker.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
7.12.2     Response
De response is een ForgotPasswordResponse die bestaat uit een EmailAddress en een Password.
Naam                    Type                            Omschrijving                          Opmerkingen

EmailAddress            String                          Het emailadres van de gebruiker.


Password                String                          Het passwoord van de gebruiker.



7.13      FINDPERSONDELIVERYADDRESSES
Deze methode wordt gebruikt voor het ophalen van afleveradressen (al dan niet voor een bepaalde
klant).


7.13.1     Request
De Request bestaat uit een Service Context en een DeliveryAddressSearchCriteria object.                          58
De gebruikte eigenschappen voor een DeliveryAddressSearchCriteria object zien er als volgt uit.


Naam                     Type                           Omschrijving                          Opmerkingen

Id                       Guid?                          Unieke ID van het afleveradres.       Nullable, niet
                                                                                              verplicht.
PersonId                 Guid?                          ID van de persoon.                    Nullable, niet
                                                                                              verplicht.
Paging                   PagingCriteria                 Zie 4.2 Paging Criteria


7.13.2     Response
De response geeft een lijst van DeliveryAddress objecten terug die voldoen aan de opgegeven criteria.
Dit object ziet er als volgt uit:


Naam                     Type                           Omschrijving                          Opmerkingen

Id                       Guid                           Unieke ID van het afleveradres.
PersonId                 Guid                           ID van de persoon behorende bij het
                                                        afleveradres.
Description              String                         Omschrijving van het afleveradres.
Address                  Address                        Details van de adresgegevens          Zie 7.6.1.3 voor
                                                                                              details
                                                                                              betreffende het
                                                                                              Address object




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
7.14     DELETEPERSONDELIVERYADDRESS
Deze methode wordt gebruikt voor het verwijderen van een afleveradres.


7.14.1     Request
De Request bestaat uit een Service Context en de unieke ID van het te verwijderen object.


Naam                    Type                        Omschrijving                               Opmerkingen

RelationId              Guid                        ID van de relatie.




7.14.2     Response
De response bevat een ValidationResult object. Dit object ziet er als volgt uit.


Naam                    Type                           Omschrijving                            Opmerkingen       59

BrokenRuleName          String                         De code van de foutmelding.
Message                 String                         De standaard foutmelding.
IsValid                 Bool                           Geeft weer of dit een geldig
                                                       ValidationResult is.




7.15     SAVEPERSONDELIVERYADDRESS
Deze methode wordt gebruikt voor het opslaan van een nieuw afleveradres of voor het wijzigen van
een bestaand afleveradres.


7.15.1     Request
De Request bestaat uit de Service Context, een DeliveryAddress object en een CreateInvalidZipcodes
object (bool).


Naam                    Type                        Omschrijving                               Opmerkingen

DeliveryAddress         DeliveryAddress             Details van de adresgegevens die moeten    Zie 7.13.2 voor
                                                    opgeslagen worden                          verdere details
                                                                                               betreffende dit
                                                                                               object
CreateInvalidZipc       Bool                        Geeft aan indien ongeldige zipcodes
odes                                                (zipcodes die niet in ReCreateX bestaan)
                                                    mogen gecreëerd worden




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
7.15.2     Response
De response zal een SavePersonDeliveryAddressResult object teruggeven. Dit object bevat het
DeliveryAddress object en eventuele ValidationResults die aangeven wat er fout gelopen is.


7.15.2.1     SavePersonDeliveryAddressResult
Naam                    Type                           Omschrijving                              Opmerkingen

DeliveryAddress         DeliveryAddress                Het gemanipuleerde of nieuwe              Zie 7.13.2 voor
                                                       DeliveryAddress object.                   verdere details
                                                                                                 betreffende dit
                                                                                                 object
ValidationResults       List<ValidationResult>


7.15.2.2     ValidationResult
                                                                                                                   60
Naam                    Type                           Omschrijving                              Opmerkingen

BrokenRuleName          String                         De code van de foutmelding.
Message                 String                         De standaard foutmelding.
IsValid                 Bool                           Geeft weer of dit een geldig
                                                       ValidationResult is.


7.16      GETPERSONCHIPKNIP
Deze methode wordt gebruikt voor het ophalen van de geldbeugel (en eventueel zijn historiek) van
een bepaalde persoon.


7.16.1     Request
De Request bestaat uit de Service Context en een PersonChipKnipSearchCriteria object.
Naam                    Type                        Omschrijving                                 Opmerkingen

PersonId                Guid                        ID van de persoon voor wie je de
                                                    geldbeugelgegevens wenst op te halen
Paging                  PagingCriteria              Zie 4.2 Paging Criteria
Includes                PersonChipKnipIn            Bepaalt welke delen van de gegevens mee
                        cludes                      opgehaald zullen worden.


Het PersonChipKnipIncludes object ziet er als volgt uit:
Naam                    Type                        Omschrijving                                 Opmerkingen

History                 Bool                        Bepaalt indien de volledige historiek moet
                                                    worden meegenomen.


7.16.2     Response
De response zal een PersonChipKnip object teruggeven.


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Naam                    Type                           Omschrijving                                 Opmerkingen

PersonId                Guid                           Id van de persoon
Balance                 decimal                        Huidig saldo van de geldbeugel
History                 IList<PersonChipKn             Historisch overzicht van de geldbeugel
                        ipLine>                        transacties


Het PersonChipKnipLine object ziet er als volgt uit:
Naam                    Type                              Omschrijving                              Opmerkingen

Id                      Guid                              Unieke Id van de geldbeugel transactie
Date                    DateTime                          Datum en tijd van de transactie
Amount                  decimal                           Bedrag dat werd in rekening gebracht in
                                                          deze transactie (vb: +100 of -50)
Balance                 decimal                           Saldo na uitvoering van deze transactie                 61
                                                          (= geldbeugelsaldo op dat moment)


7.17      GETPERSONCREDITS
Deze methode wordt gebruikt voor het ophalen van de credits (en eventueel de historiek) van een
bepaalde persoon.


7.17.1     Request
De Request bestaat uit de Service Context en een PersonCreditsSearchCriteria object.
Naam                    Type                           Omschrijving                                 Opmerkingen

PersonId                Guid                           ID van de persoon voor wie je de credits
                                                       wenst op te halen
Paging                  PagingCriteria                 Zie 4.2 Paging Criteria
Includes                PersonCreditsInclu             Bepaalt welke delen van de gegevens mee
                        des                            opgehaald zullen worden.


Het PersonCreditsIncludes object ziet er als volgt uit:
Naam                    Type                           Omschrijving                                 Opmerkingen

History                 Bool                           Bepaalt indien de volledige historiek moet
                                                       worden meegenomen.


7.17.2     Response
De response zal een PersonCredits object teruggeven.
Naam                    Type                           Omschrijving                                 Opmerkingen

PersonId                Guid                           Id van de persoon
Balance                 Int                            Huidig saldo van de credits



Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
History                 IList<PersonCreditL            Historisch overzicht van de credits
                        ine>


Het PersonChipKnipLine object ziet er als volgt uit:
Naam                    Type                              Omschrijving                              Opmerkingen

Id                      Guid                              Unieke Id van de credits transactie
Date                    DateTime                          Datum en tijd van de transactie
Amount                  Int                               Bedrag dat werd in rekening gebracht in
                                                          deze transactie (vb: +10 of -5)
Balance                 Int                               Saldo na uitvoering van deze transactie
                                                          (= creditssaldo op dat moment)



                                                                                                                  62




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
8         Module Leerlingenvolgsysteem (vanaf RCX 5.0.5)
8.1       BEKNOPT OVERZICHT
Via de webshop is het nu mogelijk om het leerlingenvolgsysteem (LLV) te gebruiken.
Er zijn 3 grote luiken in het systeem, namelijk :
          Het opvragen van LLV-informatie (voorzien voor website)
                o       Algemeen
                                 FindPersons met Include PersonLLVCurrentLessonGroups (ophalen van de
                                  huidige lesgroepen van een persoon, zie FindPersonsCriteria)
                                 ListLessonGroups (ophalen van de (voorkeur)lesgroepen)
                o       Aanwezigheden
                                 ListAbsentReasons (lijst van redenen voor afwezigheid)
                                 ListStudentPresences (overzicht aanwezigheden)
                o       Scores                                                                                 63

                                 ListNorms (lijst van de normen waarop scores behaald worden)
                                 ListStudentFollowScores (overzicht scores)
          Inschrijven op wachtlijsten
                o       ListWaitingLists (ophalen van de wachtlijsten)
                o       ListSwimmingLevels (ophalen van de toegestaan zwemniveau’s)
           De werking is als volgt :
                        1.   Persoon kiest een wachtlijst uit een lijst
                        2.   Persoon kiest zijn voorkeurlesgroepen + prioriteit
                        3.   Persoon logt in en betaalt
           Het verdere beheer van wachtlijsten en lesgroepen gebeurt in ReCreateX.
          Het ingeven en opslaan van LLV-informatie (voor onze eigen tablet-toepassing)
                o       SaveLLVInfoToDB (opslaan van aangepaste aanwezigheden/scores)
                o       SaveStudentTransfer (overplaatsen van leerlingen over lesgroepen)
                o       LLVMessageTranslations (specifieke vertalingen voor Tablet-toepassing)


8.2       LISTLESSONGROUPS
Deze service is geeft een lijst met Lesgroepen terug.


8.2.1      Request
De request bestaat uit de Service Context en een LessonGroupSearchCriteria object.
Dit criteria bevat een object om de paging te kunnen verzorgen bij lange lijsten en eventueel een
wachtlijstid om enkel de voorkeurlesgroepen van een bepaalde wachtlijst op te vragen.


8.2.1.1      LessonGroupSearchCriteria
Naam                                 Type                    Omschrijving                        Opmerkingen
Paging                               PagingCriteria          Zie 4.2 Paging Criteria



Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
WaitingListId                Guid?                Indien ingevuld: Enkel lesgroepen ophalen     Optioneel
                                                  die ingesteld staan als mogelijke
                                                  voorkeurlesgroep van de wachtlijst.
IncludeNorms                 Boolean?             Lijst van gekoppelde Normen weergeven.
IncludeInstructors           Bool?                Lijst van instructeurs toevoegen
PersonId                     Guid?                Enkel de lesgroepen ophalen waar deze                  .
                                                  persoon op ingeschreven is/was.
                                                  <StillInLessonGroup> geeft aan of de
                                                  persoon nog in lesgroep zit
EmployeeId                   Guid?                Enkel de lesgroepen ophalen waar deze
                                                  werkenemer instructeur van is.


8.2.2      Response
De response zal een lijst van Lesgroepen (List<LessonGroup>) bevatten.
                                                                                                                   64
Naam                         Type                 Omschrijving                                  Opmerkingen
Id                           Guid                 Id van de lesgroep.
ShortName                    String               Korte code van de lesgroep.
Description                  String               Omschrijving van de lesgroep.
Comment                      String               Commentaar over de lesgroep.
FullName                     String               Volledige naam opgebouwd uit code en
                                                  omschrijving.
Priority                     integer              Prioriteit van de voorkeurlesgroep.           Intieel altijd 0
                                                                                                Toegelaten
                                                                                                waarde 0 tm 9.
DivisionId                   Guid                 Id van de divisie waartoe de lesgroep
                                                  behoort.
DefaultNumberOfLessons       int                  Vooropgesteld aantal lessen in de lesgroep,
                                                  0 = niet ingegeven.
FromDate                     dateTime             Begindatum periode.                           Niet verplicht.
ToDate                       datetime             Einddatum periode.                            Niet verplicht.
LessonGroupNorms             List<Norms>          Lijst van de gekoppelde normen .
EntryDate                    DateTime             Datum inschrijving op lesgroep. Enkel van
                                                  toepassing indien opgevraagd via
                                                  FindPerson met Include
                                                  PersonLLVCurrentLessonGroups.
StillInLessonGroup           Bool                 Datum inschrijven op lesgroep. Enkel van
                                                  toepassing indien opgevraagd via
                                                  FindPerson met Include
                                                  PersonLLVCurrentLessonGroups.
LessonGroupInstructors       List<Employee>       Lijst van instructeurs per lesgroep
                                                  weergeven.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
8.3       LISTABSENTREASONS


Deze operatie geeft alle redenen voor afwezigheid terug zoals gedefinieerd binnen ReCreateX.


8.3.1      Request
De Request bestaat uit de Id van de divisie.
Name                      Type                     Omschrijving                          Opmerkingen
DivisionId                Guid                     De unieke Id van de divisie.


8.3.1.1      AbsentReasonSearchCriteria
Voorlopig nog niet geïmplementeeerd


8.3.2      Response
De Response geeft een lijst van AbsentReason objecten terug. Het AbsentReason object kan aanzien                         65
worden als een eenvoudige versie van het Reason object binnen ReCreateX.
Name                      Type                     Omschrijving                          Opmerkingen
Id                        Guid                     De unieke Id van de reden.
ShortName                 String                   De unieke code van de reden.
Description               String                   De omschrijving van de reden.


8.4       LISTSTUDENTPRESENCES
Deze operatie haalt de aanwezig-/afwezigheidsinfo op van de leerlingen, en dit per leerling (historiek)
of per dag (alle leerlingen).


8.4.1      Request
De request bestaat uit de Service Context en een StudentPresenceSearchCriteria object.


8.4.1.1      StudentPresenceSearchCriteria
Naam                      Type                     Omschrijving                                        Opmerkingen
LessonGroupId             Guid                     Id van de lesgroep waarvoor de aanwezigheden        Verplicht.
                                                   moeten worden opgehaald.
AddressId                 Guid?                    Id van de persoon waarvoor de aanwezigheden         Indien ingevuld
                                                   moeten worden opgehaald. => historiek               wordt
                                                                                                       SelectedDateTi
                                                                                                       me
                                                                                                       genegeerd.
SelectedDateTime          DateTime?                Datum van de aanwezigheden. Indien AddressId niet
                                                   ingevuld wordt er een overzicht gegeven van alle
                                                   leerlingen van de lesgroep op deze dag.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
8.4.2      Response
De Response geeft een lijst van StudentPresence objecten terug. Het StudentPresence object kan
aanzien worden als een eenvoudige versie van het StudentFollowPresent object binnen ReCreateX.

Name                         Type                 Omschrijving                         Opmerkingen
Id                           Guid                 Een unieke Id.
AddressId                    Guid                 De unieke Id van de leerling.        Verwijst naar het Person object.
Name                         String               De naam van de leerling.
FirstName                    String               De voornaam van de leerling.
MiddleName                   String               De tussennaam van de leerling.
PresentAccessControl         Boolean              Geeft aan of de leerling deze dag
                                                  binnen is gegaan via de
                                                  toegangscontrole.
HasSwimmingComment           Boolean              Geeft aan of er extra opmerking
                                                  werd ingegeven voor deze leerling.
                                                                                                                          66
Present                      Boolean              Aanwezigheid geregistreerd op deze
                                                  dag.
ReasonId                     Guid                 Id van de reden waarom de leerling   Verwijst naar het AbsentReason
                                                  afwezig is.                          object.
LessonGroupId                Guid                 Id van de lesgroep.                  Verwijst naar het LessonGroup
                                                                                       object.
Date                         DateTime             Datum van de registratie.


8.5       LISTNORMS
Deze operatie haalt de verschillende normen op per lesgroep, dit zijn de criteria waarvoor een kind
moet slagen in een lesgroep.


8.5.1      Request
De request bestaat uit de Service Context en een NormSearchCriteria object.


8.5.1.1      NormSearchCriteria
Name                     Type                     Omschrijving                         Opmerkingen
LessonGroupId            Guid                     De unieke Id van een lesgroep.


8.5.2      Response
De Response geeft een lijst van Norm objecten terug. Het Norm object kan aanzien worden als een
eenvoudige versie van het SwimmingLevelNorm object binnen ReCreateX.
Name                     Type                     Omschrijving                         Opmerkingen
Id                       Guid                     De unieke Id van de norm.
ShortName                String                   De unieke code van de norm.
Description              String                   De omschrijving van de norm.
Comment                  String                   Commentaar van de norm.



Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
8.6       LISTSTUDENTFOLLOWSCORES
Deze operatie haalt de scores die de leerlingen behaalden op de verschillende normen binnen een
lesgroep, en dit per leerling (historiek) of per dag (alle leerlingen).


8.6.1      Request
De request bestaat uit de Service Context en een StudentFollowScoreSearchCriteria object.


8.6.1.1      StudentFollowScoreSearchCriteria
Naam                      Type                     Omschrijving                                               Opmerkingen
LessonGroupId             Guid                     Id van de lesgroep waarvoor de aanwezigheden               Verplicht.
                                                   moeten worden opgehaald.
AddressId                 Guid?                    Id van de persoon waarvoor de aanwezigheden                Indien ingevuld   67
                                                   moeten worden opgehaald. => overzicht per dag              wordt
                                                                                                              SelectedDateTi
                                                                                                              me
                                                                                                              genegeerd.
SelectedDateTime          DateTime?                Datum van de scores. Indien AddressId niet ingevuld
                                                   wordt er een overzicht gegeven van alle leerlingen
                                                   van de lesgroep op deze dag.
PreviousScore             Boolean?                 Indien true krijg je in de plaats van de scores voor       Werkt enkel
                                                   vandaag de laatste scores ooit behaald per norm            indien geen
                                                   per leerling tot op vandaag.                               AddressId is
                                                                                                              opgegeven


8.6.2      Response
De Response geeft een lijst van StudentFollowScore objecten terug. Het StudentFollowScore object kan
aanzien worden als een eenvoudige versie van het StudentFollow object binnen ReCreateX.

Name                          Type                 Omschrijving                              Opmerkingen
Id                            Guid                 Een unieke Id.
AddressId                     Guid                 De unieke Id van de leerling.
LessonGroupId                 Guid                 Id van de lesgroep.                       Verwijst naar het LessonGroup
                                                                                             object.
Name                          String               De naam van de leerling.
FirstName                     String               De voornaam van de leerling.
MiddleName                    String               De tussennaam van de leerling.
Date                          DateTime             Datum van de registratie.                 Hier zal deze datum altijd
                                                                                             dezelfde zijn.
Norm1                         int                  Geeft de score aan die de leerling        Het aantal normen kan
                                                   behaalde op de    1ste   norm van de      verschillen per lesgroep,
                                                   lesgroep.                                 daarom werden er default 20


Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
Norm2                            int                  Geeft de score aan die de leerling          voorzien. Aan de hand van
                                                      behaalde op de 2de norm van de              ListNorms kan het correcte
                                                      lesgroep.                                   aantal en de naamgeving
…                                int                  Geeft de score aan die de leerling          opgehaald worden. In beide
                                                      behaalde op de …ste norm van de             methodes worden de normen
                                                      lesgroep.                                   alfabetisch volgens ShortName

Norm20                           int                  Geeft de score aan die de leerling          opgehaald.

                                                      behaalde op de   20ste   norm van de        0 = niets

                                                      lesgroep.                                   1 = onvoldoende
                                                                                                  2 = bijna voldoende
                                                                                                  3 = voldoende




8.7       LISTWAITINGLISTS
                                                                                                                                     68
Deze service is geeft een lijst met Wachtlijsten terug waar er een geldig ‘prijsartikel web’ aan gekoppeld
werd.


8.7.1      Request
De request bestaat uit de Service Context en een WaitingListSearchCriteria object.

8.7.1.1      WaitingListSearchCriteria
Naam                             Type                         Omschrijving                                        Opmerkingen
Paging                           PagingCriteria               Zie 4.2 Paging Criteria
PersonId                         Guid?                        Haalt alle wachtlijsten op waar deze                Niet verplicht
                                                              persoon reeds voor is ingeschreven.


8.7.2      Response
De response zal een lijst van Wachtlijsten (List<WaitingList>) bevatten.
Naam                             Type                         Omschrijving                                        Opmerkingen
Id                               Guid                         Id van de wachtlijst.
ShortName                        String                       Korte code van de wachtlijst.
Description                      String                       Omschrijving van de wachtlijst.
Comment                          String                       Commentaar over de wachtlijst.
WebPriceItemId                   Guid                         Id van het prijsartikel.                            Verwijst naar
                                                                                                                  het Article
                                                                                                                  object.
Price                            Decimal                      Prijs btw inclusief van het prijsartikel.
WaitingListLessonGroups          List <LessonGroup>           Lijst van de mogelijke voorkeurlesgroepen.
WaitingListSwimmingLevels        List <SwimmingLevel>         Lijst van de toegelaten zwemniveaus.                Indien leeg =>
                                                                                                                  alle niveau’s
                                                                                                                  zijn toegelaten.
MaxStudent                       integer                      Maximaal aantal toegelaten leerlingen in            Indien 0 =>


Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
                                                     de wachtlijst.                               onbeperkt.
NumberOfStudents             interger                Aantal leerlingen in de wachtlijst.
MaxDuration                  Integer                 Maximale wachttijd in de wachtlijst.


8.8       LISTSWIMMINGLEVELS
Deze service is geeft een lijst met Zwemniveau’s terug.


8.8.1      Request
De request bestaat uit de Service Context en een SwimmingLevelSearchCriteria object.



8.8.1.1      SwimmingLevelSearchCriteria
Naam                         Type                    Omschrijving                                 Opmerkingen
Paging                       PagingCriteria          Zie 4.2 Paging Criteria
WaitingListId                Guid?                   Indien ingevuld: Enkel de zwemniveaus                      69
                                                     ophalen die ingesteld staan als toegelaten
                                                     zwemniveau van de wachtlijst.


8.8.2      Response
De response zal een lijst van Lesgroepen (List<LessonGroup>) bevatten.
Naam                         Type                    Omschrijving                                 Opmerkingen
Id                           Guid                    Id van het zwemniveau.
ShortName                    String                  Korte code van het zwemniveau.
Description                  String                  Omschrijving van het zwemniveau.
Comment                      String                  Commentaar over het zwemniveau.




8.9       SAVELLVINFOTODB
Deze operatie wordt gebruikt om ingegeven scores en aanwezigheden op te slaan in de ReCreateX-
database => uit te voeren per lesgroep.


8.9.1      Request
De Request bestaat uit een Service Context, een StudentPresence object, een StudentFollowScore
object, een Norm-object en een Person object.
In de tablet toepassing wordt de Save uitgevoerd bij het veranderen van lesgroep, bij het klikken op de
opslaan knop en bij het afsluiten van het programma.
Naam                     Type                        Omschrijving                                 Opmerkingen
studentPresences         List <StudentPresence>      Lijst van de te bewaren
                                                     aanwezigheidsregistraties.
studentFollowScores      List <StudentFollowScore>   Lijst van de te bewaren scores.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
norms                      List <Norms>                     Lijst van Norms van de lesgroep waarvoor er
                                                            opgeslagen wordt.
students                   List <Person>                    Lijst van personen waarvoor hun zwemles-
                                                            commentaar veld aangepast werd.
                                                            (SwimmingComment).


8.9.2      Response
De response is gewoon een boolean.


8.10     SAVESTUDENTTRANSFER
Deze operatie wordt gebruikt om leerlingen te transferen van de ene lesgroep naar een andere.


8.10.1     Request
De Request bestaat uit een Service Context, een Person object, twee LessonGroup objecten en een
                                                                                                                        70
integer.
Naam                     Type                   Omschrijving                                              Opmerkingen
Person                   Person                 Person-object die getransfereerd moet worden.
FromLessonGroup          LessonGroup            Bron lesgroep.
ToLessonGroup            LessonGroup            Bestemming lesgroep.
OverruleWarnings         int                    Geeft aan warnings mogen overruled worden.
                                                0 = geen overrule
                                                1 = overrule aantal plaatsen
                                                2 = bovenstaande + overrule toegelaten zwemniveaus
                                                3 = bovenstaande + overrule minimum leeftijd


8.10.2     Response
De Response bstaat uit een StudentFollowTransferFeedback.
Dit is een enum :       0 = Ok
                        1 = Error
                        2 = GroupFull  groep volzet, transfer mislukt
                        3 = AskOverRuleGroupFull  groep volzet maar overrule mogelijk
                        4 = AskSwimmingLevelInvalid  verkeerd niveau overrule mogelijk
                        5 = AskMinAge  verkeerde leeftijd overrule mogelijk




8.11     LLVMESSAGETRANSLATIONS
Deze operatie haalt alle specifieke vertalingen op voor onze Tablet toepassing (TabletLLV))


8.11.1     Request
De Request bestaat uit de Id van de divisie.
Name                     Type                   Omschrijving                              Opmerkingen


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
DivisionId                     Guid                   De unieke Id van de divisie.


8.11.2     Response
De Response geeft een lijst van LLVMessageTranslation objecten terug.
Name                           Type                   Omschrijving                                 Opmerkingen
Id                             Guid                   De unieke Id van de vetaling.
Message                        String                 De naam van de te vertalen melding.
LanguageId                     String                 Unieke code van de taal.
Body                           String                 De vertaalde melding.




8.12     GETPERSONLLVINFOBYLESSONGROUP
Deze service is geeft specifieke zwemles – informatie van een persoon op een lesgroep terug .
                                                                                                                                 71
8.12.1     Request
De request bestaat uit de Service Context en een PersonLLVInfoSearchCriteria object.

8.12.1.1     PersonLLVInfoSearchCriteria
Naam                    Type            Omschrijving                             Opmerkingen
LessonGroupId           Guid            Id van de lesgroep waarvoor
                                        men de informatie wil ophalen
PersonId                Guid?           Id van de persoon waarvoor men           Indien leeg wordt de info van alle studenten
                                        de informatie wil ophalen                binnen de lesgroep opgehaald


8.12.2     Response
De response zal een PersonLLVInfo object teruggeven.
Zie 7.6.1.6 PersonLLVInfo.




8.13     LISTSWIMMINGDIPLOMAS
Deze operatie haalt een lijst van zwemdiploma’s op.


8.13.1     Request
De request bestaat uit de Service Context en een SwimmingDiplomaSearchCriteria object. Het is
mogelijk om een volledige lijst van zwemdiploma’s op te halen of enkel de behaalde diploma’s door
een bepaalde persoon.


8.13.1.1     SwimmingDiplomaSearchCriteria
Name                             Type                     Omschrijving                             Opmerkingen
PersonId                         Guid                     De unieke Id van een persoon.            Bij niet ingevulde PersonId



Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
                                                                                               wordt een volledige lijst
                                                                                               weergegeven, andere enkel
                                                                                               de behaalde diploma’s


8.13.2     Response
De Response geeft een lijst van SwimmingDiploma objecten terug. Het SwimmingDiploma object kan
aanzien worden als een eenvoudige versie van het SwimmingDiploma object binnen ReCreateX.
Name                      Type                     Omschrijving                                        Opmerkingen
Id                        Guid                     De unieke Id van het zwemdiploma.
ShortName                 String                   De unieke code van het zwemdiploma.
Description               String                   De omschrijving van het zwemdiploma.
Comment                   String                   Commentaar van het zwemdiploma.



                                                                                                                              72
8.14     FINDWAITINGLISTSTUDENTOVERVIEW
Deze service is geeft een lijst met WaitingListStudent-objecten terug, dit zijn de wachtlijsten waar een
bepaalde persoon op inschreven is.


8.14.1     Request
De request bestaat uit de Service Context en een WaitingListStudentSearchCriteria object.

8.14.1.1     WaitingListStudentSearchCriteria
Naam                          Type                         Omschrijving                                         Opmerkingen
PersonId                      Guid                         Haalt alle wachtlijsten op waar deze                 Verplicht
                                                           persoon reeds voor is ingeschreven met de
                                                           inschrijvingsdatum. WaitingListStudent-
                                                           object


8.14.2     Response
De response zal een lijst van wachtlijststudenten (List<WaitingListStudent>) bevatten.
Naam                          Type                         Omschrijving                                         Opmerkingen
Id                            Guid                         Id van de wachtlijststudent.
WaitingListId                 Guid                         Id van de wachtlijst.
EntryDate                     DateTime                     Inschrijvingsdatum op de wachtlijst
WaitingListCode               String                       Korte code van de wachtlijst.
WaitingListDescription        String                       Omschrijving van de wachtlijst
Price                         Decimal                      Prijs btw inclusief van het prijsartikel,
                                                           gekoppeld aan een wachtlijst.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
8.15     DELETEWAITINGLISTSTUDENT
Deze service verwijdert een WaitingListStudent (leerling in wachtlijst).


8.15.1     Request
De request bestaat uit de Service Context en een Guid, de Id van de WaitingListStudent :
WaitingListStudentId.

8.15.2     Response
De response is gewoon een boolean.




                                                                                           73




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
9         Module Fitness (vanaf RCX 5.0.5)
9.1       BEKNOPT OVERZICHT
Via de webshop is het nu mogelijk om in te schrijven op fitness/wellness activiteiten.
De werking is als volgt :
          Persoon logt in als member (via gekende gebruikersnaam en wachtwoord) of als non-member
           (anoniem)
          Persoon kiest zijn klantenkaart en abonnement die hij wenst te gebruiken
          Persoon kiest zijn fitness activiteit en periode waarvoor hij zich wenst in te schrijven.
          Persoon betaalt


Opgelet: Bij de fitness module is het noodzakelijk om vooraf in te loggen omdat de mogelijkheid ook
bestaat om anoniem in te schrijven.
                                                                                                                             74

Het verdere beheer van fitness activiteiten gebeurt in ReCreateX.


De web service methodes die hiervoor aangemaakt werden zijn de volgende :
          FindPersonCards (ophalen van de klantenkaarten)
          FindSubscriptions (ophalen van de abonnementen)
          GetFitnessNonMemberPerson (ophalen van non-member person)
          FindFitnessActivities (ophalen van de fitness activiteiten en dagen)
          FindFitnessActivityReservations (ophalen van de fitness reserveringen)
          ConfirmFitnessActivityReservation (bevestigen van één fitness reservering)
          CancelFitnessActivityReservation (annuleren van één fitness reservering)


Volgende web service methodes werden extra toegevoegd
          GetFitnessActivity(ophalen van één fitness activiteit)
          GetFitnessActivityReservation (ophalen van één fitness reservering)


9.2       FINDPERSONCARDS
Deze methode haalt alle klantenkaart op aan de hand van bepaalde zoekcriteria.


9.2.1      Request
De request bestaat uit de Service Context en een FindPersonCardsCriteria object.
Naam                    Type                            Omschrijving                                 Opmerkingen

Id                      Guid                            Id van een specifieke klantenkaart           Nullable (Indien niet
                                                        (Als u doelbewust 1 entiteit wil ophalen).   van toepassing).
Number                  String                          Kaartnummer van een specifieke               Nullable (Indien niet
                                                        klantenkaart (Als u doelbewust 1 entiteit    van toepassing).



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        wil ophalen).
PersonId                Guid                            Id van een ReCreateX Person waarvoor         Nullable (Indien niet
                                                        u klantenkaarten wilt vinden.                van toepassing).
Includes                PersonCardIncludes              Bepaalt welke data extra meekomt in
                                                        het response en/of welke extra records in
                                                        de returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria


Het PersonCardIncludes object kan worden opgebouwd met volgende criteria:
Naam                    Type                            Omschrijving                                 Opmerkingen

PersonDetails           Bool                            Ophalen van ReCreateX Person details         Zie 4.32.2 voor
                                                            -     JA = het volledige Person object   detail betreffende
                                                                  wordt terug gegeven                het Person object.      75
                                                            -     NEE = enkel de ID van de Person
                                                                  wordt terug gegeven


9.2.2      Response
De response zal een lijst van PersonCard objecten bevatten dat voldoet aan de criteria.
Het PersonCard object ziet er als volgt uit:
Naam                     Type                           Omschrijving                                 Opmerkingen

Id                       Guid                           Id van de klantenkaart.


Description              String                         Omschrijving van de klantenkaart.            Dit is in feite de
                                                                                                     omschrijving van
                                                                                                     het gekoppelde
                                                                                                     artikel.
PeripheralString         PeripheralString               Overeenkomstige PeripheralString             Bepaalt het type
                                                        object.                                      van de kaart.
CardNumber               String                         Volledige kaartnummer van de                 CompanyIdent +
                                                        klantenkaart.                                DivisionIdent +
                                                                                                     Number.
Number                   String                         Uniek kaartnummer van de klantenkaart        CardNumber –
                                                        voor een bepaalde divisie.                   CompanyIdent –
                                                                                                     DivisionIdent.
PersonId                 Guid                           Id van de persoon die de fitness
                                                        reservering doorvoerde.
Person                   Person                         Person object die de fitness reservering     Zie 4.32.2 voor
                                                        doorvoerde.                                  detail betreffende




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                                                                     het Person object.


Het PeripheralString object ziet er als volgt uit:
Naam                     Type                           Omschrijving                                 Opmerkingen

Id                       Guid                           Id van het type klantenkaart.


Code                     String                         Code van het type klantenkaart.
Description              String                         Omschrijving van het type klantenkaart.      Vb: MiFare –
                                                                                                     Barcode - …)


9.3     FINDSUBSCRIPTIONS
Deze methode haalt alle abonnementen op aan de hand van bepaalde zoekcriteria.


9.3.1      Request                                                                                                           76

De request bestaat uit de Service Context en een SubscriptionSearchCriteria object.
Naam                    Type                            Omschrijving                                 Opmerkingen

SubscriptionId          Guid                            Id van een specifiek abonnement              Nullable (Indien niet
                                                        (Als u doelbewust 1 entiteit wil ophalen).   van toepassing).
PersonId                Guid                            Id van de ReCreateX Person waarvoor je       Nullable (Indien niet
                                                        alle abonnementen wenst op te halen.         van toepassing).
PersonCardId            Guid                            Id van een ReCreateX PersonCard              Nullable (Indien niet
                                                        waaraan de abonnementen gekoppelt            van toepassing).
                                                        zijn.
CreatedFrom             DateTime                        Indien ingevuld: Enkel abonnmenten die
                                                        later gecreëerd zijn dan de opgegeven
                                                        datum zullen weergeven worden.
CreatedUntil            DateTime                        Indien ingevuld: Enkel abonnmenten die
                                                        vroeger gecreëerd zijn dan de
                                                        opgegeven datum zullen weergeven
                                                        worden.
Includes                SubscriptionIncludes            Bepaalt welke data extra meekomt in
                                                        het response en/of welke extra records in
                                                        de returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria


Het SubscriptionIncludes object kan worden opgebouwd met volgende criteria:
Naam                    Type                            Omschrijving                                 Opmerkingen

Inactive                Bool                            Inactieve abonnementen meenemen in




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        de response.
Invalid                 Bool                            Ongeldige abonnementen meenemen
                                                        in de response.


9.3.2      Response
De response zal een lijst van Subscription objecten bevatten dat voldoet aan de criteria.
Het Subscription object ziet er als volgt uit:
Naam                     Type                           Omschrijving                                  Opmerkingen

Id                       Guid                           Id van het abonnement.


CreationDate             DateTime                       Creatiedatum van het abonnement.
Article                  Article                        Het gekoppelde Article object.                Zie 4.3.2 voor details
                                                                                                      betreffende het
                                                                                                      Article object.          77

Active                   Bool                           Is het abonnement actief?
Valid                    Bool                           Is het abonnement momenteel geldig?


9.4       GETFITNESSNONMEMBERPERSON
Deze methode haalt het Person object op dat gebruikt wordt voor non-member of anonieme fitness
reserveringen. Door achter de schermen met deze persoon in te loggen kunnen non-member
reserveringen of anonieme reserveringen aangemaakt worden. Bij gebruik van non-member
reserveringen kan geen klantenkaart of abonnement doorgegeven worden.


9.4.1      Request
Deze request bevat geen specifieke parameters


9.4.2      Response
De response bevat een Person object. Dit object wordt gebruikt om in te loggen voor non-member
reserveringen. Zie 4.32.2 voor detail betreffende het Person object.


9.5       FINDFITNESSACTIVITIES
Deze methode haalt alle fitness activiteiten op aan de hand van bepaalde zoekcriteria.


9.5.1      Request
De request bestaat uit de Service Context en een FitnessActivitySearchCriteria object.
Naam                    Type                               Omschrijving                               Opmerkingen

FitnessActivityId       Guid                               Id van een specifieke fitness activiteit   Nullable (Indien niet
                                                           (Als u doelbewust 1 entiteit wil           van toepassing).
                                                           ophalen).




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
DescriptionPatte        String                             Naam of stuk van de omschrijving        Nullable (Indien niet
rn                                                         waarnaar gezocht kan worden. Voor       van toepassing).
                                                           gedeeltelijke matchen kan het %-
                                                           teken gebruikt worden.
                                                           Het %-teken kan zowel voor het
                                                           woord, na het woord als voor en
                                                           achter het woord voorkomen.
From                    DateTime                           Indien ingevuld: Enkel fitness
                                                           activiteiten die later starten dan de
                                                           opgegeven datum zullen weergeven
                                                           worden.
Until                   DateTime                           Indien ingevuld: Enkel fitness
                                                           activiteiten die vroeger starten dan
                                                                                                                           78
                                                           de opgegeven datum zullen
                                                           weergeven worden.
CardId                  Guid                               Klantenkaart die gebruikt wordt.        Nullable (Indien
                                                                                                   non-member).
SubscriptionId          Guid                               Abonnement dat gebruikt wordt           Nullable (Indien
                                                                                                   non-member).
Includes                FitnessActivityIncludes            Bepaalt welke data extra meekomt in
                                                           het response en/of welke extra
                                                           records in de returnset aanwezig
                                                           zullen zijn.
Paging                  PagingCriteria                     Zie 4.2 Paging Criteria


Het FitnessActivityIncludes object kan worden opgebouwd met volgende criteria:
Naam                    Type                            Omschrijving                               Opmerkingen

Price                   Bool                            Prijs van de fitness activiteitsdagen
                                                        meenemen in de response.
Days                    Bool                            Mogelijke inschrijvingsdagen meenemen      Reserveringen
                                                        in de response.                            gebeuren op
                                                                                                   activiteitsdagen.
Slots                   Bool                            Mogelijke inschrijvingsslots meenemen in   Indien dagen slots
                                                        de response.                               bevatten, moet je
                                                                                                   één of meerdere
                                                                                                   slots reserveren.
Image                   Bool                            Ophalen van de afbeelding of niet.
ImageUri                Bool                            Ophalen van de afbeeldingUri of niet.



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
9.5.2      Response
De response zal een lijst van FitnessActivity objecten bevatten dat voldoet aan de criteria.
Het FitnessActivity object ziet er als volgt uit:


Naam                    Type                               Omschrijving                                Opmerkingen

Id                      Guid                               Id van de fitness activiteit.


Code                    String                             Code van de fitness activiteit.
Description             String                             Omschrijving van de fitness activiteit.
Image                   Picture                            De afbeelding van de fitness activiteit.
ImageUrl                string                             De link waarop een image terug te
                                                           vinden is van de fitness activiteit.
Location                AddressLocation                    De locatie waar deze fitness activiteit
                                                                                                                             79
                                                           doorgaat.
Days                    List<FitnessActivityDay>           Lijst van dagen waarop je je kan
                                                           inschrijven voor deze fitness activiteit.
Color                   Color                              Kleur die wordt gebruikt voor het
                                                           weergeven van deze fitness activiteit.


Het AddressLocation object ziet er als volgt uit:
Naam                     Type                             Omschrijving                                 Opmerkingen

Id                       Guid                             Id van de locatie.
Code                     String                           Code van de locatie.
Name                     AddressName                      Naam van de locatie.
Address                  Address                          Adres van de locatie                         Zie 7.6.1.3 voor
                                                                                                       details betreffende
                                                                                                       het Address object


Het AddressName object ziet er als volgt uit:
Naam                     Type                             Omschrijving                                 Opmerkingen

First                    String                           Voornaam van de locatie.
Middle                   String                           Tussennaam van de locatie.
Last                     String                           Familienaam van de locatie.


Het FitnessActivityDay object ziet er als volgt uit:
Naam                             Type                     Omschrijving                                 Opmerkingen

Id                               Guid                     Id van de fitness activiteitsdag.




Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
From                           DateTime                 Startdatum en tijd van de fitness
                                                        activiteitsdag.
Until                          DateTime                 Startdatum en tijd van de fitness
                                                        activiteitsdag.
Price                          Decimal                  Prijs van de fitness activiteitsdag.            Kan verschillen voor
                                                                                                        members en non-
                                                                                                        members.
Slots                          List<FitnessActi         Lijst van slots waarop je je kan inschrijven.   Indien er slots zijn,
                               vityDaySlot>                                                             moet je er minstens
                                                                                                        één kiezen.
MaxReservations                Int                      Geeft het maximum aantal reserveringen
                                                        weer voor de activiteitsdag.
MaxReservationsNon             Int                      Geeft het maximum aantal non-
                                                                                                                                80
Member
                                                        member.reserveringen weer voor de
                                                        activiteitsdag.
CurrentReservations            Int                      Geeft het huidig aantal reserveringen           # Open
                                                        weer voor de activiteitsdag.                    reserveringen =
                                                                                                        MaxReservations -
                                                                                                        CurrentReservations
CurrentReservations            Int                      Geeft het huidig aantal reserveringen
Member
                                                        van leden weer voor de activiteitsdag.
CurrentReservationsN           Int                      Geeft het huidig aantal reserveringen
onMember
                                                        van niet-leden weer voor de
                                                        activiteitsdag.


Het FitnessActivityDaySlot object ziet er als volgt uit:
Naam                    Type                            Omschrijving                                    Opmerkingen

Id                      Guid                            Id van het slot van de fitness
                                                        activteitsdag.
Description             String                          Omschrijving van het slot.


Reserved                Bool                            Is dit slot reeds gereserveerd?


9.6     FINDFITNESSACTIVITYRESERVATIONS
Deze methode haalt alle fitness activiteiten op aan de hand van bepaalde zoekcriteria.


9.6.1      Request
De request bestaat uit de Service Context en een FitnessActivityReservationSearchCriteria object.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Naam                    Type                            Omschrijving                                   Opmerkingen

FitnessActivityD        Guid                            Id van een specifieke fitness reservering      Nullable (Indien niet
ayReservationId
                                                        (Als u doelbewust 1 entiteit wil ophalen).     van toepassing).

PersonId                Guid                            Id van de persoon waarvoor u de fitness        Nullable (Indien niet
                                                        reserveringen wenst op te lijsten.             van toepassing).
FitnessActivityD        Guid                            Id van de fitness activiteitsdag waarvoor      Nullable (Indien niet
ayId
                                                        u de fitness reserveringen wenst op te         van toepassing).
                                                        lijsten.
FitnessActivityId       Guid                            Id van de fitness activiteit waarvoor u de     Nullable (Indien niet
                                                        fitness reserveringen wenst op te lijsten.     van toepassing).
From                    DateTime                        Indien ingevuld: Enkel fitness
                                                        reserveringen die later gereserveerd
                                                        werden dan de opgegeven datum                                          81
                                                        zullen weergeven worden.
Until                   DateTime                        Indien ingevuld: Enkel fitness
                                                        reserveringen die vroeger gereserveerd
                                                        werden dan de opgegeven datum
                                                        zullen weergeven worden.
Includes                FitnessActivityReserv           Bepaalt welke data extra meekomt in
                        ationIncludes                   het response en/of welke extra records in
                                                        de returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria


Het FitnessActivityReservationIncludes object kan worden opgebouwd met volgende criteria:
Naam                    Type                            Omschrijving                                   Opmerkingen

Confirmed               Bool                            Bevestigde fitness reserveringen
                                                        meenemen in de response.
Canceled                Bool                            Geannuleerde fitness reserveringen
                                                        meenemen in de response.
PersonDetails           Bool                            Ophalen van ReCreateX Person details           Zie 4.32.2 voor
                                                             -     JA = het volledige Person object    detail betreffende
                                                                   wordt terug gegeven                 het Person object.
                                                             -     NEE = enkel de ID van de Person
                                                                   wordt terug gegeven
Slots                   Bool                            Ophalen van gereserveerde slots                Zie 4.32.2 voor
                                                             -     JA = alle gereserveerde slots van   detail betreffende
                                                                   de overeenkomstige reservering      het Person object.
                                                                   worden onder het


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                                 FitnessActivityDay object
                                                                 toegevoegd
                                                            -    NEE = FitnessActivityDay object
                                                                 wordt teruggegeven zonder
                                                                 details betreffende
                                                                 gereserveerde slots
Locations               Bool                            Bijhorende locaties meenemen in de         Zie 9.5.2 voor detail
                                                        response.                                  betreffende het
                                                                                                   AddressLocation
                                                                                                   object.
Image                   Bool                            Ophalen van de afbeelding of niet.
ImageUri                Bool                            Ophalen van de afbeeldingUri of niet.
WaitingList             Bool                            Ophalen van fitness reserveringen die in
                                                                                                                           82
                                                        de wachtlijst zitten.


9.6.2      Response
De response zal een lijst van FitnessActivityReservation objecten bevatten dat voldoet aan de criteria.
Het FitnessActivityReservation ziet er als volgt uit:
Naam                       Type                          Omschrijving                              Opmerkingen

Id                         Guid                          Id van de fitness reservering.


ReservationNumber          Int64                         Volgnummer van de fitness reservering.
ReservationDate            DateTime                      Datum van reservatie van de fitness
                                                         reservering.
ConfirmationDate           DateTime                      Datum van bevestiging van de fitness
                                                         reservering.
CancelationDate            DateTime                      Datum van annulatie van de fitness
                                                         reservering.
Status                     FitnessActivityRese           Dit is een enumeratie voor de status
                           rvationStatus                 van de fitness reservering:
                                                          - Reserved= 0
                                                          - Confirmed = 1
                                                          - Canceled = 2
NonMemberReseva            Bool                          Anonieme (non-member) fitness
tion
                                                         reservering of niet.
Warranty                   Decimal                       Waarborg dat werd afgenomen voor
                                                         de fitness reservering.
Credits                    Int                           Beurten die werden afgenomen voor
                                                         de fitness reservering.


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
LineAmount               Decimal                     Netto bedrag dat betaald werd bij de
                                                     fitness reservering.
VatAmount                Decimal                     BTW bedrag dat betaald werd bij de
                                                     fitness reservering.
Amount                   Decimal                     Totaal (bruto) bedrag dat betaald
                                                     werd bij de fitness reservering.
FitnessActivityDay       FitnessActivityDay          Fitness activiteitsdag waarop de fitness   Zie 7.4.2 voor detail
                                                     reservering werd doorgevoerd.              betreffende het
                                                                                                FitnessActivityDay
                                                                                                object.
FitnessActivity          FitnessActivity             Fitness activeit waarop de fitness         Zie 7.4.2 voor detail
                                                     reservering werd doorgevoerd.              betreffende het
                                                                                                FitnessActivity
                                                                                                                        83
                                                                                                object.
PersonId                 Guid                        Id van de persoon die de fitness
                                                     reservering doorvoerde.
Person                   Person                      Person object die de fitness reservering   Zie 4.32.2 voor
                                                     doorvoerde.                                detail betreffende
                                                                                                het Person object
WaitingList              Bool                        Geeft aan indien de reservering al dan
                                                     niet in de wachtlijst zit.


9.7     CONFIRMFITNESSACTIVITYRESERVATION
Deze methode wordt gebruikt voor het bevestigen van een fitness reservering.


9.7.1      Request
De request bestaat uit de Id (Id van de FitnessActivityReservation) die bevestigd dient te worden.
Naam                     Type                       Omschrijving                                Opmerkingen

FitnessActivityDayR      Guid                       Id van de fitness reservering die moet
eservationId                                        bevestigd worden.


9.7.2      Response
De response bevat een FitnessActivityReservationValidationResult object. Dit object bevat zowel
validatie data als het originele FitnessActivityReservation object.
Het FitnessActivityReservationValidationResult ziet er als volgt uti:
Naam                    Type                           Omschrijving                             Opmerkingen

BrokenRuleName          String                         De code van de foutmelding.
Message                 String                         De foutmelding.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
IsValid                 Bool                           Geeft weer of dit een geldig
                                                       ValidationResult is.
ValidatedFitnessA       FitnessActivityReserva         FitnessActivityReservation object dat
ctivityReservation      tion                           werd opgehaald aan de hand van
                                                       de meegegeven Id.


9.8     CANCELFITNESSACTIVITYRESERVATION
Deze methode wordt gebruikt voor het annuleren van een fitness reservering.


9.8.1      Request
De request bestaat uit de Id (Id van de FitnessActivityReservation) die geannuleerd dient te worden.
Naam                     Type                       Omschrijving                               Opmerkingen

FitnessActivityDayR      Guid                       Id van de fitness reservering die moet
                                                                                                             84
eservationId                                        geannuleerd worden.


9.8.2      Response
De response bevat een FitnessActivityReservationValidationResult object. Dit object bevat zowel
validatie data als het originele FitnessActivityReservation object.
Het FitnessActivityReservationValidationResult ziet er als volgt uti:
Naam                    Type                           Omschrijving                            Opmerkingen

BrokenRuleName          String                         De code van de foutmelding.
Message                 String                         De foutmelding.
IsValid                 Bool                           Geeft weer of dit een geldig
                                                       ValidationResult is.
ValidatedFitnessA       FitnessActivityReserva         FitnessActivityReservation object dat
ctivityReservation      tion                           werd opgehaald aan de hand van
                                                       de meegegeven Id.


9.9     GETFITNESSACTIVITY
Deze methode haalt de details op van één bepaalde FitnessActivity.


9.9.1      Request
De request bestaat uit de id van de fitness activiteit.
Naam                    Type                           Omschrijving                            Opmerkingen

FitnessActivityId       Guid                           Id van de fitness activiteit.


9.9.2      Response
De response geeft een FitnessActivity object terug.
Naam                    Type                           Omschrijving                            Opmerkingen



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
FitnessActivity         FitnessActivity             FitnessActivity object.              Zie 7.5.2 voor details
                                                                                         betreffende
                                                                                         FitnessActivity
                                                                                         object.


Deze response kan ook bekomen worden door via de methode FindFitnessActivities de Id van de fitness
activiteit op te geven en alle includes te activeren.


9.10     GETFITNESSACTIVITYRESERVATION
Deze methode haalt de details op van één bepaalde FitnessActivityReservation.


9.10.1     Request
De request bestaat uit de id van de fitness activiteit.
Naam                    Type                        Omschrijving                         Opmerkingen              85

FitnessActivityRes      Guid                        Id van de fitness reservering.
ervationId


9.10.2     Response
De response geeft een FitnessActivityReservation object terug.
Naam                    Type                        Omschrijving                         Opmerkingen

FitnessActivityRes      FitnessActivityReserva      FitnessActivityReservation object.   Zie 7.6.2 voor details
ervation                tion                                                             betreffende
                                                                                         FitnessActivityReserv
                                                                                         ation object.


Deze response kan ook bekomen worden door via de methode FindFitnessActivityReservations de Id
van de fitness reservering op te geven en alle includes te activeren.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
10 Module Exposities
10.1     BEKNOPT OVERZICHT
INVULLEN


10.2     LISTEXPOSITIONTYPES
Het aanroepen van deze webservice zal aan de hand van de bijhorende parameters de gevraagde
ExpositionTypes weergeven.


10.2.1     Request
Deze bevat enkel een Service Context


10.2.2     Response
Een lijst met ExpostionTypes. Een ExpositionType bestaat uit de volgende velden.                               86


10.2.2.1     ExpositionType
Naam                    Type                   Omschrijving                                      Opmerkingen

Id                      Guid                   De unieke Indentifier van het expositie type.
Code                    String                 De code van het expositie type.
Description             String                 De omschrijving van het expositie type.
Name                    String                 De naam van het expositie type.


10.3     FINDEXPOSITIONS
Het aanroepen van deze webservice operatie zal aan de hand van de bijhorende parameters de
gevraagde Exposities weergeven.


10.3.1     Request
De Request bestaat uit de sevice Context en een ExpositionSearchCriteria


10.3.1.1     ExpositionSearchCriteria
Naam                    Type                          Omschrijving                               Opmerkingen

ExpositionId            Guid                          Indien ingevuld: Het id van de
                                                      specifieke Expositie die men wenst
                                                      terug te vinden.
NamePattern             String                        Indien ingevuld: Enkel Exposities waarin
                                                      het naampattern terugkomt in de
                                                      naam zal teruggegeven worden.
From                    DateTime                      Indien ingevuld: Enkel exposities die
                                                      later in tijd starten zullen weergeven




Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
                                                  worden.
Until                   DateTime                  Indien ingevuld: Enkel exposities die
                                                  eerder in tijd starten zullen
                                                  weergegeven worden.
ExpositionTypeId        Guid                      Indien ingevuld: Enkel exposities die
                                                  behoren tot het expositieType met
                                                  bijhorende id zullen weergegeven
                                                  worden.
AudienceId              Guid                      Indien ingevuld: Enkel exposities voor
                                                  de opgegeven doelgroep worden
                                                  opgehaald.
Includes                ExpositionIncludes        Dit object zal bepalen welke
                                                  eigenschappen er van de exposities
                                                                                                              87
                                                  zullen worden opgehaald
                                                  (zie 10.3.1.2 : ExpositionIncludes).
Paging                  PagingCriteria            Zie 4.2 Paging Criteria


10.3.1.2     ExpositionIncludes
Naam                        Type                 Omschrijving                                  Opmerkingen

ImageUrl                    Boolean              Ophalen van de Image URL van het
                                                 Article.
Image                       Boolean              Ophalen van de Image van het Sarticle.


10.3.2     Response
Een lijst met Exposities. Een expositie bestaat uit volgende onderdelen


10.3.2.1     Exposition
Naam                        Type                            Omschrijving                        Opmerkingen

Id                          Guid                            De unieke Indentifier van de
                                                            expositie.
Code                        String                          De code van de expositie.
Name                        String                          De naam van de expositie.
Description                 String                          Een algemene omschrijving van
                                                            de expositie.
Image                       Picture                         De image voor de expositie.
From                        DateTime                        De start datum van de expositie.
Until                       DateTime                        De eind datum van de expositie.
Location                    String                          De plaats waar de expositie



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
                                                        doorgaat.
ExpositionType            ExpositionType                Het Type waar de expositie tot
                                                        behoord.
Periods                   List<ExpositiePeriod>         Een lijst met bijhorende             Niet in gebruik. Om
                                                        ExpostiePeriodes.                    de periodes van een
                                                                                             bepaalde expositie
                                                                                             op te halen moet
                                                                                             gebruik gemaakt
                                                                                             worden van de
                                                                                             daarvoor geschikte
                                                                                             webService
                                                                                             methode.
Prices                    List<ExpositionPrices>        Een lijst van mogelijke prijzen
                                                                                                                    88
                                                        voor de expositie.
Vat                       Vat                           De Vat voor de expositie.
Audiences                 List<Audiences>               Een lijst met bijhorende
                                                        doelgroepen.
DivisionId                Guid                          De divisie waar de expositie tot
                                                        behoort.


10.3.2.2     ExpositionPeriod
Een expositie periode is het tijdstip waarop een expositie doorgaat. Uiteraard kan een expositie op
meerdere tijdstippen doorgaan. Vandaar dat een expositie een lijst met expostiePeriodes bevat.
Een expositiePeriode heeft de volgende eigenschappen :


Naam                      Type                 Omschrijving                                Opmerkingen

Id                        Guid                 De unieke Indentifier van de
                                               expositiePeriode.
From                      DateTime             Start tijd van de expositiePeriode.
Until                     DateTime             Stop tijd van de expositiePeriode.
FinalSubscriptionDate     DateTime             Uiterste inschrijvingsdatum van de
                                               expositie.
Occupancy                 Occupancy            De bezetting van deze                       Opgelet, het resterend
                                               expositiePeriode.                           aantal kan minder zijn
                                                                                           dan de maximum
                                                                                           bezoekers verminderd
                                                                                           met de ingeschreven
                                                                                           bezoekers!



Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
ExpositionId                     Guid                 Het id van de expositie waartot de
                                                      expositiePeriode behoort.


10.3.2.3     ExpositionPrice
Een expositie periode kan meerdere prijzen bevatten. Deze prijzen hebben telkens een bepaalde
doelgroep. Zo een Prijs ziet er uit als volgt.


Naam                              Type                Omschrijving                                 Opmerkingen

ID                                Guid                De unieke identifier van de prijs
                                                      gespecifieerd in ReCreateX.
Amount                            Decimal             De eigenlijke prijs.
Group                             PriceGroup          De prijsgroep waarvoor de prijs van
                                                      toepassing is.
                                                                                                                                89
CalculationType                   CalculationT        Enumeratie van prijsberekeningswijze.        De prijs is ofwel vast,
                                  ype                 De mogelijke waardes hiervan zijn:           afhankelijk van
                                                                 PriceTimesHours = 0              aantal personen,
                                                                 FixedPrice = 1                   aantal uur of van uur
                                                                 PriceTimesQuantity = 2           en personen
                                                                 PriceTimesQuantityTimesHours =            Prijs x Uur
                                                                  3                                         Vast
                                                                                                            Prijs x aantal
                                                                                                            Prijs x aantal x
                                                                                                             uur


10.3.2.4     PriceGroup
Naam                    Type                       Omschrijving                            Opmerkingen

ID                      Guid                       De unieke identifier van de
                                                   prijsgroep gespecifieerd in
                                                   ReCreateX.
Code                    String                     De code van de prijsgroep.
Name                    String                     De omschrijving van de prijsgroep.
Type                    PriceGroupType             Enumeratie van het type prijsgroep             Algemeen (= overal
                                                             General = 0                          geldig)
                                                             PlaceReservations = 1               Zaalreserveringen
                                                             Ticketing = 2                       Ticketing
                                                             Entries = 3                          reserveringen
                                                             Sales = 4                           Inschrijvingen
                                                             Rental = 5                          Verkoop (+ Exposities)




Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
                                                       Wellness = 6                       Verhuur
                                                                                           Fitness / Wellness




10.4     LISTEXPOSITIONPERIODS
Elke expositie heeft een aantal expositie periodes. Aangezien dit aantal vrij groot kan zijn hebben we
het ophalen van de expositieperiodes opgesplitst in een aparte web service operatie. Hoe een
expositiePeriode er uit ziet is besproken in 10.3.2.2 : ExpositionPeriod


10.4.1     Request
De request bestaat uit de sevice Context en een ExpositionPeriodSearchCriteria object.


10.4.1.1     ExpositionPeriodSearchCriteria
Zoals hierboven al vermeld kan een expositie een groot aantal expositieperiodes omvatten. Hiervoor zijn          90
op een expositiePeriodSearchCriteria 2 parameters voorzien.
Naam                    Type                 Omschrijving                                  Opmerkingen

ExpositionId            Guid                 De unieke identifIer van de expositie
                                             waarvoor de periodes worden
                                             opgehaald.
From                    DateTime             Indien opgegeven, worden enkel de
                                             expositieperiodes opgehaald die starten
                                             na deze datum.
Until                   DateTime             Inidien opgegeven, worden enkel de
                                             expositieperiodes opgehaald die
                                             eindigen voor deze datum.
Paging                  PagingCriteria       Zie 4.2 Paging Criteria


10.4.2     Response
Deze geeft een lijst terug van de expositiePeriodes (zie 10.3.2.2 ExpositionPeriod) die voldoen aan
bovenstaande request.


10.5     LISTAUDIENCES
Deze methode zal de doelpublieken zoals gedefinieerd in ReCreateX teruggeven.


10.5.1     Request
De request bestaat enkel en alleen uit de Service Context.


10.5.2     Response
De response is een lijst van Audiences. Een audience object ziet er als volgt uit




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Naam                     Type                    Omschrijving                               Opmerkingen

Id                       Guid                    De unieke identifIer van de de audience.
Code                                             De code van de audience.
Name                     String                  De naam van de audience.
Description              String                  De omschrijving van de audience.


10.6     FINDORGANISEDVISITS
Deze methode wordt gebruikt voor het ophalen van expositie bezoeken.


10.6.1     Request
Het FindOrganisedVisitsRequest object bestaat uit de Service Context en een
OrganisedVisitSearchCriteria object. Dit object ziet er als volgt uit:


10.6.1.1     FindOrganisedVisitsRequest                                                                        91



Naam                    Type                     Omschrijving                                    Opmerkingen

OrganisedVisitId        Guid?                    Het unieke id van het expositiebezoek.
From                    DateTime?                Indien opgegeven, worden enkel de
                                                 expositiebezoeken opgehaald die starten na
                                                 deze datum.
Until                   DateTime?                Inidien opgegeven, worden enkel de
                                                 expositieperiodes opgehaald die eindigen voor
                                                 deze datum.
PersonId                Guid?                    Het unieke id van de persoon waarvoor je de
                                                 expositiebezoeken wenst op te halen.
Paging                  PagingCriteria           Zie 4.2 Paging Criteria
Includes                OrganisedVisitI          Dit object zal bepalen welke eigenschappen er
                        ncludes                  van de expositiebezoeken zullen worden
                                                 opgehaald.


10.6.1.2     OrganisedVisitIncludes


Naam                    Type                     Omschrijving                                    Opmerkingen

Cancelled               Bool                     Geannuleerde expositiebezoeken ook
                                                 ophalen?
PersonDetails           Bool                     Detail gegevens van de persoon ook ophalen?
PeriodReservati         Bool                     Periodieke detailgegevens van het
ons                                              expositiebezoek ook ophalen?




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Articles                Bool                     Gekoppelde artikelen van het expositiebezoek
                                                 ook ophalen?




10.6.2     Response
De response is een lijst van OrganisedVisit objecten. Een OrganisedVisit object ziet er als volgt uit:.


10.6.2.1     OrganisedVisit


Naam                    Type                     Omschrijving                                        Opmerkingen

Id                      Guid                     De unieke identifIer van het expositiebezoek.
No                      Long                     Nummer van het expositiebezoek
StartDate               DateTime                 Startdatum en –tijd van het expositiebezoek
                                                                                                                    92
EndDate                 DateTime                 Einddatum en –tijd van het expositiebezoek
Comment                 String                   Extra commentaar bij het expositiebezoek
PeriodReservati         Decimal                  Totaal bedrag van alle onderliggende periode
onAmount                                         reserveringen
ArticlesAmount          Decimal                  Totaal bedrag van alle gekoppelde artikels
CancelCostAmo           Decimal                  Annuleringskost wanneer het bezoek werd
unt                                              geannuleerd
CancelReturnA           Decimal                  Teruggave wanneer het bezoek werd
mount                                            geannulleerd
TotalAmount             Decimal                  Totaal bedrag van het expositiebezoek
Cancelled               Bool                     Is het expositiebezoek geannuleerd?
Closed                  Bool                     Is het expositiebezoek afgesloten?
PersonId                Guid                     Unieke id van de gekoppelde persoon
Person                  Person                   Detail gegevens van de gekoppelde persoon           Zie 12.5.2.4
PeriodReservati         List<Organised           Overzicht van alle gekoppelde periode
ons                     VisitPeriodRese          reserveringen.
                        rvations>                2 mogelijke implementaties:
                                                           OrganisedVisitPriceGroupPeriodReserva
                                                            tion
                                                           OrganisedVisitArticlePeriodReservation
Articles                List<Organised           Overzicht van alle gekoppelde artikelen
                        VisitArticle>


10.6.2.2     OrganisedVisitPriceGroupPeriodReservation




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Naam                    Type                     Omschrijving                                      Opmerkingen

Id                      Guid                     De unieke identifIer.
ExpositionId            Guid                     De unieke identifier van de gekoppelde
                                                 expositie
ExpositionPeriod        Guid                     De unieke identifier van de gekoppelde
Id                                               expositieperiode
Quantity                Int                      Hoeveelheid (in dit geval het aantal personen)
UnitPrice               Decimal                  De eenheidsprijs
Amount                  Decimal                  Totale bedrag (= Quantity x UnitPrice)
PriceGroup              PriceGroup               Prijsgroep                                        Zie 10.3.2.4


10.6.2.3     OrganisedVisitArticlePeriodReservation

                                                                                                                  93
Naam                    Type                     Omschrijving                                      Opmerkingen

Id                      Guid                     De unieke identifIer.
ExpositionId            Guid                     De unieke identifier van de gekoppelde
                                                 expositie
ExpositionPeriod        Guid                     De unieke identifier van de gekoppelde
Id                                               expositieperiode
Quantity                Int                      Hoeveelheid (in dit geval het aantal personen)
UnitPrice               Decimal                  Eenheidsprijs
Amount                  Decimal                  Totaal bedrag
ArticleId               Guid                     De unieke identifier van het gekoppelde artikel
ArticleCode             String                   Code van het gekoppelde artikel
ArticleName             String                   Naam van het gekoppelde artikel
ArticleDescriptio       String                   Omschrijving van het gekoppelde artikel
n


10.6.2.4     OrganisedVisitArticle


Naam                    Type                     Omschrijving                                      Opmerkingen

Id                      Guid                     De unieke identifIer.
ArticleId               Guid                     De unieke identifier van het gekoppelde artikel
ArticleCode             String                   Code van het gekoppelde artikel
ArticleName             String                   Naam van het gekoppelde artikel
ArticleDescriptio       String                   Omschrijving van het gekoppelde artikel
n




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
PriceGroup              PriceGroup              Prijsgroep                                        Zie 10.3.2.4
Quantity                Int                     Hoeveelheid (in dit geval het aantal artikelen)
UnitPrice               Decimal                 De eenheidsprijs per artikel
Amount                  Decimal                 Totale bedrag (= Quantity x UnitPrice)




                                                                                                                 94




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
11 Module Ticketing
11.1     BEKNOPT OVERZICHT
INVULLEN


11.2     LISTCULTUREACTIVITIES
Deze methode geeft alle CultureActivities weer voor de actieve Divisie.


11.2.1     Request
Geen parameters nodig


11.2.2     Response
De response geeft een lijst van CultureActivities terug.

                                                                                                                            95
11.2.2.1     CultureActivity
Naam                    Type                            Omschrijving                                       Opmerkingen

Id                      Guid                            Het unieke Id van de CultureActivity.
Code                    String                          Code van de CultureActivity.
Name                    String                          Naam van de CultureActivity.


11.3     FINDCULTUREEVENTS
11.3.1     Request
De Request bestaat uit een Service Context, en een CultureEventSearchCriteria object.
De eigenschappen van een CultureEventSearchCriteria zien er als volgt uit.


11.3.1.1     CultureEventSearchCriteria
Dit object bepaalt de zoekcriteria die toegepast wordt.
Naam                    Type                               Omschrijving                                    Opmerkingen

CultureActivityId       Guid?                              Het id van het bijhorende CultureActivitiyId.   Nullable, Niet
                                                                                                           verplicht.
CultureEventId          Guid?                              Het unieke Id van de CultureEvent?              Nullable, Niet
                                                                                                           verplicht.
From                    DateTime?                          Startdatum van het cultureevent.                Nullable, Niet
                                                                                                           verplicht.
Includes                CultureEventIncludes               Bepaalt welke delen van het cultureEvent
                                                           mee opgehaald zullen worden.
Name                    String                             Stuk van de naam van de cultureevent/
                                                           omschrijving.
Paging                  PagingCriteria                     Zie 4.2 Paging Criteria



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Until                   DateTime?                       Stopdatum van het cultureevent.               Nullable, Niet
                                                                                                      verplicht.


11.3.1.2     CultureEventIncludes
Dit object laat toe om bepaalde delen van een culture event al dan niet op te halen.
Naam                    Type                            Omschrijving                                  Opmerkingen

Image                   Bool                            Ophalen van de afbeelding of niet.
ImageUri                Bool                            Ophalen van de afbeeldingUri of niet.
Options                 Bool                            Ophalen van de opties van het huidige
                                                        CultureEvent of niet.


11.3.2     Response
Het resultaat van de zoekfunctie bestaat uit een lijst van cultureEvents.
                                                                                                                       96

11.3.2.1     CultureEvent
CultureEvent is het object dat alle informatie bevat over CultureEvents
Naam                       Type                         Omschrijving                                  Opmerkingen

AdministrativeCost         AdministrativeCost
AvailableSeats             Int32                        Het aantal beschikbare plaatsen.              Nog niet
                                                                                                      klaar.
Code                       String                       De code van het cultureEvent.
CultureActivity            CultureActivity              De Cultuur Activiteit waar het cultureEvent
                                                        tot behoord.
Description                String                       De omschrijving van het cultureEvent.
From                       DateTime?                    De startdatum van het cultureEvent.           Nullable
Hall                       Hall
Id                         Guid                         De unieke identifier van het cultureEvent.
Image                      Picture                      De afbeelding van het CultureEvent.
ImageUri                   String                       De Uri waarop de afbeelding kan worden
                                                        opgehaald.
IncassoCost                IncassoCost                  De bijkomende kosten voor betaalwijze
                                                        incasso. Zie 6.9.2 Response.
MaxTicketsPerAddr          Int32                        Het maximaal aantal tickets die door een
ess                                                     zelfde persoon kan gekocht worden voor
                                                        dit evenement.
MaxVisitors                Int32                        Het maximum aantal deelnemers voor dit
                                                        evenement.
MaxVisitorsWeb             Int32                        Het maximum aantal deelnemers voor dit



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        evenement dat zich kan inschrijvenvia de
                                                        website.
Name                      String                        De naam van het cultureEvent.
Prices                    Collection<CultureE           Een lijst van prijzen van het CultuurEvent.
                          ventPrice>
ReservationCost           ReservationCost               De bijkomende reserveringskosten voor dit
                                                        evenement.
SalesFrom                 DateTime?                     Datum van wanneer tickets mogen                Nullable
                                                        verkocht worden.
SalesUntil                DateTime?                     Datum tot wanneer tickets mogen verkocht       Nullable
                                                        worden.
SeatSequenceId            Guid?                         Wordt niet gebruikt door webservices.          Nullable
Status                    CultureEventStatus            Mogelijke waarden :
                                                                                                                  97
                                                         - Open
                                                        - Closed
                                                        - NotForSale
Until                     DateTime?                     De stopdatum van het cultureEvent.             Nullable
VatId                     Guid                          De identifier van het BTW tarief dat van
                                                        toepassing is op dit evenement.
AllowBasReservatio        Bool                          Indicatie voor de websitebouwer dat de
n                                                       zitjes van dit evenement mogen
                                                        gereserveerd worden via het BAS systeem
AllowExplicitSeatRe       Bool                          Indicatie voor de websitebouwer dat de
servation                                               zitjes van dit evenement mogen
                                                        gereserveerd worden via manuele selectie.


11.3.2.2     CultureEventPrice
Een CultureEvent kan meerdere prijzen bevatten. Deze prijzen hebben telkens een bepaalde prijsgroep.
Zo een Prijs ziet er uit als volgt.


Naam                         Type                    Omschrijving                               Opmerkingen

ID                           Guid                    De unieke identifier van de prijs
                                                     gespecifieerd in ReCreateX.
Amount                       Decimal                 De eigenlijke prijs.
Group                        PriceGroup              De prijsgroep waarvoor de prijs van
                                                     toepassing is.
CustomerID                   Guid                    De klant voor wie de prijs van
                                                     toepassing is.



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
SeatBlock                 SeatBlock               De verzameling van rijen (blok)
                                                  waarvoor de prijs van toepassing is.
SeatRow                   SeatRow                 De rij waarop deze prijs van
                                                  toepassing is.
Seat                      Seat                    Het zitje waarop de prijs van
                                                  toepassing is.
SeatRowRange              SeatRowRang             De rang waarop de prijs van
                          e                       toepassing is.
StartDate                 Datum                   De datum vanaf wanneer de prijs
                                                  geldig is. Indien deze datum ingevuld
                                                  is, dan is deze prijs enkel van
                                                  toepassing voor reserveringen die
                                                  vallen na deze datum.
                                                                                                                  98
MinimumQty                Int                     Indien ingevuld, dan is deze prijs enkel
                                                  geldig voor aankopen vanaf x aantal
                                                  tickets.


11.4     LISTCULTUREEVENTOPTIONS
11.4.1     Request
De request bestaat uit de service context en een ListCultureEventOptionCriteria
Een CultureEventOptionCriteria bestaat uit volgende velden
Naam                    Type                         Omschrijving                                   Opmerkingen

CultureEventId          Guid                         De unieke identifier van het CultureEvent.


11.4.2     Response
De response bestaat uit een lijst van CultureEventOptions. Een CultureEventOption object bestaat uit
volgende velden.
Naam                    Type                         Omschrijving                                   Opmerkingen

Id                      Guid                         De unieke identifier van de optie.
Code                    String                       De code van de optie.
Name                    String                       De naam van de optie.
Price                   String                       De prijs van de optie.
ArticleId               Guid                         De unieke identifier van het artikel waaraan
                                                     de optie is verbonden.
MaxQuantity             Integer                      Het maximum aantal opties.


Available               Integer                      Het aantal aanwezig opties.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
11.5       GETHALLSEATING
Geeft een Hal terug met alle beschikbare gegevens over de zitjes, rijen, blokken, rangen en locaties.
Deze methode is overbodig vanaf WSDL 2.1 en wordt bij voorkeur vervangen door de
GetCultureEventSeating methode.


Een hal (Hall) bestaat uit:
           De zitjes in de hall zelf (optioneel)
           De blokken waarin een hal kan worden opgedeeld (optioneel)
            Blokken dienen om grote hallen beheersbaarder te maken.
            (ook beide tegelijkertijd zijn mogelijk)
Een blok (SeatBlock) bestaat uit rijen. (‘zone’ is een synoniem voor block)
Een rij (SeatRow) bestaat uit zitjes (Seats).


Blokken, rijen en zitjes bevatten locatie informatie (coördinaten en grootte) zodat een simpele visuele          99
voorstelling van de lay-out van een zaal (of blok) mogelijk is.
           De eenheid van de locatie informatie is niet bepaald. Het is enkel de relatieve locatie van zitjes
            ten opzichte van elkaar die belangrijk is. (In ReCreateX kan een diagram worden getekend, de
            eenheden die hier worden gebuikt zijn millimeters)
           Alle coördinaten [Location.X, Location.Y] zijn relatief t.o.v. de container waarin de seating
            element zich bevinden. Dit will zeggen:
                 o      zitjes zitten altijd in rijen
                 o      rijen zitten ofwel in een blok of direct in de hall
                 o      blokken bevinden zich in een hall
           De coördinaten slaan op de linker boven hoek (kleinste X en Y coördinaten).
           De grootte van een item [Location.Dx, Location.Dy] laat je toe om een symbool (rechthoek,
            cirkel, afbeelding,…) te tonen die niet groter is dan de opgegeven grootte.
           Het is aangeraden om de zitjes uit verschillende blokken niet op één diagram te tonen.
            (Dit zou aanleiding geven tot veel te veel informatie)
            Toon eerst de blokken in de hall (eventueel de zitjes in de hall zelf).
            Na keuze van een blok kan je de zitjes in die blok tonen.


                                                          X


                          1     2     3       4    A1
                          1     2     3       4    A2
             Y


Voorbeeld: Op bovenstaand voorbeeld zie je 2 rijen (A1 en A2) met elk 4 zitjes (1, 2, 3 en 4).
Elk bolletje stelt het referentie punt voor van het element (altijd de linker-boven hoek).
De coördinaten van zitje 1 (in rijA1) zijn relatief t.o.v. de rij A1(vb. [2, 1]).


Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
De coördinaten van rij A1 zijn relatief t.o.v. de oorsprong (vb. [10, 5]).
Dus als je enkel het zitje zou tekenen dan moet je een rechthoekje tekenen van [12, 6] tot [20, 14].
(in de veronderstelling dat DX en DY van dat zitje 8 is. [10 + 2, 5 + 1] tot [10 + 2 + 8, 5 + 1 + 8])


Opmerking: Aangezien de lay-out van een hal niet frequent verandert en de het aantal zitjes in een hall
serieus kan oplopen, is het aan te raden om deze informatie te cachen.


11.5.1     Request
De request bestaat uit de service context en de ID van de gewenste hall.


11.5.2     Response
De response bestaat uit één (of geen) hall object.



11.6     GETCULTUREEVENTSEATING                                                                           100

Geeft een Hal terug met alle beschikbare gegevens over de zitjes, rijen, blokken, rangen en locaties
voor een bepaald cultuur evenement. Het is mogelijk om voor de rangen per evenement af te wijken
van het standaard zaalplan (dat opgehaald kan worden via de GetHallSeating methode).


Deze methode vervangt in feite de GetHallSeating methode. Het is aan te raden om deze methode te
gebruiken ipv de GetHallSeating methode. Wanneer er geen rangen gedefinieerd zijn op niveau van
evenement, worden deze van de zaal genomen.


11.6.1     Request
De request bestaat uit de service context en de ID van het evenement.


11.6.2     Response
De response bestaat uit één (of geen) hall object.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
11.7       GETSEATALLOCATIONS
Deze operatie laat je toe om de beschikbaarheid van zitjes voor een voorstelling (Culture Event) op te
vragen. De beschikbaarheid van een zitje wordt beschreven door een Seat Allocation object. Een Seat
Allocation object bevat een verwijzing naar het zitje (Seat ID) en de Allocation Status ervan.
Mogelijk allocatie statussen zijn:
            Beschikbaar [Available]
            Gereserveerd [Reserved]
            Geblokkeerd [Blocked]
            Tijdelijk Gereserveerd [Locked]
            In Optie [Option]
Voor de eindgebruiker is het meestal enkel belangrijk om een verschil tussen beschikbare en
onbeschikbare zitjes te weten.


Naast het opvragen van de beschikbaarheid van individuele zitjes is het ook mogelijk om                             101

samenvattingen [Summaries] van de beschikbaarheid van zitjes per blok en/of hal op te vragen. (Zo
kan je bijvoorbeeld per block aangeven hoeveel zitjes nog beschikbaar zijn.


Het opvragen van de individuele beschikbaarheid en de gegroepeerde samenvattende
beschikbaarheden wordt met één en dezelfde web service operation opgevraagd.


Samen met de gegevens uit 11.5 kan je visueel de allocaties van zitjes weergeven.


11.7.1      Request
De request bestaat uit de service context en volgende velden
Naam                             Type     Omschrijving                                                Opmerkingen

EventId                          Guid     De unieke identifier van het CultureEvent.                  Verplicht
SeatBlockCode                    String   De unieke code van een blok                                 Optioneel
                                          (De ‘SelectedArea’ wordt dan de blok i.p.v. de hal).
AllocationIncludes               Enum     Welke Seat Allocations will je ophalen:                     Verplicht
                                              None: je wilt enkel summaries ophalen
                                              All: allocaties in alle blokken en in de hal zelf
                                              SelectedArea: enkel de zitjes in de hal zelf (waneer
                                               SeatBlockCode leeg is) of enkel de zitjes in de
                                               opgegeven blok (wanneer SeatBlockCode is
                                               ingevuld)


11.7.2      Response
Een SeatAllocationOverview object.
           Overview.Allocations: de gevraagde seat allocation objecten



Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
          Overview.Summary: een samenvatting van de beschikbaarheid van zitjes gegroepeerd pet
           blok of hal.
                o       Summary.TotalCount: de telling van alle zitjes
                o       Summary.Count: de telling van de zitjes in de hal zelf
                o       Summary.BlockSummaries[n].Count: de telling van de zitjes in een bepaalde block
          Elk ‘telling’ object (SeatAllocationCount) bevat volgende statistieken:
                o       [Available] : int
                o       [Blocked] : int
                o       [Locked] : int
                o       [Reserved] : int
                o       [Option] : int
          De rest kan je zelf uitrekenen:
                o       [Unavailable] = [Blocked] + [Locked] + [Reserved] + [Option]
                o       [Total] = [Available] + [Unavailable]                                             102




Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
12 Module Zaalreserveringen
12.1     BEKNOPT OVERZICHT
INVULLEN


12.2     FINDRESERVATIONACTIVITIES
Deze service is vooral bedoeld om daar waar een ReservationActivity nodig is, een geldige te kunnen
selecteren uit een lijst. Een voorbeeld is het populeren van een combobox of listcontrol met
ReservationActivities.


12.2.1     Request
De request bestaat uit de Service Context en een ReservationActivityCriteria object
Naam                    Type                            Omschrijving                                   Opmerkingen

Reservation             Guid                            Id van een specifiek ReservationActivity       Nullable        103
ActivityId
                                                        (Als U doelbewust 1 entity wil ophalen).       (Indien niet
                                                                                                       van
                                                                                                       toepassing).
NamePattern             String                          Naam of stuk van een naam waarnaar             Nullable
                                                        gezocht kan worden. Er wordt op de             (Indien niet
                                                        omschrijving gezocht. Voor gedeeltelijke       van
                                                        matchen kan het %-teken gebruikt worden.       toepassing).
                                                        Het %-teken kan zowel voor het woord, na het
                                                        woord als voor en achter het woord
                                                        voorkomen.
Includes                ReservationActivityI            Bepaalt welke data extra meekomt in het
                        ncludes                         response en/of welke extra records in de
                                                        returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




12.2.1.1     ReservationActivityIncludes
Het ReservationActivityInclude object bestaat uit de eigenschappen:
Naam                    Type                            Omschrijving                                   Opmerkingen

Blocked                 Boolean                         Moeten geblokkeerde ReservationActivities      True betekent
                                                        ook weergegeven worden.                        meenemen.


12.2.2     Response
De response zal een lijst van ReservationActivities bevatten dat voldoet aan de criteria.
Naam                       Type                     Omschrijving                                       Opmerkingen



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Id                         Guid                     Id van de ReservationActivity.


Name                       String                   Naam van de activiteit.
Description                String                   Omschrijving van de ReservationActivity.
MinParticipants            Integer                  Minimum aantal deelnemers voor de activiteit.
MaxParticipants            Integer                  Maximum aantal deelnemers voor de activiteit.
MaxReservations            Integer                  Maximum aantal reservaties voor de activiteit.
IsBlocked                  Boolean                  Is de ReservationActivity geblokkeerd?
IsTechnicalActivity        Boolean                  Is de ReservationActivity een technische activiteit?
IsCulturalActivity         Boolean                  Is de ReservationActivity een culturele activiteit?
Color                      Color                    Kleur die wordt gebruikt voor het weergeven van
                                                    deze activiteit binnen ReCreateX

                                                                                                                          104

12.3     FINDINFRASTRUCTURES
Deze service is vooral bedoeld om daar waar een Infrastructure nodig is, een geldige te kunnen
selecteren uit een lijst. Een voorbeeld is het populeren van een combobox of listcontrol met
Infrastructures.


12.3.1     Request
De request bestaat uit de Service Context en een InfrastructureCriteria object
Naam                    Type                            Omschrijving                                       Opmerkingen

InfrastructureId        Guid                            Id van een specifiek Infrastructure                Nullable
                                                        (Als U doelbewust 1 entity wil ophalen).           (Indien niet
                                                                                                           van
                                                                                                           toepassing).
AddressId               Guid                            Id van een fysieke locatie in ReCreateX.           Nullable
                                                                                                           (Indien niet
                                                                                                           van
                                                                                                           toepassing).
DivisionId              Guid                            Id van een ReCreateX Divisie.                      Nullable
                                                                                                           (Indien niet
                                                                                                           van
                                                                                                           toepassing).
NamePattern             String                          Naam of stuk van een naam waarnaar                 Nullable
                                                        gezocht kan worden. Er wordt op de                 (Indien niet
                                                        omschrijving gezocht. Voor gedeeltelijke           van
                                                        matchen kan het %-teken gebruikt worden.           toepassing).
                                                        Het %-teken kan zowel voor het woord, na het



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        woord als voor en achter het woord
                                                        voorkomen.
Includes                Infrastructure                  Bepaalt welke data extra meekomt in het
                        Include                         response en/of welke extra records in de
                                                        returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




12.3.1.1     InfrastructureIncludes
Het InfrastructureInclude object bestaat uit de eigenschappen:
Naam                    Type                            Omschrijving                                    Opmerkingen

IncludePlaces           Boolean                         In het resultaat worden ook gerelateerde        True betekent
                                                        Plaatsen mee opgenomen.                         mee
                                                                                                                        105
                                                                                                        opnemen.
Include                 Boolean                         In het resultaat worden ook gerelateerde        True betekent
DivisionInfo
                                                        Divisions mee opgenomen.                        mee
                                                                                                        opnemen.


12.3.2     Response
De response zal een lijst van Infrastructures bevatten dat voldoet aan de criteria.
Naam                     Type                           Omschrijving                                    Opmerkingen

Id                       Guid                           Id van de Infrastructure.


Name                     String                         Naam van de Infrastructure.


Description              String                         Omschrijving van de Infrastructure.
Location                 Address                        Locatie van de infrastructuur (Fysiek adres).
Comment                  String                         Kommentaar over de infrastructuur.
LastChanged              DateTime                       Datum laatste wijziging.
IsBlocked                Boolean                        Is de Infrastructure geblokkeerd?
Places                   IList<Place>                   Gerelateerde plaatsen aan de infrastructuur.
Division                 Division                       Gerelateerde divisie aan de infrastructuur.



12.3.2.1     Address
Het Address object in de FindInfrastructures response ziet er als volgt uit (Standaard Address object).
Naam                     Type                           Omschrijving                                    Opmerkingen

Street                   String                         Straatnaam
Number                   String                         Straatnummer


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Box                     String                      Postbus
ZipCode                 String                      Zipcode of postnummer
Town                    String                      Stad, gemeente, …
Country                 String                      Land/Staat




12.3.2.2     Place
Het Place object in de FindInfrastructures response ziet er als volgt uit (Standaard Place object).
Naam                    Type                        Omschrijving                                    Opmerkingen

Id                      Guid                        Id van de Plaats.


Name                    String                      Naam van de Plaats.
                                                                                                                  106


Description             String                      Omschrijving van de Plaats.
MaxDays                 Integer                     Maximuim aantal dagen dat er kan
Reservation
                                                    gereserveerd worden via ReCreateX.
MaxDays                 Integer                     Maximuim aantal dagen dat er kan
ReservationWeb
                                                    gereserveerd worden via het Web.
IsCumulated             Boolean                     Maakt deze Plaats deel uit van een
                                                    gecumuleerde verzameling plaatsen?
Infrastructure          Infrastructure              De Infrastucture waar deze plaats betrekkning
                                                    op heeft.
                                                    Als genest object zal deze leeg (NULL) zijn,
                                                    tenzij de Plaats op het hoogste niveau wordt
                                                    opgevraagd.
Reservation             Reservation                 De ReservationActivity die van toepassing is
Activity                Activity
                                                    voor deze plaats.
                                                    Als genest object zal deze leeg (NULL) zijn,
                                                    tenzij de Plaats op het hoogste niveau wordt
                                                    opgevraagd.



12.3.2.3     Division
Het Division object in de FindInfrastructures response ziet er als volgt uit (Standaard Division object).
Naam                    Type                        Omschrijving                                    Opmerkingen

Id                      Guid                        Id van de Division.


Name                    String                      Naam van de Division.


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Address                  Address                        Adres van de Division (Zie type “Address”).
Phone                    String                         Telefoonnummer
Fax                      String                         Faxnummer
Email                    String                         Email adres
Website                  String                         Website url
BankAccount              String                         Bankrekening nummer
Comments                 String                         Kommentaar over de Division
Credential               Credential                     Credentials voor de Division


12.3.2.4     Credentials
Het Credentials object in het Division object ziet er als volgt uit (Standaard Credentials object).
Naam                     Type                           Omschrijving                                        Opmerkingen      107
Username                 String                         Gebruikersnaam


Password                 String                         Paswoord




12.4     FINDINFRASTRUCTUREOPENINGS
Deze service haalt de openingstijden op voor één of alle infrastructuren tussen een bepaalde start en
eind datum.


12.4.1     Request
De request bestaat uit de Service Context en een InfrastructureOpeningsSearchCriteria object.


12.4.1.1     InfrastructureOpeningsSearchCriteria
Naam                    Type                            Omschrijving                                  Opmerkingen

InfrastructureId        Guid?                           Id van een Infrastructure waarvoor u de       Indien niet
                                                        openingstijden wenst op te halen.             opgegeven worden
                                                                                                      de gegevens van
                                                                                                      alle infrastructuren
                                                                                                      opgehaald
From                    DateTime                        Haalt de openingstijden op vanaf deze
                                                        datum
Until                   DateTime                        Haalt de openingstijden op tot en met
                                                        deze datum
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
12.4.2     Response
De response zal een InfrastructureOpenings object bevatten dat voldoet aan de criteria.


12.4.2.1     InfrastructureOpenings
Naam                      Type                          Omschrijving                                    Opmerkingen

OpeningHourColor          Color                         Kleur dat binnen ReCreateX wordt gebruikt
                                                        voor het weergeven van openingsuren
ClosingHourColor          Color                         Kleur dat binnen ReCreateX wordt gebruikt
                                                        voor het weergeven van sluitingsuren
ClosingDayColor           Color                         Kleur dat binnen ReCreateX wordt gebruikt
                                                        voor het weergeven van sluitingsdagen
InfrastructureOpeni       IList<Infrastructur           Lijst van openingsuren per infrastructuur
ngHours
                          eOpeningHours>
                                                                                                                      108

12.4.2.2     InfrastructureOpeningHours
Naam                      Type                          Omschrijving                                    Opmerkingen

InfrastructureID          Guid                          Unieke id van de infrastructuur
OpenHours                 IList<OpeningHo               Lijst van openingsuren voor de infrastructuur
                          ur>


12.4.2.3     OpeningHour
Een OpeningHour object geeft een datum weer met 2 mogelijke tijdspannes voor openingstijden.
Naam                      Type                          Omschrijving                                    Opmerkingen

Date                      DateTime                      Datum waarop de infrastructuur open is
From1                     DateTime?                     Vanaf wanneer is de infrastructuur open ?       From1 & To1
To1                       DateTime?                     Tot wanneer is de infrastructuur open?          horen samen

From2                     DateTime?                     Vanaf wanneer is de infrastructuur open ?       From2 & To2
To2                       DateTime?                     Tot wanneer is de infrastructuur open?          horen samen




12.5     FINDPLACES
Deze service is vooral bedoeld om daar waar een Place (Plaats) nodig is, een geldige te kunnen
selecteren uit een lijst. Een voorbeeld is het populeren van een combobox of listcontrol met Places.


12.5.1     Request
De request bestaat uit de Service Context en een PlaceCriteria object
Naam                    Type                            Omschrijving                                    Opmerkingen

PlaceId                 Guid                            Id van een specifiek Plaats                     Nullable




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                        (Als U doelbewust 1 entity wil ophalen).        (Indien niet
                                                                                                        van
                                                                                                        toepassing) .
InfrastructureId        Guid                            Id van een Infrastructure waarvoor U plaatsen   Nullable
                                                        wilt vinden.                                    (Indien niet
                                                                                                        van
                                                                                                        toepassing).
Reservation             Guid                            Id van een ReCreateX ReservationActivity        Nullable
ActivityId
                                                        waarvoor U plaatsen wilt vinden.                (Indien niet
                                                                                                        van
                                                                                                        toepassing).
NamePattern             String                          Naam of stuk van een naam waarnaar              Nullable
                                                        gezocht kan worden. Er wordt op de              (Indien niet
                                                                                                                         109
                                                        omschrijving gezocht. Voor gedeeltelijke        van
                                                        matchen kan het %-teken gebruikt worden.        toepassing).
                                                        Het %-teken kan zowel voor het woord, na het
                                                        woord als voor en achter het woord
                                                        voorkomen.
Includes                PlaceIncludes                   Bepaalt welke data extra meekomt in het
                                                        response en/of welke extra records in de
                                                        returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




12.5.1.1     PlaceIncludes
Het PlaceInclude object bestaat uit de eigenschappen:
Naam                    Type                            Omschrijving                                     Opmerkingen

Infrastructure          Boolean                         In het resultaat worden ook gerelateerde         True betekent
Info
                                                        Infrastructures mee opgenomen.                   mee
                                                                                                         opnemen.
Reservation             Boolean                         In het resultaat worden ook gerelateerde         True betekent
ActivityInfo
                                                        ReservationActivities mee opgenomen.             mee
                                                                                                         opnemen.
Cumulated               Boolean                         In het resultaat worden gecumuleerde
                                                        plaatsen meegenomen.
Uncumulated             Boolean                         In het resultaat worden niet-gecumuleerde
                                                        plaatsen meegenomen.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
12.5.2     Response
De response zal een lijst van Places bevatten dat voldoet aan de criteria.
Naam                    Type                           Omschrijving                                    Opmerkingen

Id                      Guid                           Id van de Plaats.


Name                    String                         Naam van de Plaats.


Description             String                         Omschrijving van de Plaats.
MaxDays                 Integer                        Maximuim aantal dagen dat er kan
Reservation
                                                       gereserveerd worden via ReCreateX.
MaxDays                 Integer                        Maximuim aantal dagen dat er kan
ReservationWeb
                                                       gereserveerd worden via het Web.
IsCumulated             Boolean                        Maakt deze Plaats deel uit van een
                                                                                                                     110
                                                       gecumuleerde verzameling plaatsen?
Infrastructure          Infrastructure                 De Infrastucture waar deze plaats betrekkning   Afhankelijk
                                                       op heeft.                                       van de
                                                                                                       Includes.
Reservation             Reservation                    De ReservationActivity die van toepassing is    Afhankelijk
Activity                Activity
                                                       voor deze plaats.                               van de
                                                                                                       Includes.



12.5.2.1     Infrastructure
Het Infrastructure object in de FindPlaces response ziet er als volgt uit (Standaard Infrastructure object).


Naam                    Type                           Omschrijving                                    Opmerkingen

Id                      Guid                           Id van de Infrastructure.


Name                    String                         Naam van de Infrastructure.


Description             String                         Omschrijving van de Infrastructure.
Location                Address                        Locatie van de infrastructuur (Fysiek adres).
Comment                 String                         Kommentaar over de infrastructuur.
LastChanged             DateTime                       Datum laatste wijziging.
IsBlocked               Boolean                        Is de Infrastructure geblokkeerd ?
Places                  IList<Place>                   Niet ingevuld als genest object.
Division                Division                       Niet ingevuld als genest object.




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
12.5.2.2     ReservationActivity
Het ReservationActivity object in de FindPlaces response ziet er als volgt uit (Standaard
ReservationActivity object).
Naam                      Type                          Omschrijving                                     Opmerkingen

Id                        Guid                          Id van de ReservationActivity.


Name                      String                        Naam van de activiteit.


Description               String                        Omschrijving van de ReservationActivity.
MinParticipants           Integer                       Minimum aantal deelnemers voor de activiteit.
MaxParticipants           Integer                       Maximum aantal deelnemers voor de activiteit.
MaxReservations           Integer                       Maximum aantal reservaties voor de activiteit.
IsBlocked                 Boolean                       Is de ReservationActivity geblokkeerd?
                                                                                                                        111
IsTechnicalActivity       Boolean                       Is de ReservationActivity een technicsche
                                                        activiteit?
IsCulturalActivity        Boolean                       Is de ReservationActivity een culturele
                                                        activiteit?




12.6     FINDRESERVATIONS
Deze service is vooral bedoeld om daar waar een Reservation (Reservatie) nodig is, een geldige te
kunnen selecteren uit een lijst. Een voorbeeld is het populeren van een grid of listcontrol met
Reservations.


12.6.1     Request
De request bestaat uit de Service Context en een ReservationCriteria object
Naam                    Type                            Omschrijving                                     Opmerkingen

ReservationId           Guid                            Id van een specifiek Reservatie                  Nullable
                                                        (Als U doelbewust 1 entity wil ophalen).         (Indien niet
                                                                                                         van
                                                                                                         toepassing).
CustomerId              Guid                            Id van een Klant waarvoor U reservaties wilt     Nullable
                                                        vinden.                                          (Indien niet
                                                                                                         van
                                                                                                         toepassing).
PlaceId                 Guid                            Id van een Plaats waarvoor U reservaties wilt    Nullable
                                                        vinden.                                          (Indien niet


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                                                                           van
                                                                                                           toepassing).
InfrastructureId        Guid                            Id van een Infrastructure waarvoor U reservaties   Nullable
                                                        wilt vinden.                                       (Indien niet
                                                                                                           van
                                                                                                           toepassing).
Reservation             Guid                            Id van een ReCreateX ReservationActivity           Nullable
ActivityId
                                                        waarvoor U plaatsen wilt vinden.                   (Indien niet
                                                                                                           van
                                                                                                           toepassing).
NamePattern             String                          Naam of stuk van een naam waarnaar                 Nullable
                                                        gezocht kan worden. Er wordt op de                 (Indien niet
                                                        omschrijving gezocht. Voor gedeeltelijke           van
                                                                                                                           112
                                                        matchen kan het %-teken gebruikt worden.           toepassing).
                                                        Het %-teken kan zowel voor het woord, na het
                                                        woord als voor en achter het woord
                                                        voorkomen.
FromDateTime            DateTime                        Startdatum en tijd voor de periode waarbinnen
                                                        U reservaties wilt vinden.
ToDateTime              DateTime                        Einddatum en tijd voor de periode waarbinnen
                                                        U reservaties wilt vinden.
Includes                ReservationIncludes             Bepaalt welke data extra meekomt in het
                                                        response en/of welke extra records in de
                                                        returnset aanwezig zullen zijn.
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




12.6.1.1     ReservationIncludes
Het ReservationInclude object bestaat uit de eigenschappen:
Naam                    Type                            Omschrijving                                       Opmerkingen

Optional                Boolean                         In het resultaat worden ook optionele              True betekent
Reservations
                                                        reservaties.                                       mee
                                                                                                           opnemen.
Single                  Boolean                         In het resultaat worden ook reservaties            True betekent
Reservations
                                                        opnemen die geen deel uitmaken van een lijst       mee
                                                        of een serie.                                      opnemen.
Reservations            Boolean                         In het resultaat worden ook reservaties            True betekent
InList
                                                        opgenomen die deel uitmaken van een lijst.         mee




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                                                                     opnemen.
Serie                   Boolean                      In het resultaat worden ook reservaties         True betekent
Reservations
                                                     opgenomen die deel uitmaken van een serie.      mee
                                                                                                     opnemen.
Deleted                 Boolean                      In het resultaat worden ook reservaties         True betekent
Reservations
                                                     opgenomen die deel uitmaken van een serie.      mee
                                                                                                     opnemen.
CustomerInfo            Boolean                      In het resultaat wordt ook gerelateerde         True betekent
                                                     klantinformatie opgenomen.                      object(en)
                                                                                                     opvullen.
PlaceInfo               Boolean                      In het resultaat wordt ook gerelateerde         True betekent
                                                     plaatsinformatie opgenomen.                     object(en)
                                                                                                     opvullen.
                                                                                                                     113
Infrastructure          Boolean                      In het resultaat wordt ook gerelateerde         True betekent
Info
                                                     infrastructuurinformatie opgenomen.             object(en)
                                                                                                     opvullen.
Reservation             Boolean                      In het resultaat wordt ook gerelateerde         True betekent
ActivityInfo
                                                     reservationactivity-informatie opgenomen.       object(en)
                                                                                                     opvullen.


12.6.2     Response
De response zal een lijst van Reservations bevatten dat voldoet aan de criteria.
Naam                     Type                        Omschrijving                                    Opmerkingen

Id                       Guid                        Id van de Reservation.


Description              String                      Omschrijving van de Reservation.
ReservationNo            Int64                       Reservation No.
SeriesNumber             Int64                       Serie reservation No.
SetNumber                Int64                       Reservation lijst No.
OGM                      String                      Maximuim aantal dagen dat er kan
                                                     gereserveerd worden via het Web.
StartDateTime            DateTime                    Maakt deze Plaats deel uit van een
                                                     gecumuleerde verzameling plaatsen?
EndDateTime              DateTime                    De Infrastucture waar deze plaats betrekkning   Afhankelijk
                                                     op heeft.                                       van de
                                                                                                     Includes.
ParticipantsCount        Integer                     De ReservationActivity die van toepassing is    Afhankelijk
                                                     voor deze plaats.                               van de




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
                                                                                                  Includes.
Amount                  Decimal                     Bedrag van de reservatie.
PostedAmount            Decimal                     Geregistreerd bedrag van de reservatie.
RentalPrice             Decimal                     Bedrag van verhuurde artikelen gerelateerd
                                                    aan deze reservatie.
SalesPrice              Decimal                     Verkoopsprijs.
Balance                 Decimal                     Openstaande balans.
HasBeenInvoiced         Boolean                     Is gefactureerd.
ToPay                   Boolean                     Moet betaald worden.
IsOption                Boolean                     Is een optionele reservatie.
IsDeleted               Boolean                     Reservatie is verwijderd.
DateLastModfied         DateTime                    Datum tijd laatste wijziging.
DateDeleted             DateTime                    Datum tijd verwijdering.                                    114
Reservation             Reservation                 Gerelateerde ReservationActivity.             Ingevuld
Activity                Activity
                                                                                                  afhankelijk
                                                                                                  van de
                                                                                                  includes.
Place                   Place                       Gerelateerde plaats.                          Ingevuld
                                                                                                  afhankelijk
                                                                                                  van de
                                                                                                  includes.
Infrastructure          Infrastructure              Gerelateerde infrastructuur.                  Ingevuld
                                                                                                  afhankelijk
                                                                                                  van de
                                                                                                  includes.
Customer                Person                      Gerelateerde klant.                           Ingevuld
                                                                                                  afhankelijk
                                                                                                  van de
                                                                                                  includes.
Deletable               Bool                        Geeft aan of de reservering geannuleerd kan
                                                    worden.




12.6.2.1     Place
Het Place object in de FindReservations response ziet er als volgt uit (Standaard Place object).
Naam                    Type                        Omschrijving                                  Opmerkingen

Id                      Guid                        Id van de Plaats.


Name                    String                      Naam van de Plaats.



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Description             String                         Omschrijving van de Plaats.
MaxDays                 Integer                        Maximuim aantal dagen dat er kan
Reservation
                                                       gereserveerd worden via ReCreateX.
MaxDays                 Integer                        Maximuim aantal dagen dat er kan
ReservationWeb
                                                       gereserveerd worden via het Web.
IsCumulated             Boolean                        Maakt deze Plaats deel uit van een
                                                       gecumuleerde verzameling plaatsen ?
Infrastructure          Infrastructure                 De Infrastucture waar deze plaats betrekkning   Niet
                                                       op heeft.                                       opgevuld als
                                                                                                       genest
                                                                                                       object.
Reservation             Reservation                    De ReservationActivity die van toepassing is    Niet
                                                                                                                      115
Activity                Activity
                                                       voor deze plaats.                               opgevuld als
                                                                                                       genest
                                                                                                       object.


12.6.2.2     Infrastructure
Het Infrastructure object in de FindReservations response ziet er als volgt uit (Standaard Infrastructure
object).
Naam                    Type                           Omschrijving                                    Opmerkingen

Id                      Guid                           Id van de Infrastructure.


Name                    String                         Naam van de Infrastructure.


Description             String                         Omschrijving van de Infrastructure.
Location                Address                        Locatie van de infrastructuur (Fysiek adres).
Comment                 String                         Kommentaar over de infrastructuur.
LastChanged             DateTime                       Datum laatste wijziging.
IsBlocked               Boolean                        Is de Infrastructure geblokkeerd?
Places                  IList<Place>                   Niet ingevuld als genest object.
Division                Division                       Niet ingevuld als genest object.



12.6.2.3     ReservationActivity
Het ReservationActivity object in de FindReservations response ziet er als volgt uit (Standaard
ReservationActivity object).
Naam                    Type                           Omschrijving                                    Opmerkingen

Id                      Guid                           Id van de ReservationActivity.


Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
Name                     String                         Naam van de activiteit.


Description              String                         Omschrijving van de ReservationActivity.
MinParticipants          Integer                        Minimum aantal deelnemers voor de activiteit.
MaxParticipants          Integer                        Maximum aantal deelnemers voor de activiteit.
MaxReservations          Integer                        Maximum aantal reservaties voor de activiteit.
IsBlocked                Boolean                        Is de ReservationActivity geblokkeerd?
IsTechnicalActivit       Boolean                        Is de ReservationActivity een technische
y
                                                        activiteit?
IsCulturalActivity       Boolean                        Is de ReservationActivity een culturele
                                                        activiteit?

                                                                                                                            116


12.6.2.4     Person
Het Customer object in de FindReservations response ziet er als volgt uit (Standaard Person object).
Name                    Type                            Omschrijving                               Opmerkingen

ActivationID            Guid                            Uniek ID om user account te activeren.     Wordt niet gebruikt in
                                                                                                   WebServices.
Id                      Guid                            De Unieke Identifier van de gebruiker.     Bij aanmaak zal dit
                                                                                                   leeg zijn.
Code                    String                          Een unieke code van de gebruiker.
Name                    PersonName                      De naam van de gebruiker.
Address                 Address                         Het adres van de gebruiker.
Settings                PersonSettings                  Extra instellingen van de gebruiker.
Email                   String                          Het email adres van de gebruiker.
BirthDate               DateTime?                       De geboortedatum van de gebruiker.         Nullable
Gender                  Gender                          Het geslacht van de gebruiker.             Enumerator: Male=0,
                                                                                                   Female=1,
                                                                                                   Unknown=2
Language                String                          De iso code van de taal van de             Vb: “NL”, “FR”, …
                                                        gebruiker.
Picture                 Byte array                      De afbeelding van de gebruiker.            Wordt nog niet
                                                                                                   gebruikt.
Phone                   String                          Telefoon van de gebruiker.
CellPhone               String                          Mobiele telefoon van de gebruiker.
BankAccount             String                          Bankrekening nummer van de
                                                        gebruiker.


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
NationalNumber          String                          Bevolkings register nummer van de          Rijksregisternummer in
                                                        gebruiker.                                 België.
Comments                String                          Opmerkingen van de gebruiker.
Credential              Credential                      Aanmeldgegevens van de gebruiker.          Verplicht mee te
                                                                                                   geven.
IsBlocked               Boolean                         Geeft aan of de gebruiker al dan niet
                                                        geblokkeerd is.
Type                    PersonType                      Geeft aan om welk type het gaat:
                                                            -   Unknown
                                                            -   Individu
                                                            -   Group
                                                            -   Company
                                                            -   Location
                                                                                                                             117
                                                            -   Physician
Parent                  Boolean                         Geeft aan of de gebruiker al dan niet
                                                        een ouder is.
Disabled                Boolean                         Geeft aan of de gebruiker al dan niet
                                                        mindervalide is.
HeadOfFamily            Boolean                         Geeft aan of de gebruiker al dan niet
                                                        gezinshoofd is.
Relations               List<Relation>                  Gezinsrelaties van de gebruiker


12.6.2.5     PersonName
Naam                    Type                            Omschrijving                                         Opmerkingen

First                   String                          De voornaam van de gebruiker.
Middle                  String                          De tussennaam van de gebruilker.
Last                    String                          De familienaam van de gebruiker.


12.6.2.6     Address
Naam                    Type                            Omschrijving                                         Opmerkingen

Street                  String                          Straat Adres van de gebruiker.
Number                  String                          Nummer van het adres van de gebruiker.
Box                     String                          Bus van het adres van de gebruiker.
ZipCode                 String                          Postcode van het adres van de gebruiker.
Town                    String                          Stad van het adres van de gebruiker.
Country                 String                          Iso code van het land van het adres van de           Vb.: “BE”,
                                                        gebruiker.                                           “NL”, “FR”, …




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
12.6.2.7     Relation
Naam                    Type                            Omschrijving                                   Opmerkingen

Id                      Guid                            Unieke id van de relatie.
Person                  Person                          Person object van de gebruiker waarmee de
                                                        persoon een relatie heeft.
Type                    RelationType                    Geeft aan om welk type relatie het gaat:
                                                            -   Unknown
                                                            -   Household (=gezin)
                                                            -   Family (=familie)
                                                            -   Business (=bedrijfsrelatie)
Comment                 String                          Extra commentaar betreffende de relatie
                                                        tussen beide personen.

                                                                                                                       118

12.7     FINDCOUNTIES
Deze service is vooral bedoeld om daar waar een Provincie (County) nodig is, een geldige te kunnen
selecteren uit een lijst. Een voorbeeld is het populeren van een grid of listcontrol met provincies.


12.7.1     Request
De request bestaat uit de Service Context en een FindCountiesCriteria object.
Naam                    Type                            Omschrijving                                  Opmerkingen

Id                      Guid                            Id van een specifieke provincie               Nullable
                                                        (Als u doelbewust 1 entiteit wil ophalen).    (Indien niet
                                                                                                      van
                                                                                                      toepassing).
CountryId               Guid                            Id van het land waarvoor je de provincies     Nullable
                                                        wenst op te halen. Iedere provincie behoort   (Indien niet
                                                        tot een land.                                 van
                                                                                                      toepassing).
Paging                  PagingCriteria                  Zie 4.2 Paging Criteria


12.7.2     Response
De response zal een lijst van County objecten bevatten dat voldoet aan de criteria.
Het County object ziet er als volgt uit:
Naam                    Type                            Omschrijving                                  Opmerkingen

Id                      Guid                            Id van de provincie.
Code                    String                          Code van de provincie.
Description             String                          Omschrijving van de provincie.
Country                 Country                         Land waartoe de provincie behoort.            Zie 5.2.2 voor


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                                                          detail info
                                                                                          omtrent
                                                                                          Country
                                                                                          object.




12.8       CANCELRESERVATION
Deze methode annuleert één bepaalde zaalreservering.
Men kan via de webshop enkel reserveringen annuleren die:
       -    nog niet reeds geannuleerd zijn
       -    nog niet geboekt zijn


12.8.1      Request
De request is als volgt opgebouwd.                                                                         119

Naam                    Type                        Omschrijving                          Opmerkingen

ReservationId           Guid                        Id van de zaalreservering.
ReasonID                Guid                        De reden van annulatie.
ReasonDescriptio        String                      De omschrijving die men opgeeft bij
n                                                   annulatie.


12.8.2      Response
De response bevat een ValidationResult object. Dit object ziet er als volgt uit.
Naam                    Type                        Omschrijving                          Opmerkingen

BrokenRuleName          String                      Naam van de validatie regel.
Message                 String                      Foutboodschap.
IsValid                 Bool                        Regel is succesvol verwerkt.          True = success
                                                                                          False = fout




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
13 Module busvervoer
13.1    BEKNOPT OVERZICHT
Nieuwe busritten en busrit series kunnen aangevraagd worden via de Webshiop webservices
(= nieuwe aanvragen)
Het verdere beheer en planning gebeurt via ReCreateX.


Wijzigingen via de webshop zijn alleen toegelaten voor busritten en series waarvan de status op
"Requested" staat.
Van zodra er een planning is aangemaakt kunnen er geen wijzigingen meer gemaakt worden via de
Webshop, wel via ReCreateX.
Deleten en Cancellen van busritten en series is ook afhankelijk van de status: Zo kunnen ingeplande,
goedgekeurde of uitbestede ritten niet via de webshop gecancelled worden.
Deleten kan alleen maar als de busrit of de busritten van de serie reeds gecancelled zijn, afgekeurd zijn   120

of nog in status Requested.


Een aantal webservices zijn hiervoor aangemaakt:
- SaveBusTripRequest (behandeld zowel nieuwe als bestaande busritten)
- SaveBusTripSerieRequest (behandeld zowel nieuwe als bestaande busrit series)
- CancelBusTripRequest
- CancelBusTripSerieRequest
- DeleteBusTripRequest
- DeleteBusTripSerieRequest


Ter ondersteuning zijn ook een aantal extra services beschikbaar:
- ListCountries (Zie Ticket 104674)
- ListZipcodes (Zie Ticket 104674)
- ListZipcodeStreets (Zie Ticket 104674)
- ListBustripRequests (Zie Ticket 104674)
- GetBusTripSerieRequest (Zie Ticket 104674)


Reeds bestaande, maar ook gebruikt:
- FindPerson(Zie functionaliteit Authenticatie – Personen)



13.2    LISTCOUNTRIES
Deze service is vooral bedoeld om daar waar een Land (Country) nodig is, een geldige te kunnen
selecteren uit een lijst. Een voorbeeld is het populeren van een grid of listcontrol met landen.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
13.2.1     Request
De request bestaat uit de Service Context en een ListCountriesCriteria object
Naam                    Type                            Omschrijving                                Opmerkingen

Paging                  PagingCriteria                  Zie 4.2 Paging Criteria




13.2.1.1     Includes
Gezien het beknopte object “Land” (Country) bevat deze services geen Includes functionaliteit.


13.2.2     Response
De response zal een lijst van Landen (List<Country>) bevatten.
Naam                     Type                           Omschrijving                                Opmerkingen

Id                       Guid                           Id van de Reservation.
                                                                                                                  121

Code                     String                         2 Letter ReCreateX land code.
Name                     String                         Volledige naam van het land.



13.3     LISTZIPCODES
Deze service is bedoeld om een Zipcode (Postcode) te kunnen opzoeken, daar waar een Intern Id
(Guid) nodig is met een link naar de ReCreateX Database,
Een geldige zipcode kan worden geselecteerd uit een lijst, opzoeken kan via allerlei criteria.
Een voorbeeld is het populeren van een combobox of listbox met zipcodes, waarbij de lijst matches
bevat die voldoen aan de getypte letters. Om de zoekfunctie ook via partial matches te laten werken
dient er achter (en eventueel voor) een “%” teken geplaatst te worden. Deze dienen als wildchars.
Zonder wildchars wordt geprobeerd om een exacte match te vinden.


13.3.1     Request
De request bestaat uit de Service Context en een ZipcodesSearchCriteria object
Dit criteria bevat naast de paging te kunnen verzorgen bij lange lijsten , ook een Id waarmee
individuele Zipcodes kunnen worden opgevraagd op basis van hun Guid.
Verder kunnen er matches gevonden worden op (gedeeltelijke) zipcode en (gedeeltelijke) naam.
Naam                     Type                           Omschrijving                                Opmerkingen

Id                       Guid                           Id van de Zipcode.


ZipcodePattern           String                         Zipcodepatroon waarmee gematch moet
                                                        worden (Vergeet de % wildcard niet indien
                                                        partiele matchen ook meegenomen moeten
                                                        worden.)
CityNamePattern          String                         Naampatroon waarmee gematch moet


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                    worden (Vergeet de % wildcard niet indien
                                                    partiele matchen ook meegenomen moeten
                                                    worden.)
Street                  String                      Zoeken op straatnaam                        Gebruikt voor
Number                  Int?                        Zoeken op huisnummer                        zoeken naar
                                                                                                Nederlandse
                                                                                                postcodes
Paging                  PagingCriteria              Zie 4.2 Paging Criteria


13.3.1.1     Includes
Gezien het beknopte object “Zipcode” bevat deze services geen Includes functionaliteit.



13.3.2     Response                                                                                             122
De response zal een lijst van Zipcodes (List<Zipcode>) bevatten die voldoen aan de criteria.
Naam                    Type                        Omschrijving                                Opmerkingen

Id                      Guid                        Id van de zipcode..


Zip                     String                      Postcode.
City                    String                      Naam van de stad/gemeente.
Country                 Country                     Land waar de gemeente zich bevindt.


13.3.2.1     Country
Het object Country werd al eerder beschreven.
Zie 13.2.2

13.4     LISTZIPCODESTREETS
Deze service is bedoeld om straten behorend tot een bepaalde Postcode te kunnen opzoeken,
Straten kunnen opgezocht worden via de criteria: zipcode en naampatroon .
Een voorbeeld is het populeren van een combobox of listbox met straatnamen, waarbij de lijst matches
bevat die voldoen aan de getypte letters. Om de zoekfunctie ook via partial matches te laten werken
dient er achter (en eventueel voor) een “%” teken geplaatst te worden. Deze dienen als wildchars.
Zonder wildchars wordt geprobeerd om een exacte match te vinden.


13.4.1     Request
De request bestaat uit de Service Context en een ZipcodeStreetsSearchCriteria object
Dit criteria bevat naast de paging criteria, ook een Id waarmee individuele straten kunnen worden,
opgevraagd op basis van hun Guid.
Verder kunnen er matches gevonden worden op Zipcode Id en (gedeeltelijke) naam.
Naam                     Type                       Omschrijving                                Opmerkingen



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Id                       Guid                       Id van de Zipcode.


ZipcodeId                String                     ZipcodeId waarmee gematch moet worden.
                                                    (Beperkt de lijst van straten tot alleen deze met
                                                    de aangegeven Zipcode).
StreetNamePattern        String                     Postcodepatroon waarmee gematch moet
                                                    worden (Vergeet de % wildchars niet indien
                                                    partiele matchen ook meegenomen moeten
                                                    worden.)
IncludeZipcodes          Bool                       Moeten de verschillende postcodes waartoe
                                                    de straat behoort , mee in het response
                                                    worden gegeven.
Paging                   PagingCriteria             Zie 4.2 Paging Criteria
                                                                                                                          123

13.4.2      Response
De response zal een lijst van ZipcodeStraten (List< ZipcodeStreet>) bevatten die voldoen aan de
criteria.
Naam                    Type                        Omschrijving                                        Opmerkingen

Id                      Guid                        Id van de zipcode.


StreetName              String                      Straatnaam.
City                    String                      Naam van de stad/gemeente.
ZipCodes                IList<Zipcode>              Lijst van zipcodes van de gemeentes waar de         Afhankelijk
                                                    straat zich bevindt.                                van de
                                                                                                        IncludeZipco
                                                                                                        des setting bij
                                                                                                        de aanvraag.


13.4.2.1     Zipcode
Het object Zipcode werd al eerder beschreven.
Zie 13.3.2



13.5     LISTZIPCODECENDRISSTREETS
Deze service is bedoeld om adresdetails te kunnen opzoeken via postcode en huisnummer. Dit is de
gebruikelijke manier van opzoeken in Nederland.


13.5.1      Request
De request bestaat uit de Service Context en een ZipcodeCendrisStreetsSearchCriteria object
Dit criteria object biedt de mogelijkheid om te zoeken op (gedeeltelijke) postcode en huisnummer.



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Naam                     Type                       Omschrijving                                       Opmerkingen

ZipcodePattern           String                     Postcode waarmee gematcht moet worden.             Op deze 2
                                                                                                       criteria wordt
Number                   Int?                       Huisnummer waarmee gematcht moet                   in Nederland
                                                    worden.                                            steeds samen
                                                                                                       gezocht
Includes                 ZipcodeCendrisS            Include parameters voor het request (Welke
                         treetIncludes              extra objecten dienen meegenomen te
                                                    worden in het antwoord?)
Paging                   PagingCriteria             Zie 4.2 Paging Criteria


Het ZipcodeCendrisStreetIncludes object heeft slechts één parameter.
Naam                     Type                       Omschrijving                                       Opmerkingen
                                                                                                                        124
Zipcodes                 Bool                       Moeten de postcodes volledig opgevuld
                                                    worden in de response?
                                                        -   Ja : Alle info wordt beschikbaar (straat
                                                            / gemeente / zipcode / land)
                                                        -   Nee : Enkel straat en zipcode ID
                                                            worden teruggegeven.


13.5.2     Response
De response zal een lijst van ZipcodeCendrisStreet bevatten die voldoen aan de criteria.


Naam                    Type                        Omschrijving                                       Opmerkingen

Id                      Guid                        Unieke id.
Street                  String                      Straatnaam.
ZipcodeId               Guid                        Id van de zipcode.
ZipCodes                IList<Zipcode>              Detail informatie betreffende de gevonden          Afhankelijk
                                                    zipcodes (gemeente – postcode – land)              van de
                                                                                                       Zipcodes
                                                                                                       include
                                                                                                       setting bij de
                                                                                                       aanvraag.



13.6     GETBUSTRIPREQUEST
Deze service is bedoeld om een individuele busrit op te halen uit de Backoffice.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
13.6.1     Request
De request bestaat uit de Service Context en een Guid (Id) object.
Paging en zoekcriteria zijn hier niet relevant.
Naam                     Type                       Omschrijving                                      Opmerkingen

Id                       Guid                       Id van de Busrit die dient opgehaald te
                                                    worden.


13.6.2     Response
De response zal een busrit aanvraag (BusTripRequest) bevatten die de gevraagde Id als identifier heeft.
Naam                    Type                        Omschrijving                                      Opmerkingen

Id                      Guid                        Id van de zipcode.


BusTripNo               Long (Int64)                Busrit volgnummer.
                                                                                                                    125
ShortName               String                      Verkorte naam.
Description             String                      Omschrijving.
SeriesID                Guid                        Serie identifier.
SeriesNo                Long                        Serie volgnummer.
Requestor               Person                      Aanvrager.
ContactPerson           Contact                     Contactpersoon.
DepartureAddress        Adres                       Vertrekplaats.
DepartureDate           DateTime                    Vertrek tijdstip.
Time
ArrivalAddress          Address                     Aankomstplaats.
ArrivalDateTime         DateTime                    Aankomst tijdstip.
TotalDistance           Decimal                     Totale afstand (Heen en terug indien
                                                    terugkeren aan staat).
AlsoReturn              Bool                        De rit is zowel de heen reis als de terug reis.
ReturnDateTime          DateTime                    Terugkeer tijdstip.
ReturnedDate            DateTime                    Aankomst bij terugkeer.
Time
RequestDate             DateTime                    Aanvraag datum en tijdstip.
NumPersons              Int32                       Aantal passagiers (Zonder begeleiders en
                                                    chauffeur).
NumCompanions           Int32                       Aantal begeleiders.
ExtraLuggage            Bool                        Extra bagage moet worden meegenomen.
Comments                String                      Kommentaar / Opmerkingen.
Confirmed               Bool                        Bevestigd.
Status                  BustripStates               Status van de Busrit.



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
ModifiedFrom            Bool                          Deze Busrit werd gewijzigd door een update
Series                                                van een Busritserie.
IsTransfer              Bool                          De rit is een transfer.




13.6.2.1     Person
Het object Person werd al eerder beschreven.
7.11.2


13.6.2.2     Contact
Het object Contact werd al eerder beschreven.
0


13.6.2.3     Address                                                                                             126
Het object Address werd al eerder beschreven.
7.6.1.3


13.6.2.4     BustripStates
Enumeratie:
Requested = 0,
Planned = 1,
Rejected = 2,
Approved = 3,
CancelationRequested = 4,
Outsourced = 5,
Cancelled = 6



13.7      LISTBUSTRIPREQUESTS
Deze service is bedoeld om een lijst van busritten op te halen uit de Backoffice. Niet te verwarren met
de busritten die aan een specifieke serie zijn gekoppeld.


13.7.1     Request
De request bestaat uit de Service Context en een BusTripRequestSearchCriteria object.
Naam                    Type                          Omschrijving                                 Opmerkingen

Id                      Guid?                         Id van een specifieke busrit.                Nullable !


RequestorId             Guid?                         ReCreateX ID van de aanvrager.
NamePattern             String                        Naampatroon voor de omschrijving van de
                                                      busrit.



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
BusTripNo               Long (Int64)                Volgnummer van de busrit.
SeriesID                Guid?                       Serie ID van een mogelijke serie waaraan     Nullable !
                                                    busritten zouden gekoppeld kunnen zijn.
DepartureFrom           DateTime?                   Criteria Vertrekdatum/tijd van.
DateTime
DepartureTo             DateTime?                   Criteria Vertrekdatum/tijd tot.
DateTime
ArrivalFrom             DateTime?                   Criteria Aankomstdatum/tijd van.
DateTime
ArrivalToDateTime       DateTime?                   Criteria Aankomstdatum/tijd tot.
ReturnFrom              DateTime?                   Criteria Terugkeerdatum/tijd van.
DateTime
ReturnToDateTime        DateTime?                   Criteria Terugkeerdatum/tijd tot.
RequestFrom             DateTime?                   Criteria Aanvraagdatum/tijd van.
DateTime
RequestTo               DateTime?                   Criteria Aanvraagdatum/tijd tot.
DateTime                                                                                                         127
MinimumNumber           Int32                       Minimum aantal passagiers.
OfPersons
MaximumNumber           Int32                       Maximum aantal passagiers.
OfPersons
Includes                BusTripIncludes             Include parameters voor het request (Welke
                                                    extra objecten dienen meegenomen te
                                                    worden in het antwoord?)
Paging                  PagingCriteria              Zie 4.2 Paging Criteria


13.7.1.1     BusTripIncludes
Dit object wordt gebruikt om aan te geven welke optionele gerelateerde objecten mee worden
teruggegeven in het response.
Naam                    Type                        Omschrijving                                 Opmerkingen

Contacts                Bool                        Contactpersonen mee opnemen.
Persons                 Bool                        Aanvragers mee opnemen.
ConfirmedBustrips       Bool                        Alleen bevestigde busritten meenemen.        Combineer
UnConfirmed             Bool                        Alleen onbevestigde busritten meenemen.      beiden om
Bustrips
                                                                                                 alles weer te
                                                                                                 geven.
ExtraLugage             Bool                        Alleen busritten weergeven waarbij extra     Combineer
                                                    bagage moet meegenomen worden.               beiden om
NoExtraLugage           Bool                        Alleen busritten weergeven waarbij geen      alles weer te
                                                    bagage moet meegenomen worden.               geven.


13.7.2     Response
De response zal een lijst van busrit aanvragen (BusTripRequests) bevatten die beantwoorden aan het
zoekcriteria.


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
13.7.2.1     BusTripRequest
Zie 13.6.2


13.8     GETBUSTRIPSERIEREQUEST
Deze service is bedoeld om een individuele busrit serie op te halen uit de Backoffice.


13.8.1     Request
De request bestaat uit de Service Context en een Guid (SerieId) object.
Paging en zoekcriteria zijn hier niet relevant.
Naam                           Type                      Omschrijving                                          Opmerkingen

Id                             Guid                      SerieId van de Busritserie die dient opgehaald
                                                         te worden.


13.8.2     Response                                                                                                          128
De response zal een busrit serie aanvraag (BusTripSerieRequest) bevatten die de gevraagde Id als Serie
identifier heeft.
Naam                    Type                             Omschrijving                                          Opmerkingen

Id                      Guid                             Id van de zipcode.


SerieId                 Guid                             Serie ID van de serie.
SerieNo                 Long                             Serie volgnummer vande serie.
StartDate               DateTime                         Start datum van de reeks ritten onder deze
                                                         serie.
FromHour                DateTime                         Vertrek tijdstip van alle busritten onder de serie.
ToHour                  DateTime                         Aankomst tijdstip van alle busritten onder de
                                                         serie.
EndDate                 DateTime                         Einde datum van reeks busrutten.
Iterations              Int32                            Aantal iteraties (busritten) die aan de serie zijn
                                                         gekoppeld.
FrequencyType           FrequencyTypes                   Met welke frequency dienen de busritten te
                                                         worden uitgevoerd.
Frequency               SerieFrequency                   Dagelijkse, wekelijkse en maandelijkse
                                                         frequentie parameters.
WeekPattern             List                             Weekpatroon (patroon voor elke dag).
                        <WeekDayRange>
MonthPattern            SerieMonthPattern                Maandpatroon (patroon voor maandelijkse
                                                         busritten).
YearPattern             SerieYearPattern                 Jaarpatroon (patroon voor jaarlijkse busritten).
Dates                   List<DateTime>                   Lijst van datums waarop ritten worden


Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
                                                         uitgevoerd.
Bustrips                List<BusTripRequest>             Lijst van busritten die gekoppeld zijn aan deze
                                                         serie.


13.8.2.1     WeekDayRange
Een WeekDayRange wordt gebruikt om bij wekelijkse frequentie, de week parameters in te stellen.
Naam                    Type                             Omschrijving                                      Opmerkingen

Weekdays                WeekDays                         Dag van de week parameters.
Include                 Bool                             Deze dag van de week dient opgenomen te
                                                         worden in de serie range.
From                    DateTime                         Uitzondering op de reguliere vertrek en
                                                         aankomst uren (Van component).
To                      DateTime                         Uitzondering op de reguliere vertrek en
                                                                                                                         129
                                                         aankomst uren (Tot component).


13.8.2.2     SerieMonthPattern
Een SerieMonthPattern wordt gebruikt om bij Maandelijke frequentie, de maand parameters in te
stellen van de Serie.
Naam                    Type                             Omschrijving                                      Opmerkingen

DayOfTheWeek            WeekDays                         Dag van de week parameters.
DayOfTheMonth           Int32                            Dag van de maand parameters.


13.8.2.3     SerieYearPattern
Een YearMonthPattern wordt gebruikt om bij Jaarlijkse frequentie, de jaar parameters in te stellen van
de Serie.
Naam                    Type                             Omschrijving                                      Opmerkingen

DayOfTheWeek            WeekDays                         Dag van de week parameters.
DayOfTheMonth           Int32                            Dag van de maand parameters.
MonthNumber             Int32                            Nummer van de maand.


13.8.2.4     SerieFrequency
Een SerieFrequency is een combinatie object waarin de frequentie voor de verschillende types van
patronen voor de berekening van de busritten van de Serie wordt bijgehouden.
Naam                    Type                             Omschrijving                                      Opmerkingen

DayFrequency            Int32                            Frequentie voor dagpatronen.
WeekFrequency           Int32                            Frequentie voor weekpatronen.
Month                   Int32                            Frequentie voor maandpatronen.
Frequency



Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
13.8.2.5     WeekDays
Enumeratie die de dagen van de week beschrijft, echter met alleen relevante parameters.
Dummy = 0, (Datacontract serialisatie vereiste – niet gebruikt)
Undefined = -1,(Speciale betekenis: weekdag is niet relevant)
Monday = 1,
Tuesday = 2,
Wednesday = 3,
Thursday = 4,
Friday = 5,
Saturday = 6,
Sunday = 7


13.8.2.6     FrequencyTypes
Enumeratie die verschillende soorten frequenties aangeeft                                                     130

Daily = 0,
Weekly = 1,
Monthly = 2,
Yearly = 3.



13.8.2.7     BusTripRequest
Zie GetBusTripRequest …13.6.2



13.9     SAVEBUSTRIPREQUEST
Deze service is bedoeld om een individuele busrit aan te maken of een bestaande op te slaan in de
Backoffice.


13.9.1     Request
De request bestaat uit de BusTripRequest die dient opgeslaan te worden.
Dit kan een nieuwe busrit zijn (Id en BusTripNo nog default waarde) of een bestaande busrit (waarden
wel gekend. De service komt er zelf achter in welke case het zich bevindt. Er zijn echter voorwaarden
om een bestaande busrit te kunnen opslaan…
Naam                      Type                          Omschrijving                            Opmerkingen

BusTrip                   BusTripRequest                Busrit die dient opgeslaan te worden.


13.9.2     Response
De response zal een busrit aanvraag (BusTripRequest) bevatten die eventueel werd upgedate met de
resultaten van het opslaan (Bij een nieuwe busrit -> default waarden worden effectieve waarden).
Daarnaast worden ook eventuele validatiefouten (alle !) geretourneerd.
Naam                    Type                            Omschrijving                            Opmerkingen




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
SaveBusTrip             BusTrip                          Validatie resultaat + eventueel upgedate
Result                  Composite                        Busrit.
                        ValidationResult


13.9.2.1      BusTripCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie antwoorden en het eventuele
opgeslane resultaat (en de eventuele wijzigingen zoals een bestaand Id of Busrit volgnummer) terug te
kunnen geven.
Naam                    Type                             Omschrijving                                  Opmerkingen

BusTrip                 List                             Alle mislukte validatie resultaten.
Validation              <BusTripValidation               Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTrip                 BusTripRequest                   Busrit die opgeslaan is of met fouten
                                                                                                                     131
                                                         bevonden.


13.9.2.2      BusTripValidationResult (=afgeleid van ValidationResult)
Dit object wordt resultaat van een validatie gebruikt. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                             Omschrijving                                  Opmerkingen

BrokenRule              String                           Naam van de validatie regel.
Name
Message                 String                           Foutboodschap.
IsValid                 Bool                             Regel is succesvol verwerkt.


13.9.2.3      BusTripRequest
Zie 13.6.2.


13.10 SAVEBUSTRIPSERIEREQUEST
Deze service is bedoeld om een individuele busrit serie aan te maken of een bestaande op te slaan in
de Backoffice.


13.10.1 Request
De request bestaat uit de BusTripSerieRequest die dient opgeslaan te worden.
Dit kan een nieuwe serie zijn (Id, SerieID en SerieNo nog default waarde) of een bestaande serie
(waarden wel gekend. De service komt er zelf achter in welke case het zich bevindt.
Er zijn echter voorwaarden waaraan moet voldaan worden om een bestaande serie te kunnen
opslaan.
Naam                           Type                      Omschrijving                                  Opmerkingen

BusTrip                        BusTripSerie              Busrit serie die dient opgeslaan te worden.
                               Request



Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
13.10.2 Response
De response zal een busrit serie aanvraag (BusTripSerieRequest) bevatten die eventueel werd upgedate
met de resultaten van het opslaan (Bij een nieuwe busrit serie -> default waarden worden effectieve
waarden).
Daarnaast worden ook eventuele validatiefouten (alle !) geretourneerd.
Naam                    Type                            Omschrijving                                      Opmerkingen

SaveBusTripSerie        BusTripSerie                    Validatie resultaat + eventueel upgedate Busrit
Result                  Composite                       serie.
                        ValidationResult


13.10.2.1 BusTripCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie antwoorden en het eventuele
opgeslane resultaat (en de eventuele wijzigingen zoals een bestaand Id of Busrit volgnummer) terug te
                                                                                                                        132
kunnen geven.
Naam                    Type                            Omschrijving                                      Opmerkingen

BusTrip                 List                            Alle mislukte validatie resultaten.
Validation              <BusTripValidation              Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTripSerie            BusTripSerieRequest             Busrit serie die opgeslaan is of met fouten
                                                        bevonden.


13.10.2.2 BusTripValidationResult (=afgeleid van ValidationResult)
Dit object wordt resultaat van een validatie gebruikt. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                            Omschrijving                                      Opmerkingen

BrokenRule              String                          Naam van de validatie regel.
Name
Message                 String                          Foutboodschap.
IsValid                 Bool                            Regel is succesvol verwerkt.


13.10.2.3 BusTripSerieRequest
Zie 13.8.2



13.11 CANCELBUSTRIP
Deze service is bedoeld om een individuele busrit te annuleren (Status “Annuleren aangevraagd”).
Hierna wordt door de backoffice deze status eventueel na controle al of niet bevestigd in de status
“Geannuleerd” en de nodige acties getroffen die hiermee verband houden.
De mogelijkheid tot annuleren is verbonden aan voorwaarden.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
13.11.1 Request
De request bestaat uit de CancelId (Id van de Busrit) die geannuleerd dient te worden.


Naam                           Type                      Omschrijving                                       Opmerkingen

CancelId                       Guid                      Id van de Busrit die dient geannuleerd te
                                                         worden.


13.11.2 Response
De response zal een busrit aanvraag (BusTripRequest) bevatten die eventueel werd geannuleerd.
Daarnaast worden ook eventuele validatiefouten (alle !) geretourneerd.
Een succesvolle actie laat zich herkennen door:
     -     geen validatie fouten (BusTripValidationResults.Count = 0)
     -     Status = CancelRequested
                                                                                                                          133
Naam                    Type                             Omschrijving                                       Opmerkingen

CancelBusTrip           BusTripComposite                 Validatie resultaat + eventueel geannuleerde
Result                  ValidationResult                 Busrit.


13.11.2.1 BusTripCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie antwoorden en het eventuele
gewijzigde (status) resultaat terug te kunnen geven.
Naam                    Type                             Omschrijving                                       Opmerkingen

BusTrip                 List                             Alle mislukte validatie resultaten.
Validation              <BusTripValidation               Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTrip                 BusTripRequest                   Busrit die geannuleerd is of niet voldoet aan de
                                                         condities om te kunnen annuleren.


13.11.2.2 BusTripValidationResult (=afgeleid van ValidationResult)
Dit object geeft het resultaat van een validatie weer. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                             Omschrijving                                       Opmerkingen

BrokenRule              String                           Naam van de validatie regel.
Name
Message                 String                           Foutboodschap.
IsValid                 Bool                             Regel is succesvol verwerkt.


13.11.2.3 BusTripRequest
Zie 125




Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
13.12 CANCELBUSTRIPSERIE
Deze service is bedoeld om een alle busritten, gekoppeld aan een serie te annuleren (Status
“Annuleren aangevraagd”).
Hierna wordt door de backoffice deze status eventueel na controle al of niet bevestigd in de status
“Geannuleerd” en de nodige acties getroffen die hiermee verband houden.
De mogelijkheid tot annuleren is verbonden aan voorwaarden.


13.12.1 Request
De request bestaat uit de CancelSerieId (Id van de Busrit serie) die geannuleerd dient te worden.


Naam                           Type                      Omschrijving                                      Opmerkingen

CancelSerieId                  Guid                      Id van de Busrit serie die dient geannuleerd te
                                                         worden.
                                                                                                                         134

13.12.2 Response
De response zal een busrit aanvraag (BusTripRequest) bevatten die eventueel werd geannuleerd.
Daarnaast worden ook eventuele validatiefouten (alle !) geretourneerd.
Een succesvolle actie laat zich herkennen door:
     -     geen validatie fouten (BusTripValidationResults.Count = 0)
     -     Status = CancelRequested
Naam                    Type                             Omschrijving                                      Opmerkingen

CancelBusTrip           BusTripSerie                     Validatie resultaat + eventueel geannuleerde
SerieResult             Composite                        Busrit serie.
                        ValidationResult


13.12.2.1 BusTripSerieCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie antwoorden en het eventuele
gewijzigde (status) resultaat terug te kunnen geven.
Naam                    Type                             Omschrijving                                      Opmerkingen

BusTrip                 List                             Alle mislukte validatie resultaten.
Validation              <BusTripValidation               Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTripSerie            BusTripSerieRequest              Busrit serie die geannuleerd is of niet voldoet
                                                         aan de condities om te kunnen annuleren.


13.12.2.2 BusTripValidationResult (=afgeleid van ValidationResult)
Dit object geeft het resultaat van een validatie weer. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                             Omschrijving                                      Opmerkingen

BrokenRule              String                           Naam van de validatie regel.


Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
Name
Message                 String                           Foutboodschap.
IsValid                 Bool                             Regel is succesvol verwerkt.


13.12.2.3 BusTripSerieRequest
Zie 128


13.13 DELETEBUSTRIP
Deze service is bedoeld om een individuele busrit te verwijderen.
De mogelijkheid tot verwijderen is verbonden aan voorwaarden.


13.13.1 Request
De request bestaat uit de DeleteId (Id van de Busrit) die verwijderd dient te worden.
                                                                                                                          135
Naam                           Type                      Omschrijving                                       Opmerkingen

DeleteId                       Guid                      Id van de busrit die dient verwijderd te worden.


13.13.2 Response
Eeventuele validatiefouten (alle !) worden geretourneerd.
Een succesvolle actie laat zich herkennen door:
     -     geen validatie fouten (BusTripValidationResults.Count = 0)
     -     leeg Bustrip object (null)
Naam                    Type                             Omschrijving                                       Opmerkingen

DeleteBusTrip           BusTripComposite                 Validatie resultaat + eventueel lege busrit.
Result                  ValidationResult


13.13.2.1 BusTripCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie terug te kunnen geven.
Naam                    Type                             Omschrijving                                       Opmerkingen

BusTrip                 List                             Alle mislukte validatie resultaten.
Validation              <BusTripValidation               Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTrip                 BusTripRequest                   Busrit die niet voldoet aan de condities om te
                                                         kunnen verwijderen of leeg indien het
                                                         verwijderen succesvol was.


13.13.2.2 BusTripValidationResult (=afgeleid van ValidationResult)
Dit object geeft het resultaat van een validatie weer. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                             Omschrijving                                       Opmerkingen



Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
BrokenRule              String                           Naam van de validatie regel.
Name
Message                 String                           Foutboodschap.
IsValid                 Bool                             Regel is succesvol verwerkt.


13.13.2.3 BusTripRequest
Zie 125


13.14 DELETEBUSTRIPSERIE
Deze service is bedoeld om een alle busritten, gekoppeld aan een serie te verwijderen.
De mogelijkheid tot verwijderen is verbonden aan voorwaarden.


13.14.1 Request
De request bestaat uit de DeleteSerieId (Id van de Busrit serie) die geannuleerd dient te worden.                            136


Naam                           Type                      Omschrijving                                          Opmerkingen

DeleteSerieId                  Guid                      Id van de Busrit serie die dient verwijderd te
                                                         worden.


13.14.2 Response
De response zal eventuele validatiefouten (alle !) retourneren.
Een succesvolle actie laat zich herkennen door:
     -     geen validatie fouten (BusTripValidationResults.Count = 0)
     -     Leeg BusTripSerieRequest
Naam                    Type                             Omschrijving                                          Opmerkingen

DeleteBusTrip           BusTripSerie                     Validatie resultaat + eventueel lege busrit serie.
SerieResult             Composite
                        ValidationResult


13.14.2.1 BusTripSerieCompositeValidationResult
Dit object wordt als antwoord container gebruikt om alle validatie antwoorden en het eventuele
gewijzigde (status) resultaat terug te kunnen geven.
Naam                    Type                             Omschrijving                                          Opmerkingen

BusTrip                 List                             Alle mislukte validatie resultaten.
Validation              <BusTripValidation               Indien Count = 0 succesvolle validatie!
Results                 Result>
BusTripSerie            BusTripSerieRequest              Busrit serie die niet verwijderd is of niet voldoet
                                                         aan de condities om te kunnen annuleren.




Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
13.14.2.2 BusTripValidationResult (=afgeleid van ValidationResult)
Dit object geeft het resultaat van een validatie weer. De tekst geeft duiding over wat misgegaan is.
Naam                    Type                            Omschrijving                        Opmerkingen

BrokenRule              String                          Naam van de validatie regel.
Name
Message                 String                          Foutboodschap.
IsValid                 Bool                            Regel is succesvol verwerkt.


13.14.2.3 BusTripSerieRequest
Zie 128




                                                                                                          137




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
14 Werknemers
14.1     BEKNOPT OVERZICHT
Binnen de aankoop module wordt er gebruik gemaakt van werknemers om te bepalen op welke
objecten een gebruiker rechten heeft.
Via de onderstaande functies kunt U werknemers ophalen, en kunnen werknemers zich authenticeren
via de webservices, om daarna het Id van deze werknemer mee te geven in de diverse criteria
obejcten.


FindEmployees : Wordt gebruikt om werknemers op te zoeken
AuthenticateEmployee : Wordt gebruikt om een werknemer te authenticeren aan de hand van
credentials.


14.2     FINDEMPLOYEES                                                                                          138

Wordt gebruikt om een lijst van werknemers op te halen.


14.2.1     Request
Het FindEmployeesRequest bevat enerzijds het standaard ServiceContext object en anderzijds het
hieronder beschreven EmployeeSearchCriteria object.
Naam                    Type                      Omschrijving                                    Opmerkingen

Id                      Guid?                     Indien ingevuld : Het Id van de werknemer die   Nullable
                                                  men wenst op te zoeken
UserName                String                    Indien ingevuld : De webgebruikersnaam van
                                                  de werknemer die men wenst op te zoeken
Email                   String                    Indien ingevuld : Het email adres van de
                                                  werknemer die men wenst op te zoeken
IsBlocked               Bool?                     Indien ingevuld :                               Nullable
                                                  True om alleen de geblokkeerde werknemers
                                                  op te halen of
                                                  False om alleen de niet geblokkeerde
                                                  werknemers op te halen
Paging                  PagingCriteria            Zie 4.2 Paging Criteria
Includes                EmployeeInclud            Bepaalt welke delen van de werknemer mee
                        es                        opgehaald zullen worden.


LessonGroupId           Guid                      Haalt enkel de werknemers op die ingesteld
                                                  staan als instructeur van die bepaalde
                                                  lesgroep.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
14.2.1.1     EmployeeIncludes
Dit object laat toe om bepaalde delen van een werknemer al dan niet op te halen.
Naam                    Type                            Omschrijving                                    Opmerkingen

IncludeImage            Bool                            Haalt al dan niet de afbeelding van de
                                                        employee op.




14.2.2     Response
Het FindEmployeesResponse object bevat een lijst van Employee objecten die aan de bovenstaande
criteria voldoen.
Naam                      Type                      Omschrijving                                        Opmerkingen
                                                                                                                             139
Id                        Guid                      Het Id van de werknemer
Code                      String                    De code van de werknemer
Name                      PersonName                De naam van de werknemer
BirthDate                 DateTime?                 De geboortedatum van de werknemer                   Nullable
Gender                    Gender                    Het geslacht van de werknemer
Language                  String                    De ISO taalcode van de werknemer
Address                   Address                   De woonplaats van de werknemer
Phone1                    String                    Het telefoonnummer van de werknemer
Phone2                    String
Phone3                    String
Email                     String                    Het email adres van de werknemer
Comments                  String                    Vrij commentaar veld met extra informatie over de
                                                    werknemer.
Department                Department                De afdeling waartoe de werknemer behoort
                                                    Zie 14.2.3 Department
Function                  Function                  De functie van de werknemer binnen de
                                                    onderneming
                                                    Zie 14.2.4 Function
Credential                Credential                De username & paswoord combinatie van de
                                                    werknemer.


                                                    14.2.2.1   Zie onder andere 7.3.1
                                                               PersonChildCareInfo
                                                     Naam                     Type                Omschrijving

                                                     Id                       Guid                Unieke ID van de persoon



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                               School                      ChildCareSchool   Details betreffende de school van de
                                                                                             persoon

                                               Tariff                      ChildCareTariff   Details betreffende het tarief dat word
                                                                                             gebruikt bij de prijsberekening voor de
                                                                                             persoon

                                               LeaveAlone                  Bool              Mag het kind de opvang alleen
                                                                                             verlaten?

                                               HasMedication               Bool              Neemt het kind medicatie?

                                               MedicationName              String            Naam van de medicatie

                                               MedicationDose              String            Dosis van de medicatie

                                               MedicationExtraInfo         String            Extra informatie omtrent de medicatie

                                               HasAllergy                  String            Heeft het kind een allergie?

                                               AllergyName                 String            Naam van de allergie
                                                                                                                            140
                                               AllergyExtraInfo            String            Extra informatie omtrent de allergie

                                               OtherMedicalInfo            String            Extra algmene informatie omtrent de
                                                                                             medische gegevens


                                              14.2.2.2   ChildCareSchool
                                               Naam                        Type              Omschrijving

                                               Id                          Guid              De unieke Identifier van de schoo
                                               Code                        String            Code van de school
                                               Name                        String            De naam van de school
                                               Location                    AddressLocation   Locatie van de school




                                              14.2.2.3   ChildCareTariff
                                               Naam                        Type              Omschrijving

                                               Id                          Guid              De unieke Identifier van het tarief
                                               Code                        String            Code van het tarief
                                               Name                        String            Naam van het tarief
                                               Description                 String            Omschrijving van het tarief
                                              Credential
IsBlocked               Bool                  True indien de werknemer geblokkeerd is.
Picture                 Image                 Afbeelding van de werknemer


14.2.3     Department
Bevat de definitie van een werknemers afdeling.
Naam                    Type                  Omschrijving                                         Opmerkingen




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
Id                      Guid                  Het Id van het departement
Code                    Strring               De code van het departement
Name                    String                De naam van het departement




14.2.4     Function
Bevat de definitie van een werknemersfunctie. Dit is meestal de taakomschrijving van een werknemer
binnen de firma.
Naam                    Type                  Omschrijving                                                 Opmerkingen

Id                      Guid                  Het Id van de functie
Code                    Strring               De code van de functie
Name                    String                De naam van de functie

                                                                                                                                   141

14.3     AUTHENTICATEEMPLOYEE
AuthenticateEmployee wordt gebruikt om de credentials van een werknemer te valideren wanneer die
wenst in te loggen.


14.3.1     Request
Binnen de AuthenticateEmployeeRequest wordt naast het ServiceContext object enkel een Credential
object verwacht.


Naam                    Type                  Omschrijving

Credentials             14.3.1.1      Per     Bevat de username & paswoord combinatie men wenst te
                                      son     authenticeren.
                                      Chil
                                      dC      14.3.1.4   Zie onder andere 7.3.1 PersonChildCareInfo

                                      areI     Naam                       Type                       Omschrijving

                                      nfo      Id                         Guid                       Unieke ID van de persoon
                         Naam                  School Type                      Omschrijving
                                                                          ChildCareSchool                                     Opmerking
                                                                                                     Details betreffende de school van de
                                                                                               persoon
                         Id                              Guid                Unieke ID van de persoon
                                               Tariff                  ChildCareTariff         Details betreffende het tarief dat word
                         School                          ChildCareSchool     Details betreffende de school van de
                                                                                                     gebruikt bij de prijsberekening voor de
                                                                                   persoon
                                                                                                        persoon
                         Tariff                      ChildCareTariff               Details betreffende het tarief dat wordt
                                               LeaveAlone            Bool                               Mag het kind de opvang alleen
                                                                                   gebruikt bij de prijsberekening voor deze
                                                                                                        verlaten?
                                                                                   persoon
                                               HasMedication              Bool                          Neemt het kind medicatie?
                         LeaveAlone                  Bool                          Mag het kind de opvang alleen

                                               MedicationName             String verlaten?           Naam van de medicatie
                                             Bool
                         HasMedication MedicationDose                     String
                                                                                   Neemt het kind medicatie? de medicatie
                                                                                                   Dosis van




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
                                        MedicationExtraInfo
                           MedicationName     String                           String Naam van de medicatie
                                                                                                    Extra informatie omtrent de medicatie

                                                String
                           MedicationDoseHasAllergy                            String Dosis van de medicatie het kind een allergie?
                                                                                                       Heeft

                                          AllergyName
                           MedicationExtraInfo   String                        String Extra informatie omtrent de medicatie
                                                                                                        Naam van de allergie

                           HasAllergy                        String
                                                     AllergyExtraInfo          String Heeft het kind eenExtra informatie omtrent de allergie
                                                                                                         allergie?

                           AllergyName                     String
                                                     OtherMedicalInfo          String Naam van de allergie algmene informatie omtrent de
                                                                                                      Extra

                           AllergyExtraInfo                  String                                       medische gegevens
                                                                                        Extra informatie omtrent de allergie

                           OtherMedicalInfo      String                                 Extra algmene informatie omtrent de
                                        14.3.1.5 ChildCareSchool                        medische gegevens
                                                     Naam                      Type                      Omschrijving
                          14.3.1.2          Chil     Id                        Guid                      De unieke Identifier van de schoo
                                            dC       Code                      String                    Code van de school
                                            are      Name                      String                    De naam van de school
                                            Sch      Location                  AddressLocation           Locatie van de school
                                                                                                                                       142
                                            ool
                           Naam                              Type                       Omschrijving                              Opmerking

                           Id                                ChildCareTariff
                                                    14.3.1.6 Guid                       De unieke Identifier van de school
                           Code                      Naam String                                  Omschrijving
                                                                               Type Code van de school

                           Name                      Id      String            Guid De naam van de school Identifier van het tarief
                                                                                                 De unieke
                           Location                  Code    AddressLocationString Locatie van de school van het tarief
                                                                                                   Code                           Zie 9.5.2

                                                     Name                      String                    Naam van het tarief
                                                     Description               String                    Omschrijving van het tarief
                          14.3.1.3          Chil
                                                    Credential
                                            dC
                                            are
                                            Tari
                                            ff
                           Naam                              Type                       Omschrijving                              Opmerking

                           Id                                Guid                       De unieke Identifier van het tarief
                           Code                              String                     Code van het tarief
                           Name                              String                     Naam van het tarief
                           Description                       String                     Omschrijving van het tarief
                          Credential




14.3.2     Response
AuthenticateEmployeeResponse bevat een AuthenticationResult die aangeet of het authenticeren
geslaagd is.

Naam                    Type                            Omschrijving                                          Opmerkingen



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
HasSucceeded            Boolean                      Geeft aan of de gebruiker al dan niet
                                                     succesvol is geauthenticeerd.
Error                   AuthenticationError          Een enumeratie die de fout teruggeeft van het   Voor
                                                     authenticatieProces.                            securitydoel
                                                     Mogelijke waarden zijn :                        einden wordt
                                                            None                                    hier geen
                                                            InvalidParameters                       correcte
                                                            UnknownUser                             informatie in
                                                            BlockedUser                             geplaatst.
                                                            InvalidCredential
PersonId                Guid                         Het id van de geauthenticeerde gebruiker.



                                                                                                                     143




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
15 Aankoop module
15.1       INLEIDING
De webservices voor de aankoop module staan volledig los van het winkelmandje, omdat het hier
gaat over het aanmaken van inkoop orders, terwijl het winkelmandje uitsluitend verkopen bevat.


Toch wordt dit opgenomen in deze documentatie omdat deze webservices in hetzelfde pakket zijn
opgenomen.


Bij de verkoop webservices (BasketItems) is het toegestaan om anoniem te shoppen. Binnen de
aankoop webservices is dit niet toegelaten, omdat omwille van security heel wat zaken niet zichtbaar
kunnen zijn voor bepaalde eind-gebruikers.
Daarom is het in heel wat functies verplicht om een EmployeeId mee te geven. Indien de EmployeeId
niet wordt meegegeven, en de ReCreateX instellingen geven aan dat er moet gewerkt worden met             144

werknemers rechten binnen de aankoop module, dan zullen deze functies geen data teruggeven.


Dit betekent dat de webservices voor de aankoopmodule enkel gebruikt kunnen worden wanneer een
werknemer zich aanmeld in het systeem.
Werknemers kunnen niet aangemaakt worden in de webservices. Dit gebeurt in de backoffice.
Authenticatie is wel voorzien. Hiervoor gebruikt U de functies die beschreven zijn in het hoofdstuk 14
Werknemers.




Overzicht van de beschikbare functies :
           FindVendors : Ophalen van leveranciers
           FindVendorGroups : Ophalen van leveranciergroepen
           FindPurchaseArticles : Ophalen van artikelen die kunnen worden aangekocht
           FindStockLocations : Ophalen van voorraadlocaties
           FindPurchaseOrders : Ophalen van bestaande inkoop orders
           ValidatePurchaseOrder : Validatie van een inkoop order
           ValidatePurchaseLine : Validatie van een inkoop order lijn
           SavePurchaseOrder : Opslaan van een inkoop order
           DeletePurchaseOrder : Verwijderen van een inkoop order
           SavePurchaseLine : Opslaan van een inkoop order lijn
           DeletePurchaseLine : Verwijderen van een inkoop order lijn




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
15.2     FINDVENDORS
FindVendors wordt gebruikt om de lijst van de beschikbare leveranciers op te halen.


Het is aangeraden om deze functie pas op te roepen nadat een werknemers zich heeft
geauthenticeerd via de webservices, omdat de VendorSearchCriteria een optionele EmployeeId
verwacht.


Indien in ReCreateX aangegeven wordt dat er moet gewerkt worden met de rechten van de
werknemers op leveranciers, dan zal de lijst met leveranciers leeg zijn indien er geen geldig EmployeeId
wordt meegegeven in dit Request.
Daarom wordt het steeds aangeranden om de werknemer op voorhand te laten authenticeren en zijn
EmployeeId mee te geven in de volgende requests.


15.2.1     Request                                                                                                   145

Het request bestaat uit het basis context object en het hieronder beschreven VendorSearchCriteria.
Naam                    Type                       Omschrijving                                        Opmerkingen

Paging                  PagingCriteria             Zie 4.2 Paging Criteria
Id                      Guid                       Indien ingevuld : Het Id van de leverancier die
                                                   men wenst op te zoeken
Code                    String                     Code van de leverancier
NamePattern             String                     Indien ingevuld : Enkel leveranciers waarvan het
                                                   naam patroon voorkomt in de naam worden
                                                   teruggegeven.
VendorGroupID           Nullable<Guid>             Indien ingevuld, dan worden enkel de leveranciers
                                                   opgenomen die behoren tot de opgegeven
                                                   leveranciersgroep.
EmployeeId              Nullable<Guid>             Het Id van de ingelogde werknemer..
IncludeBlocked          Nullable<Bool>             Indien false, dan worden de geblokkeerde
                                                   leveranciers niet meegenomen.
                                                   Indien NULL of true, dan worden deze wel
                                                   meegenomen.
Includes                VendorIncludes             Include parameters voor het request (Welke extra    Zie 0
                                                   objecten dienen meegenomen te worden in het
                                                   antwoord?)




Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
15.2.1.1     VendorIncludes
Naam                          Type     Omschrijving

IncludeVendorContacts         Guid     Indien true, worden de contactpersonen van de leverancier
                                       meegenomen




15.2.2     Response
Het FindVendorsResponse object bevat een lijst van Vendors zoals hieronder beschreven :
Naam           Type                                       Omschrijving                               Opmer
                                                                                                     kingen

Id             Guid                                       Id van de leverancier
Code           String                                     De code van de leverancier
Name           String                                     De naam van de leverancier
                                                                                                              146
Name2          String                                     De bijkomende naam van de
                                                          leverancier
Address        Address                                    Zie 7.6.1.3 Address.
                                                          Bevat de adresgegevens van de
                                                          leverancier.
Phone1         String                                     Telefoonnummer van de leverancier
Phone2         String
Phone3         String
Fax            String                                     Het faxnummer van de leverancier
Languag        String                                     De iso taal code van de leverancier
e
VatNo          String                                     Het BTW nummer van de leverancier
BankAc         String                                     Het rekeningnummer van de
count1                                                    leverancier
BankAc         String
count2
Email          String                                     Het email adres van de leverancier
Email2         String
WebSite        String                                     Het URL adres van de website van de
                                                          leverancier
Comme          String                                     Commentaarveld met vrije informatie
nt                                                        over de leverancier.
InvoiceV       Nullable<Guid>                             Het Id van de facturatie leverancier.
endorId                                                   Standaard is dit dezelfde Id als de
                                                          leverancier zelf, maar dit kan eventueel


Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
                                                           afwijken wanneer aankopen bij
                                                           leverancier A gefactureerd worden
                                                           door leverancier B.
VendorSt                                                   De status van de leverancier
ate              Vendor    VendorGro          De groep     Zie 15.2.2.1

                 Group     up                 van           Vendor        VendorGro     De groep
                                              leveranci     Group         up            van
                                              ers tot                                   leveranci
                                              dewelkd                                   ers tot
                                              e deze                                    dewelkd
                                              leveranci                                 e deze
                                              er                                        leveranci
                                              behoort.                                  er
                                                                                                     147
                                              Zie                                       behoort.
                                              15.2.2.2                                  Zie
                                              VendorG                                   15.2.2.2
                                              roup                                      VendorG

                 Vendor    Long               Het                                       roup

                 No                           identifica    Vendor        Long          Het
                                              tie           No                          identifica
                                              nummer                                    tie
                                              van de                                    nummer
                                              leveranci                                 van de
                                              er.                                       leveranci

                 VatRegi   VatRegime          Het BTW                                   er.

                 me                           regime        VatRegi       VatRegime     Het BTW
                                              waarond       me                          regime
                                              er deze                                   waarond
                                              leveranci                                 er deze
                                              er valt.                                  leveranci
                                              Zie                                       er valt.
                                              15.2.2.3                                  Zie
                                              VatRegi                                   15.2.2.3
                                              me                                        VatRegi

                 Vendor    Ilist<Vendo        De lijst                                  me

                 Contact   rContact>          van           Vendor        Ilist<Vendo   De lijst
                 s                            contact       Contact       rContact>     van
                                              personen      s                           contact
                                              voor                                      personen


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                               deze                                        voor
                                               leveranci                                   deze
                                               er                                          leveranci
                                               Zie                                         er
                                               15.2.2.5                                    Zie
                                               VendorC                                     15.2.2.5
                                               ontact                                      VendorC
                                                                                           ontact
               VendorState
                                                                VendorState
Vendor         VendorGroup                                      De groep van leveranciers tot
Group                                                           dewelkde deze leverancier behoort.
                                                                Zie 15.2.2.2 VendorGroup
                                                                                                                      148
VendorN        Long                                             Het identificatie nummer van de
o                                                               leverancier.
VatRegi        VatRegime                                        Het BTW regime waaronder deze
me                                                              leverancier valt.
                                                                Zie 15.2.2.3 VatRegime
VendorC        Ilist<VendorContact>                             De lijst van contactpersonen voor deze
ontacts                                                         leverancier
                                                                Zie 15.2.2.5 VendorContact




15.2.2.1     VendorState
VendorState bevat de definitie van de leverancier status.
Dit kan bijvoorbeeld Actief, Stopgezet, Geblokkeerd, ... zijn


Naam            Type     Omschrijving                                                                  Opmerkingen

Id              Guid     Id van de leverancierstatus
Code            String   De code van de leverancierstatus
Name            String   De naam van de leverancierstatus
IsBlocked       Bool     Indien True, dan duidt dit erop dat leveranciers met deze status
                         geblokkeerd zijn.




15.2.2.2     VendorGroup
VendorGroup bevat de definitie van een leveranciersgroep.
Naam                       Type                      Omschrijving                                       Opmerkingen




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
Id                       Guid                      Id van de leveranciersgroep
Code                     String                    De code van de leveranciersgroep
Name                     String                    De naam van de leveranciersgroep




15.2.2.3     VatRegime
VatRegime bevat de definitie van het BTW regime dat van toepassing is, in dit geval op de leverancier.
Naam                     Type                      Omschrijving                                      Opmerkingen

Id                       Guid                      Id van het BTW regime
Code                     String                    De code van het BTW regime
Name                     String                    De naam van het BTW regime
Vat                      Vat                       Het BTW tarief van toepassing in dit BTW regime
                                                   Zie 15.2.2.4 Vat
                                                                                                                   149



15.2.2.4     Vat
Vat bevat de definitie van een BTW tarief
Naam                     Type                      Omschrijving                                      Opmerkingen

Id                       Guid                      Id van het BTW tarief
Name                     String                    De naam van het BTW tarief
Value                    Decimal                   De procentuele waarde van het BTW tarief




15.2.2.5     VendorContact
Naam                     Type                      Omschrijving                                      Opmerkingen

Id                       Guid                      Id van de contactpersoon
Name                     String                    De naam van de contactpersoon
Functions                String                    De functie van de contactpersoon bij de
                                                   leverancier
Phone1                   String                    Het eerste telefoonnummer van de
                                                   contactpersoon.
Phone2                   String                    Het tweede telefoonnummer van de
                                                   contactpersoon.
Phone3                   String                    Het derde telefoonnummer van de
                                                   contactpersoon.
Fax                      String                    Het faxnummer van de contactpersoon
Email                    String                    Het email adres van de contactpersoon
Comment                  String                    Vrij commentaar ivm de contactpersoon



Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
                                                 150




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
15.3     FINDVENDORSGROUPS
FindVendorGroups wordt gebruikt om de leveranciergroepen op te halen.
Net als bij de FindVendors functie wordt hier ook gebruik gemaakt van het EmployeeId om enkel die
groepen op te halen waartoe de gebruiker rechten heeft.


15.3.1     Request
Het request bestaat uit het basis context object en het hieronder beschreven
VendorGroupSearchCriteria.

Naam                    Type                      Omschrijving                                   Opmerkingen

Paging                  PagingCriteria            Zie 4.2 Paging Criteria
Id                      Guid                      Indien ingevuld : Het Id van de                Nullable
                                                  leveranciersgroep die men wenst op te zoeken
Code                    String                    Code van de leveranciersgroep
                                                                                                               151
NamePattern             String                    Indien ingevuld : Enkel leveranciersgroepen
                                                  waarvan het naam patroon voorkomt in de
                                                  naam worden teruggegeven.
EmployeeId              Nullable<Guid>            Het Id van de ingelogde werknemer..




15.3.2     Response
Het FindVendorGroupsResponse object bevat een lijst van het VendorGroup object die aan
bovenstaande criteria voldoen.

Zie 15.2.2.2 VendorGroup voor een beschrijving van dit object.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
15.4     FINDPURCHASEARTICLES
FindPurchaseArticles wordt gebruikt om de artkels op te halen die een gebruiker kan aankopen.


15.4.1     Request
Het FindPurchaseArticlesRequest object bevat naast het basis ServiceContext object een
PurchaseArticleSearchCriteria object waarin de criteria kunnen worden opgegeven voor het ophalen
van de artikelen die kunnen worden aangekocht.

Naam                    Type                           Omschrijving                                 Opmerkingen

Paging                  PagingCriteria                 Zie 4.2 Paging Criteria
ArticleId               Guid                           Indien ingevuld : Het Id van het artikel     Nullable
                                                       die men wenst op te zoeken
ArticleGroupId          Guid                           Indien ingevuld : haalt enkel de artikels    Nullable
                                                       op die behoren tot de opgegeven
                                                       artikelgroep                                               152

NamePattern             String                         Indien ingevuld : haalt enkel die artikels
                                                       op waarvan het opgegeven patroon
                                                       voorkomt in de naam van het artikel
ArticleCategoryId       Guid                           Indien ingevuld : haalt enkel die artikels   Nullable
                                                       op die gekoppeld zijn aan de
                                                       opgegeven categorie
EmployeeId              Guid                           De werknemer waarvoor de rechten op          Nullable
                                                       artikels moeten worden gecontroleerd.
Includes                PurchaseArticleIncludes        Include parameters voor het request
                                                       Welke extra objecten dienen
                                                       meegenomen te worden in het
                                                       antwoord?


Opmerkingen :
Net als bij de FindVendors functie wordt hier ook gebruik gemaakt van het EmployeeId om enkel die
artikels op te halen waartoe de gebruiker rechten heeft.


Indien de inkoop parameters binnen ReCreateX aangeven dat er moet gewerkt worden met de
werknemers rechten op artikelgroepen, en de werknemer is niet opgegeven in het criteria object, dan
zal de resultset leeg zijn.


Indien de inkoop parameters binnen ReCreateX aangeven dat er niet moet gewerkt worden met de
werknemers rechten op artikelgroepen, dan gebeuren er geen bijkomende testen op de zichtbaarheid
van de artikels voor de werknemer. In dat geval is EmployeeId niet verplicht mee te geven.




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
De Id van de werknemer kan opgehaald worden door gebruik te maken van de functies
FindEmployees (zie 14.2) of AuthenticateEmployee (zie 14.3).


Behalve de bovenstaande criteria worden er bijkomende testen, die de zichtbaarheid binnen de
webservices bepalen, uitgevoerd bij het ophalen van de artikels :
      Het artikel mag niet geblokkeerd zijn
      Het vinkje “Weergeven op website” moet aanstaan
      De grootboekrekening voor het registreren van de aankoop moet ingevuld zijn
      Het artikel moet kunnen aangekocht worden bij minstens 1 leverancier.
       Merk op dat de leverancierstatus niet geblokkeerd mag zijn en dat de gebruiker rechten moet
       hebben op de leverancier.
      De gebruikte artikel eenheden (prijseenheid & aankoopeenheid) in de aankoopprijzen moeten
       bestaan
      Er moet een voorraad locatie bestaan waar het artikel in stock kan worden genomen



15.4.1.1     PurchaseArticleIncludes
Naam                    Type     Omschrijving                                              Opmerkingen            153
ImageUrl                bool     Moet de ImageUrl voor het artikel worden opgebouwd ?
Image                   Bool     Moet de afbeelding van het artikel worden opgehaald ?
ArticleCategories       Bool     Moeten de artikel categoriën worden opgehaald ?
ArticleGroup            Bool     Moeten de artikelgroepen worden opgehaald ?
StockLocations          Bool     Moeten de voorraadlocaties worden opgehaald ?
Vendors                 Bool     Moeten de leveranciers worden opgehaald ?
ArticleUnits            Bool     Moeten de eenheden worden opgehaald ?



15.4.2     Response
Het FindPurchaseArticlesResponse object bevat een lijst van PurchaseArticle objecten die aan
bovenstaande criteria voldoen.

Naam                           Type                           Omschrijving

Id                             Guid                           De Unieke identifier van het Article.
Code                           String                         De code van het Article.
Name                           String                         De naam van het Article.
Description                    String                         De omschrijving van het Article.
Price                          Decimal                        De verkoopprijs van het Article op vandaag,
                                                              zonder rekening te houden met prijsgroepen.
Stock                          Decimal                        Het huidig aantal in voorraad.
                                                              Indien in de request een voorraadlocatie is
                                                              opgegeven, dan bevat dit enkel het aantal
                                                              voorradig op de huidige voorraadlocatie.
                                                              Indien geen voorraadlocatie is opgegeven, dan
                                                              bevat dit het totaal aantal artikels op voorraad,



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                    over alle locaties heen.
Image                    Picture                    De afbeelding van het Article.
ImageUrl                 string                     De link waarop een image terug te vinden is van
                                                    het ArticleGroup.
IsRental                 Bool                       Geeft aan of het artikel een verhuurartiel is of
                                                    niet.
Group                    ArticleGroup               De ArticleGroup waartoe het artikel behoort.
IsStockItem              Bool                       Geeft aan of het artikel een voorraadartikel is of
                                                    niet.
DivisionId               Guid                       De financiële divisie waartoe het artikel behoort.
                                                    Verkopen van dit artikel worden geboekt op
                                                    deze divisie.
Ingredients              IList<ArticleIngredient>   De lijst van ingrediënten waaruit dit artikel
                                                                                                          154
                                                    bestaat.
Options                  IList<ArticleOption>       De exclusieve opties waaruit kunnen gekozen bij
                                                    het verkopen van dit artikel.
StockLocations           IList<StockLocation>       De voorraad locaties waar dit artikel
                                                    beschikbaar is.
Categories               IList<Category>            De lijst van categorieën waartoe dit artikel
                                                    behoort. De categorieën kunnen een hierarchy
                                                    delen onderling.
PurchaseArticle          PurchaseArticle            De berekeningswijze voor het berekenen van de
CalculationType          CalculationType            totale prijs. Dit is één van de onderstaande
                                                    enumeratie waardes :
                                                            PriceTimesHours
                                                            FixedPrice,
                                                            PriceTimesQuantity,
                                                            PriceTimesQuantityTimesHours
Vendors                  IList<VendorArticle>       De lijst van leveranciers waarbij dit artikel kan
                                                    gekocht worden. Zie 15.4.2.1 VendorArticle voor
                                                    een beschrijving van dit object.
BaseUnit                 ArticleUnit                De basis eenheid van het artikel. Dit is de kleinst
                                                    mogelijke eenheid van een artikel, en is meestal
                                                    de eenheid die gebruikt wordt voor de
                                                    berekening van de voorraad.
                                                    Zie 15.4.2.2 ArticleUnit voor de beschrijving van
                                                    dit object.
ArticleUnits             IList<ArticleUnit>         De eenheden die bruikbaar zijn voor dit artikel.



Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
15.4.2.1     VendorArticle
Een zelfde artikel kan meestal aangekocht worden bij verschillende leveranciers.
Dit object bevat per artikel / leverancier combinatie, de prijs van het artikel en de eenheden.


Eenheden :
Stel dat we een artikel “Jupiler 33 cl.” hebben, waarvan de basiseenheid “Fles” is.
De leverancier zal meestal de prijs opgeven per bak. In dat geval zal de Prijseenheid verwijzen naar een
ArticleUnit met als defintiie “BAK”.
Daarnaast is het bvb. mogelijk dat wanneer we bier aankopen bij leverancier Inbev, we dit steeds per
pallet bestellen. In dat geval zal de PurchaseUnit verwijzen naar een ArticleUnit met als definitie “Pallet”.


Naam                          Type                                   Omschrijving                                         155
VendorId                      Guid                                   Het Id van de leverancier
Price                         Decimal                                De prijs van het artikel bij deze leverancier voor
                                                                     de onderstaande prijseenheid.
PriceUnit                     ArticleUnit                            De prijseenheid, dit is de eenheid die gebruikt
                                                                     wordt om de prijs te bepalen
PurchaseUnit                  ArticleUnit                            De aankoopeenheid. Wanneer we dit artikel
                                                                     aankopen bij bovenstaande leverancier, dan is
                                                                     dit de eenheid die wordt aangekocht.




15.4.2.2     ArticleUnit
ArticleUnit beschrijft de verpakkingseenheid van een artikel, en de verhouding ten opzichte van de
basiseenheid.


Naam                          Type             Omschrijving

Id                            Guid             Het Id van de eenheid
Code                          String           De code van de verpakkingseenheid
Name                          Name             De naam van de verpakkingseenheid
BaseQuantity                  Decimal          Het aantal basiseenheden die vervat zitten in deze eenheid.
                                               Indien de basiseenheid van het artikel bvb. Fles is, en er zitten 24
                                               flessen in een Bak, dan zal BaseQuantity 24 zijn voor de ArticleUnit
                                               “Bak”




Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
15.5     FINDSTOCKLOCATIONS
Deze functie geeft de lijst met voorraad locaties terug.
De lijst kan beperkt worden tot de locaties voor 1 specifiek artikel, en houdt rekening met de rechten
van een werknemer op voorraad locaties.


Indien de inkoop parameters in ReCreateX aangeven dat er gewerkt wordt met werknemers rechten
op voorraad locaties, dan moet het Id van de werknemer worden meegegeven, anders zal de resultset
van deze functie leeg zijn.


15.5.1     Request
De FindStockLocationsRequest bevat het basis ServiceContext object enonderstaand
StockLocationSearchCriteria object


Naam                     Type                    Omschrijving
                                                                                                                    156
Paging                   PagingCriteria          Zie 4.2 Paging Criteria
ArticleId                Guid?                   Indien ingevuld, het Id van het artikel waarvoor men de voorraad
                                                 locaties wenst op te halen.
EmployeeId               Guid?                   Het Id van de werknemer waarvoor men de voorraad locaties
                                                 wenst op te halen.




15.5.2     Response
Het FindStockLocationsResponse object bevat een lijst van StockLocation objecten.


Naam                     Type                    Omschrijving

Id                       Guid                    Het Id van de voorraad locatie
Code                     String                  De code van de voorraad locatie
Description              String                  De omschrijving van de voorraad locatie




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
15.6     FINDPURCHASEORDERS
Deze functie wordt gebruikt om bestaande inkoop orders op te halen.
Dit kan nuttig zijn om de bestelhistoriek van een werknemer op te halen, zodat hij eventueel nog
wijzigingen kan aanbrengen aan bestaande bestellingen.


15.6.1     Request
Het FindPurchaseOrdersRequest object bevat naast het basis ServiceContext object, ook onderstaand
PurchaseOrderSearchCriteria object waarin kan aangegeven worden welke orders moeten worden
opgehaald.

Naam                    Type                      Omschrijving

Includes                PurchaseOrderIncludes     Include parameters voor het request Welke extra objecten
                                                  dienen meegenomen te worden in het antwoord?
Paging                  PagingCriteria            Zie 4.2 Paging Criteria
PurchaseId              Guid?                     Indien ingevuld, haalt enkel het inkoop order op voor dit     157
                                                  specifiek order Id.
OrderNo                 String                    Indien ingevuld, haalt enkel het order op met dit specifiek
                                                  order nummer.
Reference               String                    Indien ingevuld, haalt enkel die orders op waarvan de
                                                  opgegeven waarde voorkomt in de referentie.
EmployeeId              Guid?                     Indien ingevuld, haalt enkel die orders op die aangemaakt
                                                  zijn door de opgegeven werknemer.
VendorId                Guid?                     Indien ingevuld, haalt enkel die orders op die aangemaakt
                                                  zijn voor de opgegeven leverancier.
FromCreationDate        DateTime?                 Indien ingevuld, haalt enkel die orders op die aangemaakt
                                                  zijn na de opgegeven datum
TillCreationDate        DateTime?                 Indien ingevuld, haalt enkel die orders op die aangemaakt
                                                  zijn voor de opgegeven datum
ArticleId               Guid?                     Indien ingevuld, haalt enkel die orders op die orderlijnen
                                                  bevatten voor het opgegeven artikel.




15.6.2     Response
Het FindPurchaseOrdersResponse object bevat een lijst van PurchaseOrder objecten die voldoen aan
de bovenstaande criteria.



15.6.2.1     PurchaseOrderRequest
PurchaseOrderRequest is het basisobject wat gebruikt kan worden om nieuwe orders aan te maken.
PurchaseOrder is hiervan afgeleid en bevat dezelfde velden + een aantal extra velden die gebruiker
zelf niet kan wijzigen. Deze worden door de backoffice beheerd.



Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
Naam                         Type             Omschrijving

Id                           Guid             Het uniek Id van het purchaseOrder
EmployeeId                   Guid             Het uniek Id van de werknemer die het order heeft aangemaakt.
Reference                    String           Een vrij info veld wat gebruikt wordt om een door de gebruiker
                                              gedefinierde referentie bij te houden.
VendorId                     Guid             Het unieke Id van de leverancier voor wie dit order bedoeld is.
VendorContactId              Guid?            Het uniek Id van de contactpersoon bij bovenstaande leverancier.
PublicComment                String           Vrij commentaar veld. De inhoud van dit veld wordt meestal mee
                                              afgedrukt op de bestelbon die naar de leverancier wordt gestuurd.
PrivateComment               String           Vrij commentaar veld. De inhoud van dit veld wordt niet afgedrukt
                                              op de bestelbon en is meer als intern commentaar bedoeld.
RequestedDeliveryDate        DateTime?        De gewenste leveringsdatum van de bestelling.

                                                                                                                          158


15.6.2.2     PurchaseOrder
PurchaseOrder is een uitbreiding op PurchaseOrderRequest, en bevat dezelfde basisvelden, waaraan
de onderstaande velden zijn toegevoegd.
Dit zijn velden die enkel in de backoffice instelbaar zijn.
Naam                      Type                        Omschrijving

OrderNo                   String                      Het uniek volgnummer van de bestelbon in de backoffice
OrderState                PurchaseOrderState          De status van deze bestelling in de backoffice.
                                                      Dit is een enumeratie die één van de volgende waardes
                                                      kan bevatten :
                                                              ToBeOrdered : Moet nog besteld worden
                                                              Ordered : Is besteld
                                                              PartiallyReceived : Gedeeltelijk ontvangen
                                                              EntirelyReceived : Volledig ontvangen
                                                              ToApprove : Moet nog worden goedgekeurd
                                                              Rejected : Afgekeurd
PostingDate               DateTime                    Datum waarop de bestelling plaatsvond
CreationDate              DateTime                    Datum waarop het order werd aangemaakt
PromisedDeliveryDate      DateTime                    Beloofde leveringsdatum
PurchaseLines             IList<PurchaseLine>         Bevat orderlijnen voor dit order.
                                                      1 orderlijn is een bestelling voor 1 artikel bij een leverancier.
                                                      Zie 15.6.2.4 PurchaseLine




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
15.6.2.3     PurchaseLineRequest
PurchaseLineRequest is het basis object dat gebruikt wordt in de webservices om orderlijnen toe te
voegen aan een bestelling.


PurchaseLine is hiervan afgeleid en bevat de extra velden die automatisch worden ingevuld en enkel in
de backoffice kunnen worden gewijzigd.


1 PurchaseLineRequest (en dus ook PurchaseLine) komt overeen met de bestelling van 1 artikel bij 1
leverancier.


Naam                    Type           Omschrijving

Id                      Guid           Het uniek Id van de orderlijn.
PurchaseId              Guid           Het Id van de bestelling tot dewelke deze lijn behoort.
                                                                                                                         159
                                       Zie 15.6.2.2 PurchaseOrder
ArticleId               Guid           Het Id van het artikel wat besteld moet worden
Description             String         De omschrijving van het artikel wat aangekocht wordt.
                                       Indien dit wordt leegelaten, dan wordt bij het bewaren van de bestellijn
                                       dit veld automatisch ingevuld met het omschrijvingsveld van het artikel.
Description2            String         De bijkomende omschrijving van het artikel wat aangekocht wordt.
                                       Indien dit wordt leegelaten, dan wordt bij het bewaren van de bestellijn
                                       dit veld automatisch ingevuld met het bijkomend omschrijvingsveld van
                                       het artikel.
PurchaseUnitId          Guid           De (verpakkings)eenheid van het artikel die men wenst aan te kopen.
                                       Dit komt overeen met het Id van de gekozen ArticleUnit.
                                       Zie 15.4.2.2 ArticleUnit
Quantity                Decimal        Het aantal van de bovenstaande eenheden wat men wenst te
                                       bestellen.
                                       Het opgegeven aantal zal mee de prijs bepalen indien de
                                       berekeningswijze PriceTimesQuantity of PriceTimesQuantityTimesHours is.
StockLocationId         Guid?          De voorraad locatie waarvoor men dit artikel wenst te bestellen.
                                       Dit is verplicht in te vullen indien het artikel een voorraad artikelis, en mag
                                       niet ingevuld worden wanneer het artikel geen voorraad artikel is.
Hours                   Decimal?       Het aantal uur wat men wenst aan te kopen.
                                       Dit wordt hoofdzakelijk gebruikt wanneer men diensten aankoopt in
                                       plaats van goederen.
                                       De prijs zal mee bepaald worden door deze waarde indien de
                                       berekeningswijze van het artikel PriceTimesHours of
                                       PriceTimesQuantityTimesHours is.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
15.6.2.4     PurchaseLine
PurchaseLine is afgeleid van het basisobject PurchaseLineRequest en bevat dezelfde basisvelden + de
extra velden die automatisch worden ingevuld en enkel in de backoffice kunnen worden gewijzigd.
Naam                        Type                             Omschrijving

QtyPerPurchaseUnit          Decimal                          Het aantal basiseenheden per aankoopeenheid
QuantityBase                Decimal                          Het totaal aantal bestelde basiseenheden
                                                             Dit is het resultaat van Quantity x
                                                             QtyPerPurchaseUnit
QtyReceivedBase             Decimal?                         Het totaal aantal basiseenheden die reeds
                                                             ontvangen zijn voor deze bestelregel.
UnitPrice                   Decimal?                         De eeheidsprijs exclusief BTW
UnitPriceInc                Decimal?                         De eenheidsprijs inclusief BTW
VatId                       Guid?                            De Id van het BTW tarief die van toepassing is         160
                                                             voor dit artikel.
                                                             Dit kan verschillen in functie van de gekozen
                                                             leverancier.
VatPercentage               Decimal?                         Het BTW % van toepassing voor dit artikel.
VatAmount                   Decimal?                         Het bedrag van de BTW
DiscountPercentage          Decimal?                         Het toegestane kortingspercentage
DiscountAmount              Decimal?                         Het bedrag van de korting
LineAmount                  Decimal?                         Het netto bedrag van deze bestellijn :
                                                             (Aantal x eenheidsprijs excl. BTW) - korting
BaseAmount                  Decimal?                         Het bruto bedrag van deze bestellijn :
                                                             (Aantal x eenheidsprijs excl. BTW)
Amount                      Decimal?                         Het totaal bedrag van deze bestellijn incl. BTW
                                                             LineAmount + VatAmount
IsVatInclusive              Boolean?                         Geeft aan of de artikelprijs incl. of exc. BTW wordt
                                                             bijgehouden
PriceCalculationType        PurchaseArticleCalculationType   De gebruikte berekeningswijze voor het bepalen
                                                             van de prijs :
                                                                  PriceTimesHours
                                                                  FixedPrice,
                                                                  PriceTimesQuantity,
                                                                  PriceTimesQuantityTimesHours




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
15.7     VALIDATEPURCHASEORDER
Deze functie wordt gebruikt om een bestelling te valideren voordat deze wordt bewaard.


15.7.1     Request
Het ValidatePurchaseOrderRequest object bevat het basis ServiceContext object en het te valideren
PurchaseOrderRequest object.

Zie 15.6.2.1 voor een beschrijving van het PurchaseOrderRequest object.

Deze functie kan gebruikt worden om zowel nieuwe als gewijzigde bestellingen te valideren.

15.7.2     Response
Het ValidatePurchaseOrderResponse bevat een ValidationResult object wat aangeeft of de validatie
gelukt is.

ValidationResult object :
Naam                 Type                           Omschrijving                                  Opmerkingen
                                                                                                                     161
BrokenRuleName          String                      De code van de foutmelding.
Message                 String                      De standaard foutmelding.
IsValid                 Bool                        Geeft weer of dit een geldig
                                                    ValidationResult is.


Indien de validatie mislukt is, omdat de data niet geldig is, dan zal de BrokenRuleName aangeven
welke validatieregel mislukt is. De Message parameter geeft de tekstuele inhoud van de fout weer.

Wanneer de validatie wel gelukt is, zal BrokenRuleName leeg zijn.

Dit zijn de validatieregels die gebruikt worden tijdens de validatie :

RuleName                                                        Omschrijving

PurchaseOrderHeaderMissingVendorRule                            Controleert of VendorId is ingevuld en een geldige
                                                                waarde bevat
PurchaseOrderHeaderMissingEmployeeRule                          Controleert of EmployeeId is ingevuld en een
                                                                geldige waarde bevat
PurchaseOrderHeaderInvalidVendorForEmployeeRule                 Controleert of VendorId een geldige leverancier is
                                                                voor de opgegeven EmployeeId
PurchaseOrderHeaderInvalidVendorContactRule                     Controleert of VendorContactId een geldige
                                                                waarde bevat voor de opgegeven leverancier.
PurchaseOrderHeaderVendorChangeNotAllowedRule                   In het geval de PurchaseOrderRequest een
                                                                bestaande bestelling is waarvan de VendorId is
                                                                aangepast, controleert deze validatieregel of de
                                                                wijziging is toegestaan.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
15.8     VALIDATEPURCHASELINE
Deze functie wordt gebruikt om een bestelregel te valideren voordat deze wordt bewaard.


15.8.1     Request
Het ValidatePurchaseLineRequest object bevat het basis ServiceContext object en het te valideren
PurchaseLineRequest object.

Zie 15.6.2.3 voor een beschrijving van het PurchaseLineRequest object.

15.8.2     Response
Het ValidatePurchaseOrderResponse bevat een ValidationResult object wat aangeeft of de validatie
gelukt is.


Indien de validatie mislukt is, omdat de data niet geldig is, dan zal de BrokenRuleName aangeven
welke validatieregel mislukt is. De Message parameter geeft de tekstuele inhoud van de fout weer.

Wanneer de validatie wel gelukt is, zal BrokenRuleName leeg zijn.                                                162

Dit zijn de validatieregels die gebruikt worden tijdens de validatie :


RuleName                                          Omschrijving

PurchaseOrderLineMissingPurchaseIdRule            Controleert of PurchaseId is opgegeven.
                                                  Dit is een verplicht veld bij het bewaren van bestelregels.
PurchaseOrderLineInvalidPurchaseIdRule            Controleert of PurchaseId een geldige waarde bevat.
                                                  PurchaseId moet verwijzen naar een bestaande bestelregel
                                                  wanneer men een bestelregel wenst te bewaren.
PurchaseOrderLinePurchaseIdChangedRule            Controleert bij bestaande bestelregels of het achteraf
                                                  wijzigen van PurchaseId is toegestaan.
PurchaseOrderAllreadyBookedRule                   Controleert of wijzigingen op een bestaande regel zijn
                                                  toegestaan. Wijzigingen op een bestelregel die reeds
                                                  besteld is, zijn niet toegestaan.
PurchaseOrderLineInvalidArticleRule               Controleert of het opgegeven ArticleId een geldige waarde
                                                  bevat.
PurchaseOrderLineInvalidArticleForVendorR         Controleert of het opgegeven artikel gebruikt kan worden bij
ule                                               de leverancier die gekoppeld is aan de bestelling.
PurchaseOrderLine                                 Controleert of de werknemer voldoende rechten heeft om
InvalidArticleForEmployeeRule                     dit artikel aan te kopen.
PurchaseOrderLineInvalidPurchaseUnitRule          Controleert of PurchaseUnitId een geldige waarde bevat in
                                                  functie van het gekozen artikel.
PurchaseOrderLineInvalidQuantityRule              Controleert of Quantity een geldige waarde bevat.
                                                  Negatieve waarden zijn hier niet toegelaten.
PurchaseOrderLine                                 Controleert of de voorraad locatie leeg is bij niet voorraad
StockLocationForNonStockItemRule                  artikelen.


Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
                                                 De voorraad locatie mag niet ingevuld zijn wanneer een
                                                 artikel geen voorraad artikel is.
PurchaseOrderLineInvalidStockLocationRule        Controleert of de voorraad locatie een geldige waarde
                                                 bevat voor het gekozen artikel.
PurchaseOrderLine                                Controleert of de voorraad locatie gebruikt mag worden
InvalidStockLocationForEmployeeRule              door de werknemer.
PurchaseOrderLineInvalidHoursRule                Controleert of het veld Hours een geldige waarde bevat.
                                                 Deze waarde mag niet negatief zijn.




15.9     SAVEPURCHASEORDER
Deze functie wordt gebruikt om nieuwe bestellingen te bewaren of om wijzigingen door te voeren op
bestaande bestellingen.
                                                                                                                163
Via de SavePurchaseOrder kunnen enkel kopregels worden bewaard. Detailsregels toevoegen of
bewaren gebeurt via de functie SavePurchaseLine.


15.9.1     Request
De SavePurchaseOrderRequest bevat het basis ServiceContext object en een PurchaseOrderRequest
(zie 15.6.2.1) die men wenst te bewaren.


De Id van het PurchaseOrderRequest is hier erg belangrijk !
Indien men een nieuwe bestelling wenst te plaatsen, dan moet het Id leeg zijn.
Indien men wijzigingen in een bestaande bestelling wenst te bewaren, dan moet het Id opgevuld zijn
met het Id van de bestaande bestelling.


15.9.2     Response
Het SavePurchaseOrderResponse object bevat een SavePurchaseOrderResult, welke het resultaat
bevat van de Save operatie.

Naam                      Type                           Omschrijving

ValidationResult          ValidationResult               Het resultaat van de validatie, net voor het bewaren
                                                         van de bestelling.
                                                         Zie o.a. punt 0
                                                         ValidatePurchaseOrder
ResultState               ResultState                    Geeft aan of het bewaren gelukt is.
                                                         De mogelijke waardes zijn hier :
                                                                 None
                                                                 Success
                                                                 Failed
PurchaseOrder             PurchaseOrder                  De bewaarde bestelling.



Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
                                                                       Deze zal enkel ingevuld zijn bij ResultState : Success


Het is belangrijk dat er na het bewaren wordt verder gewerkt op de bewaarde bestelling.
Dit is noodzakelijk omdat na het bewaren van de bestelling, het Id zal ingevuld worden in het
resulterend object PurchaseOrder in SavePurchaseOrderResult.
Als men zou blijven verder werken op het origineel request object, dan zou de Id steeds leeg blijven en
zouden er steeds nieuwe bestellingen worden aangemaakt.

15.10 DELETEPURCHASEORDER
Deze functie wordt gebruikt om bestaande bestellingen te verwijderen.


15.10.1 Request
De DeletePurchaseOrderRequest bevat het basis ServiceContext object en een PurchaseOrderRequest
(zie 15.6.2.1) die men wenst te verwijderen.


Net als bij het bewaren speelt de Id hier een grote rol. Indien het Id niet geldig is, dan kan er ook niets                     164
geschrapt worden.


Merk op dat een bestelling niet meer kan verwijderd worden via de webservices indien de status één
van de volgende is : Besteld, Gedeeltelijk ontvangen, Volledig ontvangen.


15.10.2 Response
Het DeletePurchaseOrderResponse object bevat een DeletePurchaseOrderResult, welke het resultaat
bevat van de Delete operatie.


De inhoud ervan is volledig identiek aan dat van de SavePurchaseOrderResponse.
Naam                    Type                        Omschrijving

ValidationResult        ValidationResult            Het resultaat van de validatie, net voor het verwijderen van de
                                                    bestelling.
                                                    Indien het Id ongeldig is, zal ValidationResult ingesteld worden op
                                                    ‘PurchaseOrderHeaderMissingIdRule‘

                                                    Indien de status van de bestelling niet toelaat om de bestelling te
                                                    verwijderen, zal ValidationResult ingesteld worden op
                                                    ‘PurchaseOrderHeaderStatusRule‘
ResultState             ResultState                 Geeft aan of het bewaren gelukt is.
                                                    De mogelijke waardes zijn hier :
                                                            None
                                                            Success
                                                            Failed
PurchaseOrder           PurchaseOrder               De verwijderde bestelling.
                                                    Deze zal enkel ingevuld zijn bij ResultState : Success




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
15.11 SAVEPURCHASELINE
Deze functie wordt gebruikt om nieuwe bestelregels toe te voegen aan bestaande bestellingen en om
wijzigingen in bestaande bestelregels op te slaan.
De werking is volledig analoog aan de SavePurchaseOrder.




15.11.1 Request
De SavePurchaseLineRequest bevat het basis ServiceContext object en een PurchaseLineRequest (zie
15.6.2.3) die men wenst te bewaren.


De Id van het PurchaseLineRequest is hier erg belangrijk!
Indien men nieuwe bestelregels wenst aan te maken, dan moet het Id leeg zijn.
Indien men wijzigingen in een bestaande bestelregel wenst te bewaren, dan moet het Id opgevuld zijn
met het Id van de bestaande bestelregel.                                                                        165


Bestelregels kunnen enkel worden toegevoegd aan bestaande bestellingen. Het is dus belangrijk dat
de bestelling wordt aangemaakt voordat de bestelregel wordt aangemaakt, en dat de PurchaseId
van de bestelregel verwijst naar de bestaande bestelling.


15.11.2 Response
Het SavePurchaseLineResponse object bevat een SavePurchaseLineResult, welke het resultaat bevat
van de Save operatie.

Naam                     Type                          Omschrijving

ValidationResult         ValidationResult              Het resultaat van de validatie, net voor het bewaren
                                                       van de bestelregel.
                                                       Zie o.a. punt 15.8 ValidatePurchaseLine
ResultState              ResultState                   Geeft aan of het bewaren gelukt is.
                                                       De mogelijke waardes zijn hier :
                                                               None
                                                               Success
                                                               Failed
PurchaseLine             PurchaseLine                  De bewaarde bestelregel.
                                                       Deze zal enkel ingevuld zijn bij ResultState : Success


Het is belangrijk dat er na het bewaren wordt verder gewerkt op de bewaarde bestelregel.
Dit is noodzakelijk omdat na het bewaren van de bestelregel, het Id zal ingevuld worden in het
resulterend object PurchaseLine.
Als men zou blijven verder werken op het origineel request object, dan zou de Id steeds leeg blijven en
zouden er steeds nieuwe bestelregels worden aangemaakt.




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
15.12 DELETEPURCHASELINE
Deze functie wordt gebruikt om een bestaande bestelregel te verwijderen.


15.12.1 Request
De DeletePurchaseLineRequest bevat het basis ServiceContext object en een
PurchaseLineRequest(zie15.6.2.3) die men wenst te verwijderen.


Net als bij het bewaren speelt de Id hier een grote rol. Indien het Id niet geldig is, dan kan er ook niets
geschrapt worden.


Merk op dat een bestelregel niet meer kan verwijderd worden via de webservices indien de status één
van de volgende is : Besteld, Gedeeltelijk ontvangen, Volledig ontvangen.


15.12.2 Response                                                                                                          166
Het DeletePurchaseOrderResponse object bevat een DeletePurchaseLineResult, welke het resultaat
bevat van de Delete operatie.


De inhoud ervan is volledig identiek aan dat van de SavePurchaseOrderResponse.
Naam                    Type                        Omschrijving

ValidationResult        ValidationResult            Het resultaat van de validatie, net voor het verwijderen van de
                                                    bestelling.
                                                    Indien het Id ongeldig is, zal ValidationResult ingesteld worden op
                                                    ‘PurchaseOrderHeaderMissingIdRule‘

                                                    Indien de status van de bestelling niet toelaat om de bestelling te
                                                    verwijderen, zal ValidationResult ingesteld worden op
                                                    ‘PurchaseOrderHeaderStatusRule‘
ResultState             ResultState                 Geeft aan of het bewaren gelukt is.
                                                    De mogelijke waardes zijn hier :
                                                            None
                                                            Success
                                                            Failed
PurchaseLine            PurchaseLine                De verwijderde bestelregel.
                                                    Deze zal enkel ingevuld zijn bij ResultState : Success




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
16 Module Verhuur(vanaf RCX 5.0.5)
16.1       BEKNOPT OVERZICHT
Via de webshop is het nu mogelijk om verhuur artikelen te bestellen.
De werking is als volgt :
           Persoon kiest de periode waarin hij een artikel wenst te huren.
           Persoon kiest de hoeveelheid van het artikel dat hij wenst te huren.


Het verdere beheer van bestellingen gebeurt in ReCreateX.


De web service methodes die hiervoor aangemaakt werden zijn de volgende :
           FindRentalArticles (ophalen van de verhuurartikelen)
           FindRentalOrders (ophalen van bestaande bestellingen van de ingelogde persoon)
           GetRentalOrder (ophalen van één bestelling)                                                                 167

           CancelRentalOrder (annuleren van één bestelling)


16.2       FINDRENTALARTICLES
Deze methode haalt alle verhuurartikelen op die voldoen aan onderstaande zoekcriteria en waarbij er
aan volgende voorwaarden wordt voldaan:
           Het artikel is een verhuurartikel
           Het artikel mag worden weergegeven op de website
           Indien het gaat om een arrangementsartikel, dan dienen de onderdelen dezelfde
            berekeningswijze te hebben als het hoofdartikel.
           Er moet een verhuurlocatie bestaan voor het artikel.
           De afhaal/terugbrengdata moet op een moment vallen dat de verhuurlocatie open is.
           Indien er gebruik wordt gemaakt van rechten per divisie, dient men full control rechten te
            hebben op het artikel.


16.2.1      Request
De request bestaat uit de Service Context en een RentalArticleSearchCriteria object.
Naam                    Type                            Omschrijving                                 Opmerkingen

Id                      Guid                            Id van een specifiek artikel                 Nullable (Indien
                                                        (Als u doelbewust 1 entiteit wil ophalen).   niet van
                                                                                                     toepassing).
NamePattern             String                          Naam of stuk van de omschrijving             Nullable (Indien
                                                        waarnaar gezocht kan worden. Voor            niet van
                                                        gedeeltelijke matchen kan het %-teken        toepassing).
                                                        gebruikt worden.
                                                        Het %-teken kan zowel voor het woord,



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                                                     na het woord als voor en achter het
                                                     woord voorkomen.
ArticleGroupIds         List<Guid>                   Enkel artikelen van de geselecteerde
                                                     artikelgroepen worden weergegeven.
FromDate                DateTime                     Enkel de artikelen die beschikbaar zijn in
                                                     de gekozen periode worden
                                                     weergegeven.
UntilDate               DateTime                     Enkel de artikelen die beschikbaar zijn in
                                                     de gekozen periode worden
                                                     weergegeven.
DeliveryDate            DateTime                     Enkel de artikelen die beschikbaar zijn in
                                                     de gekozen periode worden
                                                     weergegeven.
                                                                                                  168
ReturnDate              DateTime                     Enkel de artikelen die beschikbaar zijn in
                                                     de gekozen periode worden
                                                     weergegeven.
Includes                RentalArticleIncludes        Bepaalt welke data extra meekomt in
                                                     het response en/of welke extra records in
                                                     de returnset aanwezig zullen zijn.
Paging                  PagingCriteria               Zie 4.1 : xxxSpecifiedField
                                                     Als er gebruik gemaakt wordt van een
                                                     DotNet client om de webservices aan te
                                                     spreken, dan is het belangrijk om bij het
                                                     aanroepobject de eventuele velden
                                                     xxxSpecifiedField ook in te vullen waar
                                                     de bijhorende velden (de xxx) gebruikt
                                                     worden.
                                                     Zonder deze boolean op “True” te
                                                     zetten, zal de waarde van het eigenlijke
                                                     veld niet gebruikt worden.
                                                     Dit heeft te maken met de manier
                                                     waarop DotNet het request serializeerd
                                                     en nullable types.
                                                     Dit hoeft niet te gebeuren vanuit een
                                                     andere programmeertaal of omgeving
                                                     (Java – PHP – etc.)
                                                     Paging Criteria.


Het RentalArticleIncludes object kan worden opgebouwd met volgende criteria:


Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
Naam                    Type                            Omschrijving                                     Opmerkingen

ImageUrl                Bool                            Ophalen van de afbeelding of niet.
Image                   Bool                            Ophalen van de afbeelding of niet.
ArticleGroup            Bool                            Ophalen van de gegevens van de
                                                        artikelgroep of niet.
Attachment              Bool                            Ophalen van de bijlages of niet.
ExtraImages             Bool                            Ophalen van de extra afbeeldingen of niet.
ExtraImageUrls          Bool                            Ophalen van de extra afbeeldingen of niet.
Components              Bool                            Ophalen van de onderdelen van een
                                                        verhuurartikel of niet. (enkel van toepassing
                                                        bij arrangementsartikelen)


16.2.2     Response
                                                                                                                       169
De response zal een lijst van RentalArticle objecten bevatten dat voldoet aan de criteria.
Het RentalArticle object ziet er als volgt uit:
Naam                     Type                           Omschrijving                                     Opmerkingen

Id                       Guid                           Id van het artikel.


DefaultWarranty          Decimal                        De waarborg van het artikel.
WarrantyCalculati        WarrantyCalculati              De berekeningswijze van de waarborg van
onType
                         onType                         het artikel. (per verhuring/per stuk)
TotalItemsInStock        Int                            Het aantal artikelen die de voorraadlocatie
                                                        heeft.
AvailableToRent          Int                            Het aantal artikelen die beschikbaar zijn in
                                                        de gekozen periode.
MaxToRent                Int                            Het max. aantal items die men van dit
                                                        artikel kan huren in één bestelling.
MaxDaysToRent            Int                            Het max. aantal dagen dat dit artikel kan
                                                        worden gehuurd.
MaxHoursToRent           Int                            Het max. aantal uren dat dit artikel kan
                                                        worden gehuurd.
NegativeSaldoAll         Bool                           Geeft aan of men dit artikel kan huren ook
owed
                                                        al is het niet meer beschikbaar.
Components               List<RentalArticleC            Bevat de lijst met Onderdelen van dit artikel.
                         omponent>
RentalPriceCalcul        RentalPriceCalcul              De berekeningswijze van de prijs van het
ationType
                         ationType                      verhuurartikel.




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
Het WarrantyCalculationType object is een enumeratie met volgende mogelijke waarden:
ByRental = 0,
ByQuantity = 1


Het RentalPriceCalculationType object is een enumeratie met volgende mogelijke waarden:
PxH = 0,                = Prijs * Aantal
F = 1,                  = Vaste forfait prijs
PxQ = 2,                = Prijs * Aantal
PxQxH = 3,              = Prijs * Aantal * Uren
PxQxD = 4,              = Prijs * Aantal * Dagen
PxQxN = 5               = Prijs * Aantal * Nachten


Het RentalArticleComponent is een ArticleBase object met de volgende uitbreiding:
                                                                                                                          170
Naam                    Type                           Omschrijving                                    Opmerkingen

Quantity                Int                            Geeft weer uit hoeveel onderdelen een
                                                       artikel bestaat.




16.3     FINDRENTALORDERS
Deze methode haalt alle bestellingen op van de ingelogde persoon.


16.3.1     Request
De request bestaat uit de Service Context en een RentalOrderSearchCriteria object.
Naam                    Type                              Omschrijving                                 Opmerkingen

Id                      Guid                              Id van een specifieke bestelling             Nullable (Indien
                                                          (Als u doelbewust 1 entiteit wil ophalen).   niet van
                                                                                                       toepassing).
Number                  Long                              Het bestelnummer van de bestelling           Nullable (Indien
                                                                                                       niet van
                                                                                                       toepassing).
PersonID                Guid                              Indien ingevuld, worden alle bestellingen
                                                          van die persoon weergegeven.
StartDateTime           DateTime                          Indien ingevuld, worden alle bestellingen
                                                          weergegeven die starten na deze
                                                          datum.
EndDateTime             DateTime                          Indien ingevuld, worden alle bestellingen
                                                          weergegeven die eindigen voor deze
                                                          datum.
RentalOrderStatus       RentalOrderStatus                 Indien ingevuld, worden alle bestellingen


Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
                                                           weergegeven met deze status
Paging                   PagingCriteria                    Zie 4.1 : xxxSpecifiedField
                                                           Als er gebruik gemaakt wordt van een
                                                           DotNet client om de webservices aan te
                                                           spreken, dan is het belangrijk om bij het
                                                           aanroepobject de eventuele velden
                                                           xxxSpecifiedField ook in te vullen waar
                                                           de bijhorende velden (de xxx) gebruikt
                                                           worden.
                                                           Zonder deze boolean op “True” te
                                                           zetten, zal de waarde van het eigenlijke
                                                           veld niet gebruikt worden.
                                                           Dit heeft te maken met de manier
                                                                                                                     171
                                                           waarop DotNet het request serializeerd
                                                           en nullable types.
                                                           Dit hoeft niet te gebeuren vanuit een
                                                           andere programmeertaal of omgeving
                                                           (Java – PHP – etc.)
                                                           Paging Criteria.
Includes                 RentalOrderIncludes               Bepaalt welke data extra meekomt in
                                                           het response en/of welke extra records in
                                                           de returnset aanwezig zullen zijn.


Het RentalOrderStatus object is een enumeratie met volgende mogelijke waarden:
Ordered = 0,
PartiallyDelivered = 1,
Delivered = 2,
PartiallyReturned = 3,
Returned = 4,
Cancelled = 5


Het RentalOrderIncludes object kan worden opgebouwd met volgende criteria:
Naam                    Type                            Omschrijving                                   Opmerkingen

IncludeOrderLin         Bool                            Ophalen van de bestelregels of niet.
es
IncludeOrderLin         Bool                            Ophalen van de bestelregels van de
eComponents
                                                        onderdelen of niet.
IncludePersonD          Bool                            Ophalen van de gegevens van de klant.
etails




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
16.3.2     Response
De response zal een lijst van RentalOrder objecten bevatten dat voldoet aan de criteria.
Het RentalOrder object ziet er als volgt uit:
Naam                    Type                        Omschrijving                              Opmerkingen

Id                      Guid                        Id van de bestelling.
RentalNo                Long                        Het bestelnummer van de bestelling.
RentalWebNo             Long                        Het bestelnummer van de bestelling.
WebCreated              Bool                        Geeft aan of de bestelling werd
                                                    aangemaakt via het web.
RentalOrderStatus       RentalOrderStatus           Bevat de status van de bestelling.
RentalAdministrati      RentalAdministrati          Bevat de administratieve status van de
veStatus
                        veStatus                    bestelling.
CreationDate            DateTime                    De datum waarop de bestelling werd                      172
                                                    aangemaakt.
Customer                Person                      De persoon die de bestelling heeft
                                                    geplaatst.
StartDateTime           DateTime                    De startdatum van de bestelling
EndDateTime             DateTime                    De einddatum van de bestelling
PlannedDeliveryD        DateTime                    De datum waarop de bestelling wordt
ateTime
                                                    afgehaald.
PlannedReturnDat        DateTime                    De datum waarop de bestelling wordt
eTime
                                                    teruggebracht.
CancelDate              DateTime                    De datum waarop de bestelling werd
                                                    geannuleerd.
CancelDescriptio        String                      De omschrijving die men heeft opgegeven
n
                                                    bij het annuleren van de bestelling.
Comment                 String                      De omschrijving van een bestelling.
RentalLocation          String                      De verhuurlocatie.
TotalAmount             Decimal                     Het totale bedrag van de bestelling.
RentalOrderLines        List<RentalOrderLi          De bestelregels van een bestelling.
                        ne>


Het RentalAdministrativeStatus object is een enumeratie met volgende mogelijke waarden:
NewOrder = 0,
Approved = 1,
Refused = 2


Het RentalOrderLine object kan worden opgebouwd met volgende criteria:


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Naam                    Type                            Omschrijving                                Opmerkingen

ID                      Guid                            Id van de bestelregel.
RentalOrderId           Guid                            Het id van de bestelling.
Sequence                Int                             Een volgnummer van de bestelregel.
StartDateTime           DateTime                        De startdatum van de bestelregel.
EndDateTime             DateTime                        De einddatum van de bestelregel.
PlannedDelivery         DateTime                        De datum waarop de bestelregel wordt
DateTime
                                                        afgehaald.
PlannedReturnD          DateTime                        De datum waarop de bestelregel wordt
ateTime
                                                        teruggebracht.
ItemID                  Guid                            Het artikel dat wordt besteld.
Quantity                Int                             De hoeveelheid die wordt besteld.
Description             String                          De omschrijving van de bestelregel.                        173
Info                    String                          Infoveld
WebCreated              Bool                            Geeft aan of de bestelregel wordt
                                                        aangemaakt via het web.
CalculationType         RentalCalculationTy             De berekeningswijze van de bestelregel.
                        pe
UnitPriceInc            Decimal                         De eenheidsprijs van het artikel.
Amount                  Decimal                         Het bedrag van de bestelregel.
Deposit                 Decimal                         De waarborg van het artikel
Components              List<RentalOrderLine            De bestelregels van de onderdelen van het
                        >                               artikel.


Het RentalCalculationType object is een enumeratie met volgende mogelijke waarden:
PriceTimesHours = 0,
FixedPrice = 1,
PriceTimesQuantity = 2,
PriceTimesQuantityTimesHours = 3,
PriceTimesQuantityTimesDays = 4,
PriceTimesQuantityTimesNights = 5


16.4     GETRENTALORDER
Deze methode haalt de details op van één bepaalde RentalOrder.


16.4.1     Request
De request bestaat uit de id van de bestelling.
Naam                        Type                           Omschrijving                              Opmerkingen



Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
RentalOrderId           Guid                        Id van de bestelling.


16.4.2      Response
De response geeft een RentalOrder object terug.
Naam                    Type                        Omschrijving                            Opmerkingen

RentalOrder             RentalOrder                 RentalOrder object.                     Zie 17.3.2 voor
                                                                                            details
                                                                                            betreffende
                                                                                            RentalOrder
                                                                                            object.


16.5       CANCELRENTALORDER
Deze methode annuleert één bepaalde RentalOrder.
                                                                                                              174
Men kan via de webshop enkel bestellingen verwijderen die:
       -    Als status ‘Gereserveerd’ hebben
       -    Als administratieve status ‘Nieuwe bestelling’ hebben
       -    Aangemaakt werden via het web


16.5.1      Request
De request is als volgt opgebouwd.
Naam                    Type                        Omschrijving                            Opmerkingen

RentalOrderId           Guid                        Id van de bestelling.
ReasonID                Guid                        De reden van annulatie.
ReasonDescriptio        String                      De omschrijving die men opgeeft bij
n                                                   annulatie.


16.5.2      Response
De response bevat een RentalValidationResult object. Dit object bevat zowel validatie data als het
originele RentalOrder object.
Het RentalValidationResult object ziet er als volgt uit:
Naam                    Type                        Omschrijving                            Opmerkingen

BrokenRuleName          String                      De code van de foutmelding.
Message                 String                      De foutmelding.
IsValid                 Bool                        Geeft weer of dit een geldig
                                                    ValidationResult is.
ValidatedRentalO        RentalOrder                 RentalOrder object dat werd opgehaald
rder                                                aan de hand van de meegegeven Id.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                 175




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
17 Module Inschrijvingen (vanaf RCX 5.0.5)
17.1       BEKNOPT OVERZICHT
Via de webshop is het nu mogelijk om personen in te schrijven op activiteiten.
De werking is als volgt :
           Persoon kiest een activiteit waarop hij wil inschrijven.
           Indien de persoon reeds ingelogd is kan hij zowel zichzelf als zijn relaties inschrijven, indien de
            persoon nog niet ingelogd is kan de persoon enkel zichzelf inschrijven (anoniem)
           Per deelnemer kan er ingegeven worden voor welke dagen hij wenst in te schrijven
           Per deelnemer / gekozen dag kan de persoon het aantal opties bepalen
           Bij het betalen (checkout) wordt de inschrijving definitief, bij een anonieme inschrijving wordt
            de deelnemer dan gelijk gezet aan de facturatieklant.


Het verdere beheer van de inschrijving gebeurt in ReCreateX.                                                       176



De web service methodes die hiervoor aangemaakt werden zijn de volgende :
           ListActivityTypes (ophalen van de types van activiteiten)
           FindActivities (ophalen van de activities)
           FindPriceGroupActivityByActivity (ophalen van de mogelijke prijsgroepen met gekoppelde
            prijzen ingesteld op de activiteit)


17.2       LISTACTIVITYTYPES
Deze service is geeft een lijst met activiteitstypes terug.


17.2.1      Request
De request bestaat enkel uit de Service Context.

17.2.2      Response
De response zal een lijst van activieittypes (List<ActivityType>) bevatten.
Naam                               Type                  Omschrijving                                Opmerkingen

Id                                 Guid                  Id van het activiteitstype.
Code                               String                Code van het activiteitstype.
Name                               String                Omschrijving van het activiteitstype.


17.3       FINDACTIVITIES
Deze service geeft een lijst met activiteiten terug.


17.3.1      Request
De request bestaat uit de Service Context en een ActivitySearchCriteria object.
Dit criteria bevat een object om de paging te kunnen verzorgen bij lange lijsten en verschillende
objecten om de gewenste lijst van activiteiten te bekomen.


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
17.3.1.1     ActivitySearchCriteria
Naam                    Type                          Omschrijving                                              Opmerkingen

Paging                  PagingCriteria                Zie 4.2 Paging Criteria
Period                  Period                        Haalt de activiteiten op die binnen deze periode
                                                      vallen. Zie punt 17.3.2.1
AgeFrom                 int?                          Activiteiten die voorzien zijn voor personen ouder of
                                                      gelijk aan deze leeftijd.
AgeTo                   Int?                          Activiteiten die voorzien zijn voor personen jonger of
                                                      gelijk aan deze leeftijd.
ActivityId              Guid                          Haalt 1 enkele activiteit op met een Id gelijk aan deze
                                                      waarde..
ActivityTypeId          Guid                          Haalt de activiteiten op die onder dit type vallen
Keyword                 string                        Haalt de activiteiten op waarvan deze tekst voorkomt
                                                      in de naamgeving
                                                                                                                              177
PersonId                Guid                          Indien ingevuld wordt de activiteitsprijs opgehaald die
                                                      geldt voor deze persoon.
Includes                ActivityIncludes              Bepaalt welke delen van de Activity mee opgehaald
                                                      zullen worden.


17.3.1.2     ActivityIncludes
Dit object laat toe om bepaalde delen van een activiteit al dan niet op te halen.
Naam                    Type                          Omschrijving                                              Opmerkingen

ImageUrl                Bool                          De URL van de afbeelding al dan niet weergeven.
DayParts                Bool                          Lijst van dagdelen (List<ActivityPart>) weergeven per
                                                      activiteit.
Options                 Bool                          Lijst van opties (List<ActivityOption>) weergeven


17.3.2     Response
De response zal een lijst van activiteiten (List<Activity>) bevatten.
Naam                    Type                          Omschrijving                                              Opmerkingen

Id                      Guid                          Id van de activiteit
Code                    String                        Code van de activiteit
Name                    String                        Omschrijving van de activiteit
Description             String                        Uitgebreide omschrijving activiteit
Comments                String                        Commentaar activiteit
Location                Address                       Zie 7.6.1.3 Address.
                                                      Bevat de adresgegevens van de plaats waar de
                                                      activiteit doorgaat.
ImageUrl                String                        De link waarop een image terug te vinden is van de
                                                      activiteit.
Type                    ActivityType                  Bevat een ActivityType object waartoe de activiteit
                                                      behoort.


Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
Period                  Period                        Bevat de periode waartussen de activiteit doorgaat.
                                                      Zie punt 17.3.2.1
ClosingDate             Datetime?                     Datum laatse inschrijving
Price                   Decimal                       Prijs van de activiteit
FreePlaces              Int?                          Aantal vrij plaatsen op de activiteit
Days                    List<ActivityPart>            Lijst van dagdelen (List<ActivityPart>) van de activiteit.   Afhandelijk van
                                                      Zie punt 17.3.2.2                                            include DayParts
Options                 List<ActivityOption>          Lijst van opties (List<ActivityOption>) van de activiteit.   Afhandelijk van
                                                      Zie punt 17.3.2.3                                            include Options
AgeCategory             AgeCategory                   Geeft de leeftijdscategorie weer.
                                                      Zie punt 17.3.2.4
EntryMethod             bool                          Geeft aan of het inschrijven gebeurt op het niveau
                                                      van de activiteitsdag (=true) of op het niveau van de
                                                      activiteit zelf (=false)
TotalPlaces             Int?                          Maximaal toegelaten aantal inschrijving op deze                                 178
                                                      activiteit.
Agreements              String                        Afspraken
Utilities               String                        Benodigdheden


17.3.2.1     Period
Naam                    Type                              Omschrijving                                             Opmerkingen

From                    DateTime                          Begindatum van de periode.
Until                   DateTime                          Einddatum van de periode.


17.3.2.2     ActivityPart
Naam                    Type                              Omschrijving                                             Opmerkingen

Id                      Guid                              Id van het dagdeel
Period                  Period                            Zie punt 17.3.2.1
Comment                 String                            Commentaar op dit dagdeel.


17.3.2.3     ActivityOption
Naam                    Type                              Omschrijving                                             Opmerkingen

Id                      Guid                              Id van de optie
ArticleId               Guid                              Id van het gekoppelde artikel.                           Verwijst naar
                                                                                                                   Article object
CustomPrice             Decimal                           Prijs per optie
Description             String                            Omschrijving van de optie
Amount                  Int                               Aantal opties


17.3.2.4     AgeCategory
Naam                    Type                              Omschrijving                                             Opmerkingen




Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
Id                       Guid                            Id van de leeftijdcategorie
Name                     Description                     Omschrijving van de leeftijdscategorie
FromAge                  Int                             Minimum leeftijd
UntilAge                 Int                             Maximum leeftijd




17.4         FINDPRICEGROUPACTIVITYBYACTIVITY
Deze service geeft een lijst prijsgroepen met gekoppelde prijzen weer die gekoppeld zijn aan een
activiteit. Via de webservices is het mogelijk om de prijs van een inschrijving op 3 verschillende
manieren te laten berekenen :
        1.    Aan de hand van activiteitsprijs = 1 prijs ingesteld op de activiteit
        2.    Aan de hand van de prijsgroep van de klant
        3.    De klant mag zelf een prijsgroep kiezen uit een lijst
Voor het 3de punt hebben we de methode FindPriceGroupActivityByActivity nodig
                                                                                                                            179

17.4.1        Request
De request bestaat uit de Service Context en een PriceGroupActivitySearchCriteria object.
Dit criteria bevat enkel een ActivityId wat verplicht mee te geven is.


17.4.1.1       ActivitySearchCriteria
Naam                     Type                        Omschrijving                                             Opmerkingen

ActivityId               Guid                        Id van de activiteit waarvoor je de prijsgroep/prijzen
                                                     wilt ophalen.




17.4.2        Response
De response zal een lijst van activiteitsprijsgroepen (List<PriceGroupActivity>) bevatten.
Naam                     Type                        Omschrijving                                             Opmerkingen

Id                       Guid                        Id van de activiteitsprijsgroep
ActivityId               Guid                        Id van de activiteit
PriceGroupId             Guid                        Id van de prijsgroep
Price                    Decimal?                    Prijs voor de combinatie prijsgroep - activiteit
From                     DateTime?                   Activiteitsprijsgroep is geldig vanaf deze datum
Until                    DateTime?                   Activiteitsprijsgroep is geldig tot deze datum
DayOfWeek                WeekDay?                    Enumeratie van de dag van de week waarop de
                                                     activiteitsprijsgroep actief is.
                                                               EveryDay
                                                               Monday
                                                               Tuesday
                                                               WednesDay
                                                               Thursday
                                                               Friday



Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
                                                              Saturday
                                                              Sunday
PriceGroupDesc          string                        Omschrijving van de prijsgroep
PriceGroupSn            string                        Code van de prijsgroep




17.5     FINDENTRYOVERVIEW
Deze service is geeft een lijst met Entry-objecten terug, dit zijn de inschrijvingen van een bepaalde
persoon.


17.5.1     Request
De request bestaat uit de Service Context en een EntrySearchCriteria object.

17.5.1.1     EntrySearchCriteria
Naam                                 Type                       Omschrijving                                   Opmerkingen     180
Paging                               PagingCriteria             Zie 4.2 Paging Criteria
PersonId                             Guid                       Haalt alle inschrijvingen op waar deze         Verplicht
                                                                persoon ofwel hoofdklant is ofwel
                                                                deelnemer is.


17.5.2     Response
De response zal een lijst van inschrijvingen (List<Entry>) bevatten.
Naam                                 Type                       Omschrijving                                Opmerkingen
Id                                   Guid                       Id van de Entry.
ActivityId                           Guid                       Id van de Activiteit.
ActivityCode                         String                     Korte code van de activiteit.
ActivityDesc                         String                     Omschrijving van de activiteit
EntryDate                            DateTime                   Inschrijvingsdatum van de inschrijving
EntryNo                              Long                       inschrijvingsnummer
Price                                Decimal                    Prijs btw inclusief van het prijsartikel,
                                                                gekoppeld aan een wachtlijst.
Status                               int                        Status van de inschrijving                  0 = voorlopig
                                                                                                            1 = wachtlijst
                                                                                                            2 = gereserveerd
                                                                                                            3= geannuleerd
Deletable                            Bool                       Geeft aan of de inschrijving
                                                                geannuleerd kan worden.




17.6     CANCELENTRY
Deze methode annuleert één bepaalde inschrijving (Entry).
Men kan via de webshop enkel inschrijvingen verwijderen die:



Syx Automations BE               Syx Automations NL
Rozendaalstraat 53               Meesterstraat 2
8900 Ieper                       3861 RE Nijkerk
T. +32 (0)57 22 44 00            T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01            F. +31 (0)33 46 109 33
www.syx.be                       www.syx.nl
     -     Nog niet geannuleerd zijn(status = voorlopig, gereserveerd of wachtlijst)
     -     Nog niet geboekt zijn


17.6.1     Request
De request is als volgt opgebouwd.
Naam                    Type                        Omschrijving                       Opmerkingen

EntryId                 Guid                        Id van de inschrijving.
ReasonID                Guid                        De reden van annulatie.


17.6.2     Response
De response is gewoon een boolean. Ofwel is de annulering gelukt ofwel niet.




                                                                                                     181




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
18 Module BKO (vanaf RCX 5.1.0)
18.1       BEKNOPT OVERZICHT
De module buitenschoolse kinderopvang is beschikbaar vanaf ReCreateX 5.1.0.
De werking is als volgt :
           In ReCreateX dient een kind ingeschreven te worden.
           Eenmaal een kind is ingeschreven in een bepaald opvangecentrum, kunnen via de web
            services aanwezigheden geregistreerd worden.


De web service methodes die hiervoor aangemaakt werden zijn de volgende :
           AuthenticateChildCareCentre (authenticeren van een opvangecentrum)
                                                                                                                          182
           FindChildCareCentres (ophalen van de opvangcentra)
           FindChildCareCentrePeriods (ophalen van de opvangperiodes)
           FindChildCareCentreEntries (ophalen van de inschrijvingen)
           FindChildCareCentrePresences (ophalen van de aanwezigheden)
           SaveChildCareCentrePresence (opslaan van een aanwezigheid)
           DeleteChildCareCentrePresence (verwijderen van een aanwezigheid)


18.2       AUTHENTICATECHILDCARECENTRE
Deze methode wordt gebruikt om de credentials van een opvangcentrum te valideren wanneer die
wenst in te loggen.


18.2.1      Request
Binnen de AuthenticateChildCareCentreRequestwordt naast het ServiceContext object enkel een
Credential object verwacht.


Naam                    Type                         Omschrijving                                 Opmerkingen

Credentials             PersonChildCareInfo          Bevat de username & paswoord                 Zie 7.3.1
                         Naam                        combinatie men wenst te authenticeren.
                                                      Type                Omschrijving            PersonChildCa       Opmerkinge

                         Id                          Guid                                      reInfo
                                                                          Unieke ID van de persoon
                         School                      ChildCareSchool                                Naam
                                                                          Details betreffende de school van de              Type
                                                                          persoon                   Id                      Guid
                         Tariff                      ChildCareTariff      Details betreffende het tarief dat wordt
                                                                                                    School                  Child
                                                                          gebruikt bij de prijsberekening voor deze
                                                                          persoon
                                                                                                    Tariff                  Child
                         LeaveAlone                  Bool                 Mag het kind de opvang alleen
                                                                          verlaten?




Syx Automations BE          Syx Automations NL
Rozendaalstraat 53          Meesterstraat 2
8900 Ieper                  3861 RE Nijkerk
T. +32 (0)57 22 44 00       T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01       F. +31 (0)33 46 109 33
www.syx.be                  www.syx.nl
                         HasMedication              Bool                                      LeaveAlone
                                                                      Neemt het kind medicatie?                                Bool

                         MedicationName             String            Naam van de medicatie
                                                                                                HasMedication                  Bool
                         MedicationDose             String            Dosis van de medicatie
                                                                                                MedicationName                 String
                         MedicationExtraInfo        String            Extra informatie omtrent de medicatie
                                                                                                 MedicationDose                String
                         HasAllergy                 String            Heeft het kind een allergie?
                                                                                                MedicationExtraInfo            String
                         AllergyName                String            Naam van de allergie
                                                                                                HasAllergy                     String
                         AllergyExtraInfo           String            Extra informatie omtrent de allergie
                                                                                               AllergyName                     String
                         OtherMedicalInfo           String            Extra algmene informatie omtrent de
                                                                      medische gegevens         AllergyExtraInfo               String
                                                                                                OtherMedicalInfo               String
                        18.2.1.1   ChildCareS
                                   chool
                         Naam                       Type              Omschrijving             18.2.1.3   Child    Opmerkinge
                                                                                                                       183
                                                                                                      Care
                         Id                         Guid              De unieke Identifier van de school
                                                                                                      Scho
                         Code                       String            Code van de school
                                                                                                      ol
                         Name                       String            De naam van de school
                                                                                              Naam                             Type
                         Location                   AddressLocation   Locatie van de school                        Zie 9.5.2
                                                                                              Id                               Guid
                                                                                                Code                           String

                        18.2.1.2   ChildCareT                                                   Name                           String

                                   ariff                                                        Location                       Add

                         Naam                       Type              Omschrijving                                 Opmerkinge

                         Id                         Guid              De unieke Identifier van het tarief
                                                                                             18.2.1.4 Child
                         Code                       String            Code van het tarief
                                                                                                       Care
                         Name                       String            Naam van het tarief
                                                                                                       Tariff
                         Description                String            Omschrijving van het tarief
                                                                                              Naam                             Type
                        Credential
                                                                                                Id                             Guid
                                                                                                Code                           String
                                                                                                Name                           String
                                                                                                Description                    String
                                                                                               Credential


18.2.2     Response
AuthenticateChildCareCentreResponsebevat een AuthenticationResult die aangeeft of het
authenticeren geslaagd is.


Naam                    Type                        Omschrijving                               Opmerkingen



Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
HasSucceeded            Boolean                     Geeft aan of de gebruiker al dan niet
                                                    succesvol is geauthenticeerd.
Error                   AuthenticationError         Een enumeratie die de fout teruggeeft    Voor
                                                    van het authenticatieProces.             securitydoel
                                                    Mogelijke waarden zijn :                 einden wordt
                                                    None                                     hier geen
                                                    InvalidParameters                        correcte
                                                    UnknownUser                              informatie in
                                                    BlockedUser                              geplaatst.
                                                    InvalidCredential
PersonId                Guid                        Het id van de geauthenticeerde
                                                    gebruiker, in dit geval een
                                                    opvangcentrum.
                                                                                                             184

18.3     FINDCHILDCARECENTRES
Wordt gebruikt om een lijst van opvangcentra op te halen.


18.3.1     Request
Het FindChildCareCentresRequest bevat enerzijds het standaard ServiceContext object en anderzijds
het hieronder beschreven ChildCareCentreSearchCriteria object.


Naam                    Type                        Omschrijving                             Opmerkingen

Id                      Guid?                       Indien ingevuld : Het Id van het         Nullable
                                                    opvangcentrum dat men wenst op te
                                                    zoeken
Name                    String                      Indien ingevuld : De naam van het
                                                    opvangcentrum dat men wenst op te
                                                    zoeken
UserName                String                      Indien ingevuld : De webgebruikersnaam
                                                    van het opvangcentrum dat men wenst
                                                    op te zoeken
IsBlocked               Bool?                       Indien ingevuld :                        Nullable
                                                    True om alleen de geblokkeerde
                                                    opvangcentra op te halen
                                                    False om alleen de niet geblokkeerde
                                                    opvangcentra op te halen
Paging                  PagingCriteria              Zie 4.2 Paging Criteria
Includes                ChildCareCentreInclu        Bepaalt welke delen van de
                        des                         opvangcentra mee opgehaald zullen


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                       worden.




18.3.1.1     ChildCareCentreIncludes
Dit object laat toe om bepaalde delen van de opvangcentra al dan niet op te halen.
Naam                    Type                           Omschrijving                              Opmerkingen

Locations               Bool                           Haalt al dan niet de locatie van het
                                                       opvangcentrum op.


18.3.2     Response
Het FindChildCareCentresResponse object bevat een lijst van ChildCareCentre objecten die aan de
bovenstaande criteria voldoen. Het ChildCareCentre object ziet er als volgt uit
                                                                                                                   185

Naam                    Type                           Omschrijving                              Opmerkingen

Id                      Guid                           Het Id van het opvangcentrum
Code                    String                         De code van het opvangcentrum
Name                    String                         De naam van het opvangcentrum
Location                AddressLocation                De locatie van het opvangcentrum          Zie 9.5.2 voor
                                                                                                 het
                                                                                                 AddressLocati
                                                                                                 on object
MaxChildren             Int                            Het maximaal aantal toegelaten kinderen
Credential              Credential                     De username & paswoord combinatie van     Zie 7.3.1
                                                       het opvangcentrum.                        PersonChildCa
                                                                                                 reInfo
                                                                                                  Naam               Type

                                                                                                  Id                 Guid
                                                                                                  School             Child


                                                                                                  Tariff             Child




                                                                                                  LeaveAlone         Bool


                                                                                                  HasMedication      Bool

                                                                                                  MedicationName     String
                                                                                                  MedicationDose     String




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
                                                                                       MedicationExtraInfo     String
                                                                                       HasAllergy              String
                                                                                       AllergyName             String
                                                                                       AllergyExtraInfo        String
                                                                                       OtherMedicalInfo        String



                                                                                     18.3.2.1   Child
                                                                                                Care
                                                                                                Scho
                                                                                                ol
                                                                                       Naam                    Type

                                                                                       Id                      Guid
                                                                                                             186
                                                                                       Code                    String
                                                                                       Name                    String
                                                                                       Location                Add




                                                                                     18.3.2.2   Child
                                                                                                Care
                                                                                                Tariff
                                                                                       Naam                    Type

                                                                                       Id                      Guid
                                                                                       Code                    String
                                                                                       Name                    String
                                                                                       Description             String
                                                                                     Credential
IsBlocked               Bool                        True indien het opvangcentrum
                                                    geblokkeerd is.


18.4     FINDCHILDCARECENTREPERIODS
Wordt gebruikt om een lijst van opvangperiodes op te halen.


18.4.1     Request
Het FindChildCareCentrePeriodsRequest bevat enerzijds het standaard ServiceContext object en
anderzijds het hieronder beschreven ChildCareCentrePeriodSearchCriteria object.


Naam                    Type                        Omschrijving                     Opmerkingen




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Id                      Guid?                          Indien ingevuld : Het Id van de                Nullable
                                                       opvangperiode die men wenst op te
                                                       zoeken
ChildCareCentreI        Guid?                          Indien ingevuld : Het Id van het
d                                                      opvangcentrum waarvoor men de
                                                       periodes wenst op te zoeken
From                    DateTime?                      Enkel de periodes ophalen die later
                                                       eindigen dan de opgegeven datum.
Until                   DateTime?                      Enkel de periodes ophalen die vroeger
                                                       beginnen dan de opgegeven datum
Paging                  PagingCriteria                 Zie 4.2 Paging Criteria


18.4.2     Response
                                                                                                                    187
Het FindChildCareCentrePeriodsResponse object bevat een lijst van ChildCareCentrePeriod objecten
die aan de bovenstaande criteria voldoen. Het ChildCareCentrePeriod object ziet er als volgt uit:


Naam                    Type                           Omschrijving                                   Opmerkingen

Id                      Guid                           Het Id van de opvangperiode
ChildCareCentreI        Guid                           Het Id van het opvangcentrum waar deze
d                                                      periode tot behoort
From                    DateTime                       De starttijd van de opvangperiode
Until                   DateTime                       De eindtijd van de opvangperiode
MaxChildren             Int                            Het maximaal aantal toegelaten kinderen
Comment                 String                         Extra commentaar voor deze
                                                       opvangperiode


18.5     FINDCHILDCARECENTREENTRIES
Wordt gebruikt om een lijst van opvang-inschrijvingen op te halen.


18.5.1     Request
Het FindChildCareCentreEntriesRequest bevat enerzijds het standaard ServiceContext object en
anderzijds het hieronder beschreven ChildCareCentreEntrySearchCriteria object.


Naam                    Type                           Omschrijving                                   Opmerkingen

Id                      Guid?                          Indien ingevuld : Het Id van de inschrijving   Nullable
                                                       die men wenst op te zoeken
PersonId                Guid?                          Indien ingevuld : Het Id van de persoon
                                                       waarvoor je de inschrijvingen wenst op te




Syx Automations BE            Syx Automations NL
Rozendaalstraat 53            Meesterstraat 2
8900 Ieper                    3861 RE Nijkerk
T. +32 (0)57 22 44 00         T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01         F. +31 (0)33 46 109 33
www.syx.be                    www.syx.nl
                                                    zoeken
ChildCareCentreI        Guid?                       Indien ingevuld: Het Id van het
d                                                   opvangcentrum waarvoor je de
                                                    inschrijvingen wenst op te zoeken
ChildCareCentreP        Guid?                       Indien ingevuld: Het Id van de             Enkel van
eriodId                                             opvangperiode waarvoor je de               toepassing
                                                    inschrijvingen wenst op te zoeken          wanneer je
                                                                                               inschrijvingen
                                                                                               op periode
                                                                                               gebruikt in
                                                                                               ReCreateX
Paging                  PagingCriteria              Zie 4.2 Paging Criteria
Includes                ChildCareCentreEntr         Bepaalt welke delen van de inschrijving
                                                                                                                188
                        yIncludes                   mee opgehaald zullen worden.


18.5.1.1     ChildCareCentreEntryIncludes
Dit object laat toe om bepaalde delen van de inschrijvingen al dan niet op te halen.
Naam                    Type                        Omschrijving                               Opmerkingen

PersonDetails           Bool                        Haalt al dan niet de detail gegevens van
                                                    de persoon op.


18.5.2     Response
Het FindChildCareCentreEntriesResponse object bevat een lijst van ChildCareCentreEntry objecten die
aan de bovenstaande criteria voldoen. Het ChildCareCentreEntry object ziet er als volgt uit:


Naam                    Type                        Omschrijving                               Opmerkingen

Id                      Guid                        Het Id van de opvang-inschrijving
PersonId                Guid                        Het Id van de ingeschreven persoon
Person                  Person                      Detail gegevens van de ingeschreven
                                                    persoon
ChildCareCentreI        Guid                        Het Id van het opvangcentrum waarop de
d                                                   persoon is ingeschreven
EntryDate               DateTime                    Datum van inschrijving


18.6     FINDCHILDCARECENTREPRESENCES
Wordt gebruikt om een lijst van opvang-aanwezigheden op te halen.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
18.6.1     Request
Het FindChildCareCentreEntriesRequest bevat enerzijds het standaard ServiceContext object en
anderzijds het hieronder beschreven ChildCareCentreEntrySearchCriteria object.


Naam                    Type                        Omschrijving                              Opmerkingen

Id                      Guid?                       Indien ingevuld : Het Id van de opvang-   Nullable
                                                    aanwezigheid die men wenst op te
                                                    zoeken
PersonId                Guid?                       Indien ingevuld : Het Id van de persoon
                                                    waarvoor je de aanwezigheden wenst op
                                                    te zoeken
ChildCareCentreI        Guid?                       Indien ingevuld: Het Id van het
d                                                   opvangcentrum waarvoor je de
                                                                                                            189
                                                    aanwezigheden wenst op te zoeken
ChildCareCentreP        Guid?                       Indien ingevuld: Het Id van de
eriodId                                             opvangperiode waarvoor je de
                                                    aanwezigheden wenst op te zoeken
Paging                  PagingCriteria              Zie 4.2 Paging Criteria


18.6.2     Response
Het FindChildCareCentrePresencesResponse object bevat een lijst van ChildCareCentrePresence
objecten die aan de bovenstaande criteria voldoen. Het ChildCareCentrePresence object ziet er als
volgt uit:


Naam                    Type                        Omschrijving                              Opmerkingen

Id                      Guid                        Het Id van de opvang-aanwezigheid
PersonId                Guid                        Het Id van de persoon
ChildCareCentreI        Guid                        Het Id van het opvangcentrum
d
ChildCareCentreP        Guid                        Het Id van de opvangperiode
eriodId
From                    DateTime                    Starttijd van de aanwezigheid
Until                   DateTime                    Eindtijd van de aanwezigheid




18.7     SAVECHILDCARECENTREPRESENCE
Deze methode wordt gebruikt om een opvang-aanwezigheid op te slaan.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
18.7.1     Request
Het SaveChildCareCentrePresenceRequest bevat een ChildCareCentrePresence object. Zie 18.6.2 voor
details betreffende dit object


18.7.2     Response
Het SaveChildCareCentrePresenceResponse object bevat een SaveChildCareCentrePresenceResult
object. Dit object ziet er als volgt uit:


Naam                    Type                        Omschrijving                        Opmerkingen

ChildCareCentreP        ChildCareCentrePres         Aanwezigheidsobject                 Zie 18.6.2 voor
resence                 ence                                                            details
ValidationResults       List<ValidationResult>      Details betreffende de transactie


18.7.2.1     ValidationResult                                                                             190

Naam                    Type                        Omschrijving                        Opmerkingen

BrokenRuleName          String                      De code van de foutmelding.
Message                 String                      De standaard foutmelding.
IsValid                 Bool                        Geeft weer of dit een geldig
                                                    ValidationResult is.


18.8     DELETECHILDCAREPRESENCE
Deze methode wordt gebruikt om een opvang-aanwezigheid te verwijderen.


18.8.1     Request
De Request bestaat uit de Service Context en de unieke Id van de aanwezigheid die bijvoorbeeld via
de FindChildCareCentrePresences methode kan bekomen worden.
Naam                    Type                        Omschrijving                        Opmerkingen

ChildCareCentreP        Guid                        ID van de opvang-aanwezigheid
resenceId


18.8.2     Response
De response bevat een ValidationResult object. Dit object ziet er als volgt uit.
Naam                    Type                        Omschrijving                        Opmerkingen

BrokenRuleName          String                      Naam van de validatie regel.
Message                 String                      Foutboodschap.
IsValid                 Bool                        Regel is succesvol verwerkt.        True = success
                                                                                        False = fout




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                                 191




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
19 Ophalen van Afbeeldingen via webservices
Via de webservices bieden we de mogelijkheid om aan de hand van een link een afbeelding op een
webpagina te tonen. Hiervoor kan je de volgende webservice (WebShopImageService.svc) operaties
gebruiken.
Via de webservice hebben we de mogelijkheid om de link op te vragen van het bepaalde artikel of
expostie, …
Deze zal een link terug geven die de volgende structuur bevat TYPE/{ShopId}/{id}
Aan de hand van deze link zal een image teruggegeven worden door de ImageWebService met deze
link op te roepen.


Volgende URLs worden aangeboden:


                                                                                                            192
Uri                                Methode Beschrijving

Activity/{ShopId}/{id}             GET          Returns the image for an activity

Article/{ShopId}/{id}              GET          Returns the image for an article (Rental or Sale)

Article/{ShopId}/{id}/{number} GET              Returns the image for an article (Rental or Sale)

ArticleGroup/{ShopId}/{id}         GET          Returns the image for an article group

Event/{ShopId}/{id}                GET          Returns the image for a event (Culture Event)

Exposition/{ShopId}/{id}           GET          Returns the image for an exposition

FitnessActivity/{ShopId}/{id}      GET          Returns the image for an fitness activity




19.1    EEN VOORBEELD:
Een Article heeft een ImageUrl die er als volgt uit ziet.
Article/BD7F0911-D9EB-44F7-86CF-55851040C553/27B769BB-1D51-4904-8BC8-037B55E4B0C4
Door de WebShopImagewebservice met deze parameter op te roepen zal de afbeelding voor een
Article met Id 27B769BB-1D51-4904-8BC8-037B55E4B0C4 op division BD7F0911-D9EB-44F7-86CF-
55851040C553 afgebeeld worden.
De volledige link wordt dan in ons voorbeeld :
http://localhost/webshopImageService.svc/Article/BD7F0911-D9EB-44F7-86CF-55851040C553/27B769BB-1D51-4904-
8BC8-037B55E4B0C4




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
20 Ophalen van documenten via WebServices
Via de webservices bieden we de mogelijkheid om aan de hand van een link een document op een
webpagina te tonen. Hiervoor kan je de volgende webservice (WebShopDocumentService.svc)
operaties gebruiken.


Uri                                                     Methode Beschrijving

ActivitySubscriptions/{ShopId}/{Language}/{Subscri               Returns the Document for (Activity
                                                        GET
ptionId}                                                         Subscription)

CultureEvents/{ShopId}/{Language}/{CustomerId}/{
                                                        GET      Returns the Document for (Culture Event)
CultureEventID}/{From}/{Until}

CultureEvents/{ShopId}/{Language}/{ReservationId} GET            Returns the Document for (Culture Event)

ETickets/{ShopId}/{Language}/{SalesLineID}              GET      Returns the Documents for (E-Ticket)       193
                                                                 Returns the Documents for (Fitness
Fitness/{ShopId}/{Language}/{FitnessReservationID} GET
                                                                 Reservation)

                                                                 Help page for GetFitnessDocument
Help/Fitness/{ShopId}/{Language}                        GET
                                                                 service

                                                                 Help page for GetRentalDocument
Help/Rental/{ShopId}/{Language}                         GET
                                                                 service

PlaceReservations/{ShopId}/{Language}/{SalesLineI                Returns the Document for (Place
                                                        GET
ds}                                                              Reservations)

Rental/{ShopId}/{Language}/{RentalHeaderID}             GET      Returns the Documents for (Rental Order)




20.1       ALGEMEEN
Volgende methode kan gebruikt worden om een PDF document te genereren vanaf een URL. Hierbij
worden volgende parameters meegegeven:


           de URL
            vb: http://services.recreatex.be/WebShopDocumentService.svc/CultureEvents/9843ADF4-
            4D8A-9D5Q-D4D6-D88S5C4DPVG8/NL/58S1D4D8-VSQ5-6D1C-1D44-M158443F8SD1


           het absolute pad van het te genereren document
            vb: C:\Temp\Event_58S1D4D8-VSQ5-6D1C-1D44-M158443F8SD1.pdf


           Time out bij het uitvoeren van de transactie (in seconden)
            vb:10




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
private static void SavePdfFileFromURL(string url, string destinationFileName, int timeoutInSeconds)
{
    // Create a web request to the URL
    var MyRequest = (HttpWebRequest)WebRequest.Create(url);
    MyRequest.Timeout = timeoutInSeconds * 1000;
    try
    {
        // Get the web response
        var MyResponse = (HttpWebResponse)MyRequest.GetResponse();

        // Make sure the response is valid
        if (HttpStatusCode.OK == MyResponse.StatusCode)
        {
            // Open the response stream
            using (Stream MyResponseStream = MyResponse.GetResponseStream())
            {
                // Open the destination file
                using (var MyFileStream = new FileStream(destinationFileName, FileMode.OpenOrCreate,
FileAccess.Write))
                {
                    var MyBuffer = new byte[4096];
                    int BytesRead;

                            // Read the chunk of the web response into the buffer                           194
                            while (0 < (BytesRead = MyResponseStream.Read(MyBuffer, 0, MyBuffer.Length)))
                            {
                                // Write the chunk from the buffer to the file
                                MyFileStream.Write(MyBuffer, 0, BytesRead);
                            }
                            MyFileStream.Flush();
                            MyFileStream.Close();
                        }
                 }
           }
       }
       catch (Exception err)
       {
           throw new Exception("Error saving file from URL:" + err.Message, err);
       }

       return;
}




20.2     CULTUREEVENT TICKETS
Voor het ophalen van de tickets die aangemaakt zijn bij een reservering van een cultureevent, kan je
gebruik maken van de WebShopDocumentService.


Na het aanmaken van de reservatie zal je van de CheckOutBasket voor alle CultureEventReservering
een SalesItem Id gekregen hebben(dit zal voor alle evenementen hetzelfde id zijn). Aan de hand van
dit id, kan je de tickets opvragen van de reservering.


Stel dat het SalesItem Id ‘27B769BB-1D51-4904-8BC8-037B55E4B0C4’ is, dan kan je aan de hand van dit
id de nodige tickets ophalen door de surfen naar het volgende adres


Formaat :
http://{server}/WebshopDocumentService/CultureEvents/{ShopId}/{Language}/{ReservationId}




Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
In ons voorbeeld wordt dit
http://localhost/WebshopDocumentService/CultureEvents/00000000-0000-0000-0000-
000000000001/NL/27B769BB-1D51-4904-8BC8-037B55E4B0C4’


Daarnaast is het ook mogelijk om een reeks tickets op te halen voor een klant en CultureEvent.
Hierbij wordt het volgende formaat gebruikt :
http://{server}/WebshopDocumentService/CultureEvents/{ShopId}/{Language}/{CustomerId}/{CultureEv
entID}/{From}/{Until}


CustomerID : de identifier van de klant
CultureEventID : de identifier van het evenement
From, Until : het datum bereik van tot waarbij de datum in het formaat yyyymmdd staat.


20.3    ETICKETS VAN EXPOSITIES
Voor exposities kan er per verkoop ook een toegansticket worden bekomen, op voorwaarde dat er             195

een toegang is gekocht en dat er een template is gekoppeld aan dit artikel in ReCreateX.
Het principe is hier analoog aan de vorige document services.


Formaat van de URL :
http://{server}/WebshopDocumentService/ETickets/{ShopId}/{Language}/{SalesLineID}


De SalesLineID is de ID die bekomen wordt uit CheckOutBasketResult.SalesItem[…].ID na
CheckOutBasket.


20.4    TICKETS VAN INSCHRIJVINGEN
Bij het inschrijven op activiteiten kan je een ticket bekomen per inschrijving op voorwaarde dat er een
template is gekoppeld aan deze activiteit in ReCreateX. In deze template kunnen verschillende velden
worden gebruikt. Deze velden kunnen opgelijst worden via een Help service:
http://{server}/WebshopDocumentService/Help/ActivitySubscription/{ShopId}/{Language}




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
                                                 196




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
                                                                                                         197




Het principe voor het ophalen van de tickets voor inschrijvingen op activiteiten is analoog aan vorige
document services.


Formaat van de URL :
http://{server}/WebshopDocumentService/ ActivitySubscriptions/{ShopId}/{Language}/{ SubscriptionId}


De SubscriptionId is de ID die bekomen wordt uit CheckOutBasketResult.SalesItem[…].ID na
CheckOutBasket.




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
20.5    FITNESS TICKETS
Bij het reserveren van fitness activiteiten kan je per resevering een ticket bekomen op voorwaarde dat
er een template is gekoppeld in de algemene fitness parameters. In deze template kunnen
verschillende velden worden gebruikt. Deze velden kunnen opgelijst worden via een Help service:
http://{server}/WebshopDocumentService/Help/Fitness/{ShopId}/{Language}




                                                                                                         198




Het principe voor het ophalen van de fitness tickets is analoog aan vorige document services.


Formaat van de URL :
http://{server}/WebshopDocumentService/Fitness/{ShopId}/{Language}/{FitnessReservationID}


De FitnessReservationID is de ID die bekomen wordt uit CheckOutBasketResult.SalesItem[…].ID na
CheckOutBasket.




Syx Automations BE        Syx Automations NL
Rozendaalstraat 53        Meesterstraat 2
8900 Ieper                3861 RE Nijkerk
T. +32 (0)57 22 44 00     T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01     F. +31 (0)33 46 109 33
www.syx.be                www.syx.nl
20.6    TICKETS VOOR VERHUUR BESTELLINGEN
Bij het bestellen van huurartikelen kan je per bestelling een ticket bekomen op voorwaarde dat er een
template is gekoppeld in de algemene verhuur parameters. In deze template kunnen verschillende
velden worden gebruikt. Deze velden kunnen opgelijst worden via een Help service:
http://{server}/WebshopDocumentService/Help/Rental/{ShopId}/{Language}




                                                                                                        199




Het principe voor het ophalen van de verhuur tickets is analoog aan vorige document services.




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
Formaat van de URL :
http://{server}/WebshopDocumentService/Rental/{ShopId}/{Language}/{RentalHeaderID}


De RentalHeaderID is de ID die bekomen wordt uit CheckOutBasketResult.SalesItem[…].ID na
CheckOutBasket.




                                                                                           200




Syx Automations BE      Syx Automations NL
Rozendaalstraat 53      Meesterstraat 2
8900 Ieper              3861 RE Nijkerk
T. +32 (0)57 22 44 00   T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01   F. +31 (0)33 46 109 33
www.syx.be              www.syx.nl
21 Opmerkingen
Indien de webservices gebruikt worden vanuit bvb een .Net omgeving, dan wordt er door .Net zelf een
proxy class aangemaakt met alle nodige objecten om de web services aan te spreken.
U hoeft bij creatie enkel een service reference toe te voegen die verwijst naar de URL die u van Syx
Automations verkrijgt.


Na het aanmaken van de proxy classes, zult u zien dat een aantal classes properties krijgen die
eindigen op ‘Specified’.


Voorbeeld voor de Person class :
BirthDate => BirthDateSpecified
Gender => GenderSpecified
IsBlocked => IsBlockedSpecified
                                                                                                               201

U zult zien dat deze properties worden toegevoegd op een aantal velden. Dit voornamelijk op velden
van een basis type dat niet nullable is : Boolean, Int, Enum, …
.Net heeft deze extra velden nodig om bij serialisatie te weten of de waarde die in het veld staat
toegekend is door de programmeur of indien het gaat om de default waarde van het object.
Een int veld kan bijvoorbeeld niet NULL zijn, en krijgt default de waarde 0.
Bij serialisatie zou een niet-geïnitializeerde int standaard op 0 staan, wat eigenlijk NULL zou moeten zijn.
Daarom is er voor dit soort types automatisch een boolean xSpecified veld voorzien waarin u via True /
False kunt aangeven of er rekening dient gehouden te worden met de waarde van het
overeenkomstig veld.
De regel is dat indien u de waarde van een basis veld x invult, en er bestaat een overeenkomstig
xSpecified veld, dat u dan xSpecified op true zet om aan te geven dat dit veld is ingevuld.




Syx Automations BE       Syx Automations NL
Rozendaalstraat 53       Meesterstraat 2
8900 Ieper               3861 RE Nijkerk
T. +32 (0)57 22 44 00    T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01    F. +31 (0)33 46 109 33
www.syx.be               www.syx.nl
22 Voorbeelden
22.1       BIJHOUDEN VAN BASKET ITEMS
In de web services wordt er nergens een state bijgehouden. Dat wil zeggen dat de client applicatie die
gebruik maakt van de web services verantwoordelijk is voor het bijhouden van basket items.
Dit is voornamelijk nodig tussen het betalen en het boeken van de basket.


Aangezien alle objecten worden doorgegeven via webservices zijn alle objecten perfect
serializeerbaar in XML formaat. Dit is dan ook de aangewezen manier om de objecten bij te houden in
bvb een client database.


22.1.1      Helper classes
Onderstaande helper class kan gebruikt worden om vlug objecten te serializeren en deserializeren van
en naar XML.                                                                                             202


public static class XML
    {
        /// <summary>
        /// Serialize an object into an XML string
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="obj"></param>
        /// <returns></returns>
        public static string SerializeObject<T>(T obj)
        {
            string serialXML = String.Empty;
            try
            {
                // Serialize the object
                XmlSerializer xmlSerializer = new XmlSerializer(obj.GetType());
                using (CustomStringWriter stringWriter = new CustomStringWriter())
                {
                    xmlSerializer.Serialize(stringWriter, obj);
                    stringWriter.Flush();
                    serialXML = stringWriter.ToString();
                }
            }
            catch { }
            return serialXML;
        }

            /// <summary>
            /// Reconstruct an object from an XML string
            /// </summary>
            /// <param name="xml"></param>
            /// <returns></returns>
            public static T DeserializeObject<T>(string xml)
            {
                using (StringReader stringReader = new StringReader(xml))
                {
                    XmlSerializer serializer = new XmlSerializer(typeof(T));
                    return (T)serializer.Deserialize(stringReader);
                }
                return default(T);
            }
       }

       public class CustomStringWriter : StringWriter



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
     {
          private Encoding encoding = System.Text.Encoding.UTF8;

          public CustomStringWriter()
              : base()
          {
          }

          public CustomStringWriter(Encoding encoding)
              : base()
          {
              this.encoding = encoding;
          }

          public override Encoding Encoding
          {
              get
              {
                  return encoding;
              }
          }
     }
                                                                                                    203

22.1.2     Statebag
Aan de hand van bovenstaande helper classes kan dan een soort StateBag gemaakt worden waarin
alle nodige objecten worden bijgehouden :
public class StateBag
    {
        public Webshop.Basket Basket { get; set; }
        public Webshop.BasketValidationResult ValidationResult { get; set; }
        public Webshop.CheckoutBasketResult CheckOutResult { get; set; }

             public void Save(string fileName)
             {
                 string xml = XML.SerializeObject(this);
                 File.WriteAllText(fileName, xml);
             }

             public static StateBag Load(string fileName)
             {
                 string xml = File.ReadAllText(fileName);
                 return XML.DeserializeObject<StateBag>(xml);
             }
      }

Deze statebag is slechts een demo voorbeeld.
In deze code wordt de Basket bijgehouden alsook het resultaat van een ValidateBasket en de
CheckoutBasket.
Aan de hand van de Save en Load kan een statebag bewaard worden onder een bestand op schijf.
Afhankelijk van de noden van de client applicatie kan dit aangepast worden om de StateBag bvb bij
te houden in een database.


                     // Prijs herberekenen
                     Webshop.Basket basket = new Webshop.Basket();
                     basket.CustomerId = persons[0].Id;


Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
                     basket.Items = lockBasketResult.BasketItems;
                     webshopService.ReCalculateBasket(ref basket, context);

                     // Status bijhouden van het winkelmandje
                     StateBag statebag = new StateBag { Basket = basket };
                     statebag.Save( fileName );

Dit kan nodig zijn voor het onderzoeken van problemen in de client code of in de ReCreateX
backoffice applicatie wanneer er zich verschillen voordoen tussen de geboekte items in de
webservices en het eindresultaat in de backoffice.


Het is aangeraden om van alle verkopen die gebeuren via de website, deze statebag bij te houden
voor de periode van bvb een maand. Dit laat ons toe om te bekijken wat er geboekt werd via de
webservices en wat er in ReCreateX aanwezig is.


22.2    CREATIE CONTEXT ITEM                                                                             204

Elke webshop service call maakt gebruik van een ServiceContext object waarin een taal, divisie en
webshopid kan worden meegegeven.
                     Webshop.ServiceContext context = new Webshop.ServiceContext();
                     context.Language = "FR";
                     context.ShopId = "00000000-0000-0000-0000-000000000001";

De taalcode die kan worden meegegeven dient voornamelijk voor het bepalen in welke taalcode de
vertalingen moeten worden opgehaald.
Dit is de ISO code van de taal.


In de meeste gevallen worden client applicaties eerst in een testomgeving ontwikkeld voor er wordt
overgegaan naar een productie omgeving. Via de configuratie van de webservices is het heel
eenvoudig om over te schakelen tussen een testomgeving en een productie omgeving, dit gebeurt op
basis van de ShopId.
In de webshop configuratie database verwijst elk ShopId naar een configuratie waarin alle instellingen
worden bijgehouden : Database, gebruiker, verkoopspunt, divisie, …
Het enige wat de service consumer moet doen is in het context object de ShopId instellen op Id van de
juiste omgeving. Deze Id’s worden door Syx Automations toegekend op het ogenblik van installatie en
worden niet meer gewijzigd.


Voorbeeld :
                     //context.ShopId = "00000000-0000-0000-0000-000000000001"; // Testomgeving
                     //context.ShopId = "00000000-0000-0000-0000-000000000002"; // Productie



De DivisionId wordt automatisch ingevuld door de webservice call wanneer de ShopId correct is
ingevuld.



Syx Automations BE           Syx Automations NL
Rozendaalstraat 53           Meesterstraat 2
8900 Ieper                   3861 RE Nijkerk
T. +32 (0)57 22 44 00        T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01        F. +31 (0)33 46 109 33
www.syx.be                   www.syx.nl
Dit context object dient eenmalig te worden aangemaakt in de client omgeving en kan nadien bij elke
service call worden meegegeven.


22.3     EXPOSITIES
Onderstaande code is een uitgewerkt code voorbeeld voor het ophalen van een aantal objecten
rond exposities en voor het boeken van een willekeurige expositie reservering.


22.3.1     Ophalen van de klanten
Ter illustratie worden alle klanten opgehaald, nadien zal de eerste klant gebruikt worden om de
reservering op te boeken.
               // Klanten ophalen
                Webshop.Person[] persons = webshopService.FindPerson(context,
                                               new Webshop.FindPersonsCriteria
                                               { Includes = new Webshop.PersonIncludes {
                                                    Categories = true,
                                                    CategoriesSpecified = true },
                                               });                                                       205


22.3.2     Ophalen van exposities, periodes en prijzen
Om een reservering voor een expositie te kunnen maken, hebben we een expositie en een expositie
periode nodig.
Onderstaande functie haalt alle exposities op en zoekt de eerste periode die na vandaag komt
waarvoor er ook een geldige prijs is.
private bool FindFirstExpositionPeriod(out Webshop.Exposition exposition, out Webshop.ExpositionPeriod
expositionPeriod, out Webshop.Price price)
        {
            exposition = null;
            expositionPeriod = null;
            price = null;

                Webshop.Exposition[] expositions = webshopService.FindExpositions(context,
                   new Webshop.ExpositionSearchCriteria {
                     Includes = new Webshop.ExpositionIncludes
                       { Image = false, ImageSpecified = true,
                         ImageUri = false, ImageUriSpecified = false },
                     From = DateTime.Now, FromSpecified = true,
                     Paging = new Webshop.PagingCriteria {
                       PageIndex = 0, PageIndexSpecified = true,
                       PageSize = 100, PageSizeSpecified = true }
                     });

            foreach (Webshop.Exposition _exposition in expositions)
            {
                if (_exposition.Periods == null || _exposition.Periods.Length == 0)
                {
                    _exposition.Periods = webshopService.ListExpositionPeriods(context, new
Webshop.ExpositionPeriodSearchCriteria
                    {
                        ExpositionId = _exposition.Id//,
                        From = DateTime.Now, FromSpecified = true
                    });

                        }
                        if (_exposition.Prices != null && _exposition.Prices.Length > 0)
                        {
                            price = _exposition.Prices.First(p => p.AmountSpecified && p.Amount > 0);
                            if (price == null)
                                continue;


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                        }

                        if (_exposition.Periods != null && _exposition.Periods.Length > 0)
                        {
                            expositionPeriod = _exposition.Periods.First();
                            exposition = _exposition;
                            break;
                        }
                }

                return (expositionPeriod != null);
          }


Deze functie kan dan gebruikt worden in onze demo code om een expositie, prijs en periode op te
halen zodat we eenvoudig een willekeurige reservering kunnen aanmaken.


               // Willekeurige expositie opzoeken die een geldige periode en een prijs heeft
                Webshop.Exposition exposition;
                Webshop.ExpositionPeriod expositionPeriod;
                Webshop.Price price;
                FindFirstExpositionPeriod(out exposition, out expositionPeriod, out price);             206
                if (exposition == null)
                    throw new ApplicationException("exposition == null");

                if (expositionPeriod == null)
                    throw new ApplicationException("expositionPeriod == null");


22.3.3     Reserveringsobject aanmaken
Onderstaande code maakt op basis van de gevonden expositie gegevens 1 nieuw reserveringsobject
aan en een lock ticket dat 1 uur geldig is.
De reservering bevat een reservatie voor 5 personen op de opgegeven prijsgroep.
Het lock ticket zorgt ervoor dat bij de LockBasketItems automatisch een dummy reservering zal
aangemaakt worden, zodat deze reeds in rekening wordt gebracht bij het tellen van het aantal
resterende plaatsen.
// Reservering aanmaken voor 5 deelnemers
            Webshop.ExpositionPeriodReservation reservation = new Webshop.ExpositionPeriodReservation
            {
                ExpositionPeriodId = expositionPeriod.Id,
                Entries = new Webshop.ExpositionPeriodReservationEntry[]
                {
                  new Webshop.ExpositionPeriodReservationEntry
                  {
                   ParticipantCount = 5, ParticipantCountSpecified = true,
                   PriceGroupId = price.Group.Id
                  }
                  },
                LockTicket = new Webshop.ExpositionReservationLockTicket
                { ExpirationTime = DateTime.Now.AddHours(1) },
                Quantity = 1
            };



22.3.4     Reservering toevoegen aan winkelmandje
Het reserveringsobject dat hierboven werd aangemaakt, moeten we kunnen bijhouden in een lijst
zodat we achteraf ons object nog kunnen terugvinden.
Alle objecten die via de website kunnen gekocht worden, erven over van een BasketItem.
Dus kunnen we een lijst van Basketitems bijhouden via de volgende code :


Syx Automations BE             Syx Automations NL
Rozendaalstraat 53             Meesterstraat 2
8900 Ieper                     3861 RE Nijkerk
T. +32 (0)57 22 44 00          T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01          F. +31 (0)33 46 109 33
www.syx.be                     www.syx.nl
                // Reservering toevoegen aan lijst
                List<Webshop.BasketItem> basketItems = new List<Webshop.BasketItem>();
                basketItems.Add(reservation);



22.3.5     Tijdelijke reservering aanmaken in de database
Na het aanmaken van ons reserveringsobject in code, moeten we dit nog aanmaken in de database,
zodat er rekening mee wordt gehouden in het tellen van de beschikbare plaatsen, en niemand anders
met onze reservering gaat lopen.
De logica is dezelfde voor alle basket items die kunnen worden gelocked.
Hier dienen we enkel onze lijst met basketitems mee te geven aan de LockBasketItems functie.
                // Lijst locken / reserveren
                Webshop.LockBasketResult lockBasketResult = webshopService.LockBasketItems(
                   basketItems.ToArray(), context);
                if (lockBasketResult.IsLocked == false)
                    throw new ApplicationException("lock kon niet worden gezet");
                                                                                                             207
Van de LockBasketItems functie krijgen we een LockBasketResult terug.
In deze LockBasketResult zit binnen de BasketItems de volledige lijst van artikels die gelocked werden.
Voor de verdere afhandeling van de webservices is het van belang dat hier verder gewerkt wordt met
deze nieuwe lijst van artikels, en niet met de originele lijst van artikels die we aan de LockBAsketItems
hebben meegegeven.
Dit is noodzakelijk omdat de LockBasketItems de reserveringen in de database reeds aanmaakt onder
de vorm van tijdelijke reserveringen. De referentie naar de tijdelijke reserveringen krijg je terug binnen
elk BasketItem in de lockBasketResult. Deze is niet ingevuld in de originele lijst met basketItems.


Merk op dat onze tijdelijke reservering slechts een uur geldig is. Dit hebben we zelf gedefinieerd via de
ExpirationTime in het lock ticket dat we eerder hebben aangemaakt.

Wanneer deze tijd verlopen is, zal de reservering automatisch worden verwijderd.
Dit kan voorkomen wanneer de gebruiker bvb de browser heeft afgesloten zonder z’n winkelmandje te
hebben afgehandeld.
Indien het nodig is om de vervaltijd te verlengen, kan dit gedaan worden via de ExtendLockPeriod
functie.
Het is daarom ook van belang dat alle objecten in het winkelmandje aan de client kant ook worden
bijgehouden in een soort StateBag, want aan de service kant wordt er geen State bijgehouden.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
Bijkomstig kan er nog getest worden of alle reserveringen effectief konden gelocked worden.
Dit kunnen we doen door te controleren of het LockTicket wel geldig ID bevat.
                if (lockBasketResult.BasketItems.Any((i) =>
                   (i is Webshop.ExpositionPeriodReservation) &&
                   String.Equals((i as Webshop.ExpositionPeriodReservation).LockTicket.Id,
                                 Guid.Empty.ToString())))
                    throw new ApplicationException("lock kon niet worden gezet");


22.3.6     Prijs van het winkelmandje herberekenen
Nadat de tijdelijke reservering in de database is aangemaakt kan de totale prijs van het winkelmandje
herberekend worden.
Dit is noodzakelijk omdat we pas hier de klant gaan koppelen aan het winkelmandje.
Doordat we hier pas de klant gaan meegeven, kan de prijs eventueel wijzigen.
Merk ook op dat we hier verder werken met de BasketItems uit de lockBasketResult.
Na het herberekenen van de prijs wordt de volledige basket bewaard onder een bestand op schijf. Dit
is puur voor demo doeleinden. In real-word applicaties worden deze beter bijgehouden in een                  208
database.
                // Prijs herberekenen
                Webshop.Basket basket = new Webshop.Basket();
                basket.CustomerId = persons[0].Id;
                basket.Items = lockBasketResult.BasketItems;
                webshopService.ReCalculateBasket(ref basket, context);

                // Status bijhouden van het winkelmandje
                StateBag statebag = new StateBag { Basket = basket };
                statebag.Save(Path.Combine(Path.GetTempPath(), String.Format("{0}.xml", "State 1 - " +
fileguid)));



22.3.7     Betalingen aanmaken
Wanneer de totale prijs van het winkelmandje gekend is, kunnen we kijken om de betaling aan te
maken. Deze betaling is noodzakelijk, omdat bij het uiteindelijk boeken van onze reservering, te totale
prijs van het winkelmandje gelijk moet zijn aan de totale prijs van de aankopen.


In onderstaand code voorbeeld wordt eerst de volledige lijst van betaalwijzes opgehaald.
Nadien wordt puur voor demo doeleinden de betaalwijze “CASH” gezocht.
                // betaling toevoegen
                Webshop.BasketPaymentMethod[] paymentMethods = webshopService.ListPaymentMethods(context);
                Webshop.BasketPaymentMethod contant = paymentMethods.First(p => p.Code == "CASH");
                if (contant == null)
                    throw new ApplicationException("Betalingswijze contant niet gevonden");



Een winkelmandje kan in 1 betaling verschillende betaalwijzes bevatten.
Indien de totale waarde bvb 100 EUR is, kan er bijvoorbeeld 80 EUR contant betaald worden en 20 EUR
via VISA. Dit is echter buiten de scope van dit voorbeeld.
In onderstaand voorbeeld wordt het totale bedrag van de Basket (basket.Price) betaald via
betaalwijze “CASH” die we hierboven hebben opgehaald.

                basket.Payments = new Webshop.BasketPayment[]


Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
                                        {
                                              new Webshop.BasketPayment
                                                  {
                                                      Amount = basket.Price,
                                                      AmountSpecified = true,
                                                      Currency = "€",
                                                      PaymentMethodId = contant.Id
                                                  }
                                        };


22.3.8     Validatie
De laatste stap die moet worden uitgevoerd, voor we ons winkelmandje kunnen gaan boeken, is de
validatie. Hier wordt er een laatste keer gecontroleerd of alles in orde is voor we effectief gaan betalen
en boeken.

Om eventuele betwistingen of problemen achteraf te controleren, is het aangeraden dat het resultaat
van de ValidateBasket ook wordt bijgehouden in de StateBag. Op die manier kan er achteraf nog
gecontroleerd worden wat de inhoud van het winkelmandje was en wat het resultaat was van de                  209
validatie. Vandaar dat in dit voorbeeld het ValidationResult ook is opgenomenin de StateBag.

                // Validatie van het winkelmandje
                statebag.ValidationResult = webshopService.ValidateBasket(basket, context);
                statebag.Save(Path.Combine(Path.GetTempPath(), String.Format("{0}.xml", "State 2 - " +
fileguid)));

            bool isValid = true;
            foreach (Webshop.BasketItemValidationResult result in
statebag.ValidationResult.BasketItemValidationResults)
            {
                if (!result.IsValid)
                {
                    Console.WriteLine("Validatie is mislukt");
                    Console.WriteLine(result.brokenRuleName);
                    Console.WriteLine(result.Message);
                    isValid = false;
                }
            }
            if (!isValid || statebag.ValidationResult.IsValid == false)
                throw new ApplicationException("Validatie is mislukt");


22.3.9     Boeken
Als de validatie in orde is, kan het winkelmandje worden geboekt, waarbij alle tijdelijke reserveringen
worden omgezet in definitieve reserveringen.
Wanneer de betaling gebeurt via een online betaling, wordt er natuurlijk verondersteld dat op dit
ogenblik de betaling al is afgehandeld. Dit dient te gebeuren na het valideren en voor het boeken.
Indien de online betaling niet zou doorgaan, dan worden de tijdelijke reserveringen automatisch
verwijderd uit de database eens de locktickets vervallen zijn.


Hier wordt het resultaat van de checkout opnieuw bijgehouden in de StateBag.
                // --- CHECKOUT
                statebag.CheckOutResult = webshopService.CheckoutBasket(statebag.Basket, context);
                statebag.Save(Path.Combine(Path.GetTempPath(), String.Format("{0}.xml", "State 3 - " +
fileguid)));




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl
22.3.10 Ophalen van ETickets
Bij exposities bestaat er een mogelijkheid om toegangstickets mee te verkopen met de reserveringen.
Deze toegangstickets kunnen ook via web services worden opgevraagd onder de vorm van een PDF
document.
Deze web services zijn geen klassieke SOAP services, maar REST services waarbij de documenten via
een stream kunnen worden gedownload.
Indien dit wordt geïmplementeerd op een website moet enkel een dynamische URL opgebouwd
worden. Wanneer de gebruiker naar deze dynamische URL geredirect wordt, krijgt hij automatisch een
PDF document.


In een klassieke windows applicatie kan dit via onderstaande code worden gedownload, waarbij de
URL en de bestandsnaam worden meegegeven via parameters.
Daarnaast kan er ook een timeout worden meegegeven.
        private static bool SavePdfFileFromURL(string url, string destinationFileName, int             210
timeoutInSeconds)
        {
            // Create a web request to the URL
            HttpWebRequest MyRequest = (HttpWebRequest)WebRequest.Create(url);
            MyRequest.Timeout = timeoutInSeconds * 1000;
            try
            {
                // Get the web response
                HttpWebResponse MyResponse = (HttpWebResponse)MyRequest.GetResponse();

                        // Make sure the response is valid
                        if (HttpStatusCode.OK == MyResponse.StatusCode)
                        {
                            // Open the response stream
                            using (Stream MyResponseStream = MyResponse.GetResponseStream())
                            {
                                // Open the destination file
                                using (FileStream MyFileStream = new FileStream(destinationFileName,
                                       FileMode.OpenOrCreate, FileAccess.Write))
                                {
                                    byte[] MyBuffer = new byte[4096];
                                    int BytesRead;

                                     // Read the chunk of the web response into the buffer
                                     while (0 < (BytesRead = MyResponseStream.Read(
                                                             MyBuffer, 0, MyBuffer.Length)))
                                     {
                                         // Write the chunk from the buffer to the file
                                         MyFileStream.Write(MyBuffer, 0, BytesRead);
                                     }
                                     MyFileStream.Flush();
                                     MyFileStream.Close();
                                }
                            }
                        }
                }

                catch (Exception err)
                {
                    throw new Exception("Error saving file from URL:" + err.Message, err);
                }

                return true;
          }




Syx Automations BE              Syx Automations NL
Rozendaalstraat 53              Meesterstraat 2
8900 Ieper                      3861 RE Nijkerk
T. +32 (0)57 22 44 00           T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01           F. +31 (0)33 46 109 33
www.syx.be                      www.syx.nl
De URL waar het PDF document kan worden opgevraagd bestaat uit een aantal vaste en variabele :
          Host name : is meestal dezelfde locatie waarop de andere Web Services zijn gedeployed. Dit
           wordt door Syx Automations meegedeeld bij deployment van de web services.
          Path :
           Vast gedeelte : WebShopDocumentService.svc/ETickets
           Variabel gedeelte : ShopId / Taal /. SalesLineID


Het SalesLineID is een willekeurig SalesLineID uit de verkoop, omdat achterliggend alle verkoopslijnen uit
dezelfde verkoop worden gecontroleerd of er Etickets voor bestaan.
Dit ID kan worden opgehaald ui de SalesItems van de CheckOutResult.


Voorbeeld :
                string url = String.Format("http://{0}/WebShopDocumentService.svc/ETickets/{1}/{2}/{3}",     211
                                           webshopService.Endpoint.Address.Uri.Authority,
                                           context.ShopId,
                                           context.Language,
                                           salesLineId);
                string salesLineId = statebag.CheckOutResult.SalesItems.First().Id;
                string fileName = Path.Combine(Path.GetTempPath(),
                                               String.Format("{0}.pdf", Guid.NewGuid())
                                              );

                SavePdfFileFromURL(url, fileName, 60);


Het uiteindelijke resultaat is een PDF bestand met als naam een nieuwe uniqueidentifier zodat de naam
uniek blijft.




Syx Automations BE         Syx Automations NL
Rozendaalstraat 53         Meesterstraat 2
8900 Ieper                 3861 RE Nijkerk
T. +32 (0)57 22 44 00      T. +31 (0)33 43 284 16
F. +32 (0)57 22 44 01      F. +31 (0)33 46 109 33
www.syx.be                 www.syx.nl

								
To top