reach-api-sdk 1.0.211 → 1.0.213

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1704,6 +1704,201 @@ paths:
1704
1704
  text/json:
1705
1705
  schema:
1706
1706
  $ref: '#/components/schemas/ValidationResultModel'
1707
+ '/api/activity-type-categories/{id}':
1708
+ get:
1709
+ tags:
1710
+ - ActivityTypeCategory
1711
+ summary: Gets a Reach.Models.ActivityTypeCategory by its Id.
1712
+ operationId: GetObject
1713
+ parameters:
1714
+ - name: id
1715
+ in: path
1716
+ description: The Reach.Models.ActivityTypeCategory id.
1717
+ required: true
1718
+ schema:
1719
+ type: integer
1720
+ format: int32
1721
+ responses:
1722
+ '200':
1723
+ description: OK
1724
+ content:
1725
+ text/plain:
1726
+ schema:
1727
+ $ref: '#/components/schemas/ActivityTypeCategory'
1728
+ application/json:
1729
+ schema:
1730
+ $ref: '#/components/schemas/ActivityTypeCategory'
1731
+ text/json:
1732
+ schema:
1733
+ $ref: '#/components/schemas/ActivityTypeCategory'
1734
+ '400':
1735
+ description: Bad Request
1736
+ content:
1737
+ text/plain:
1738
+ schema:
1739
+ $ref: '#/components/schemas/ReachError'
1740
+ application/json:
1741
+ schema:
1742
+ $ref: '#/components/schemas/ReachError'
1743
+ text/json:
1744
+ schema:
1745
+ $ref: '#/components/schemas/ReachError'
1746
+ '500':
1747
+ description: Internal Server Error
1748
+ content:
1749
+ text/plain:
1750
+ schema:
1751
+ $ref: '#/components/schemas/ReachError'
1752
+ application/json:
1753
+ schema:
1754
+ $ref: '#/components/schemas/ReachError'
1755
+ text/json:
1756
+ schema:
1757
+ $ref: '#/components/schemas/ReachError'
1758
+ '422':
1759
+ description: Unprocessable Content
1760
+ content:
1761
+ text/plain:
1762
+ schema:
1763
+ $ref: '#/components/schemas/ValidationResultModel'
1764
+ application/json:
1765
+ schema:
1766
+ $ref: '#/components/schemas/ValidationResultModel'
1767
+ text/json:
1768
+ schema:
1769
+ $ref: '#/components/schemas/ValidationResultModel'
1770
+ /api/activity-type-categories:
1771
+ get:
1772
+ tags:
1773
+ - ActivityTypeCategory
1774
+ summary: Gets a list of Reach.Models.Activity.
1775
+ operationId: GetList
1776
+ parameters:
1777
+ - name: Name
1778
+ in: query
1779
+ description: Gets or sets the queryable name.
1780
+ schema:
1781
+ type: string
1782
+ - name: PageNumber
1783
+ in: query
1784
+ description: Gets or sets the page number for paged queries.
1785
+ schema:
1786
+ type: integer
1787
+ format: int32
1788
+ - name: Take
1789
+ in: query
1790
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
1791
+ schema:
1792
+ type: integer
1793
+ format: int32
1794
+ - name: Skip
1795
+ in: query
1796
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
1797
+ schema:
1798
+ type: integer
1799
+ format: int32
1800
+ - name: LimitListRequests
1801
+ in: query
1802
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
1803
+ schema:
1804
+ type: boolean
1805
+ - name: TenantId
1806
+ in: query
1807
+ description: Gets or sets the Tenant Id.
1808
+ schema:
1809
+ type: string
1810
+ format: uuid
1811
+ - name: ModifiedById
1812
+ in: query
1813
+ description: Gets or sets the Modifed By Id.
1814
+ schema:
1815
+ type: string
1816
+ format: uuid
1817
+ - name: ModifiedByIds
1818
+ in: query
1819
+ description: Gets or sets the Modifed By Ids.
1820
+ schema:
1821
+ type: array
1822
+ items:
1823
+ type: string
1824
+ format: uuid
1825
+ - name: DateCreatedGTE
1826
+ in: query
1827
+ description: Gets or sets the Date Created greater than equal to.
1828
+ schema:
1829
+ type: string
1830
+ format: date-time
1831
+ - name: DateCreatedLTE
1832
+ in: query
1833
+ description: Gets or sets the Date Created less than equal to.
1834
+ schema:
1835
+ type: string
1836
+ format: date-time
1837
+ - name: IsLive
1838
+ in: query
1839
+ description: Gets or sets the queryable only is live status.
1840
+ schema:
1841
+ type: boolean
1842
+ - name: SortOrderDirection
1843
+ in: query
1844
+ description: Gets or sets the sort order direction.
1845
+ schema:
1846
+ $ref: '#/components/schemas/SearchSortOrderDirection'
1847
+ responses:
1848
+ '200':
1849
+ description: OK
1850
+ content:
1851
+ text/plain:
1852
+ schema:
1853
+ type: array
1854
+ items:
1855
+ $ref: '#/components/schemas/ActivityTypeCategory'
1856
+ application/json:
1857
+ schema:
1858
+ type: array
1859
+ items:
1860
+ $ref: '#/components/schemas/ActivityTypeCategory'
1861
+ text/json:
1862
+ schema:
1863
+ type: array
1864
+ items:
1865
+ $ref: '#/components/schemas/ActivityTypeCategory'
1866
+ '400':
1867
+ description: Bad Request
1868
+ content:
1869
+ text/plain:
1870
+ schema:
1871
+ $ref: '#/components/schemas/ReachError'
1872
+ application/json:
1873
+ schema:
1874
+ $ref: '#/components/schemas/ReachError'
1875
+ text/json:
1876
+ schema:
1877
+ $ref: '#/components/schemas/ReachError'
1878
+ '500':
1879
+ description: Internal Server Error
1880
+ content:
1881
+ text/plain:
1882
+ schema:
1883
+ $ref: '#/components/schemas/ReachError'
1884
+ application/json:
1885
+ schema:
1886
+ $ref: '#/components/schemas/ReachError'
1887
+ text/json:
1888
+ schema:
1889
+ $ref: '#/components/schemas/ReachError'
1890
+ '422':
1891
+ description: Unprocessable Content
1892
+ content:
1893
+ text/plain:
1894
+ schema:
1895
+ $ref: '#/components/schemas/ValidationResultModel'
1896
+ application/json:
1897
+ schema:
1898
+ $ref: '#/components/schemas/ValidationResultModel'
1899
+ text/json:
1900
+ schema:
1901
+ $ref: '#/components/schemas/ValidationResultModel'
1707
1902
  '/api/amenities/{id}':
1708
1903
  get:
1709
1904
  tags:
@@ -9874,6 +10069,12 @@ paths:
9874
10069
  schema:
9875
10070
  type: string
9876
10071
  format: uuid
10072
+ - name: ProviderId
10073
+ in: query
10074
+ description: Gets or sets the queryable Provider Id.
10075
+ schema:
10076
+ type: string
10077
+ format: uuid
9877
10078
  - name: SurveyId
9878
10079
  in: query
9879
10080
  description: Gets or sets the queryable Survey Id.
@@ -10353,6 +10554,12 @@ paths:
10353
10554
  schema:
10354
10555
  type: string
10355
10556
  format: uuid
10557
+ - name: ProviderId
10558
+ in: query
10559
+ description: Gets or sets the queryable Provider Id.
10560
+ schema:
10561
+ type: string
10562
+ format: uuid
10356
10563
  - name: SurveyId
10357
10564
  in: query
10358
10565
  description: Gets or sets the queryable Survey Id.
@@ -10654,6 +10861,12 @@ paths:
10654
10861
  schema:
10655
10862
  type: string
10656
10863
  format: uuid
10864
+ - name: ProviderId
10865
+ in: query
10866
+ description: Gets or sets the queryable Provider Id.
10867
+ schema:
10868
+ type: string
10869
+ format: uuid
10657
10870
  - name: SurveyId
10658
10871
  in: query
10659
10872
  description: Gets or sets the queryable Survey Id.
@@ -10958,6 +11171,12 @@ paths:
10958
11171
  schema:
10959
11172
  type: string
10960
11173
  format: uuid
11174
+ - name: ProviderId
11175
+ in: query
11176
+ description: Gets or sets the queryable Provider Id.
11177
+ schema:
11178
+ type: string
11179
+ format: uuid
10961
11180
  - name: SurveyId
10962
11181
  in: query
10963
11182
  description: Gets or sets the queryable Survey Id.
@@ -11265,6 +11484,12 @@ paths:
11265
11484
  schema:
11266
11485
  type: string
11267
11486
  format: uuid
11487
+ - name: ProviderId
11488
+ in: query
11489
+ description: Gets or sets the queryable Provider Id.
11490
+ schema:
11491
+ type: string
11492
+ format: uuid
11268
11493
  - name: SurveyId
11269
11494
  in: query
11270
11495
  description: Gets or sets the queryable Survey Id.
@@ -28464,6 +28689,11 @@ paths:
28464
28689
  description: Gets or sets a value indicating does session is private or no.
28465
28690
  schema:
28466
28691
  type: boolean
28692
+ - name: IncludeActivityFacets
28693
+ in: query
28694
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
28695
+ schema:
28696
+ type: boolean
28467
28697
  - name: SearchGeoCenter
28468
28698
  in: query
28469
28699
  description: Gets or sets SearchGeoCenter.
@@ -28480,6 +28710,12 @@ paths:
28480
28710
  schema:
28481
28711
  type: integer
28482
28712
  format: int32
28713
+ - name: ActivityTypeCategoryId
28714
+ in: query
28715
+ description: Gets or sets Activity type category id.
28716
+ schema:
28717
+ type: integer
28718
+ format: int32
28483
28719
  - name: ActivityIds
28484
28720
  in: query
28485
28721
  description: Gets or sets the queryable session Activity ids.
@@ -28859,6 +29095,11 @@ paths:
28859
29095
  description: Gets or sets a value indicating does session is private or no.
28860
29096
  schema:
28861
29097
  type: boolean
29098
+ - name: IncludeActivityFacets
29099
+ in: query
29100
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
29101
+ schema:
29102
+ type: boolean
28862
29103
  - name: SearchGeoCenter
28863
29104
  in: query
28864
29105
  description: Gets or sets SearchGeoCenter.
@@ -28875,6 +29116,12 @@ paths:
28875
29116
  schema:
28876
29117
  type: integer
28877
29118
  format: int32
29119
+ - name: ActivityTypeCategoryId
29120
+ in: query
29121
+ description: Gets or sets Activity type category id.
29122
+ schema:
29123
+ type: integer
29124
+ format: int32
28878
29125
  - name: ActivityIds
28879
29126
  in: query
28880
29127
  description: Gets or sets the queryable session Activity ids.
@@ -29185,6 +29432,11 @@ paths:
29185
29432
  description: Gets or sets a value indicating does session is private or no.
29186
29433
  schema:
29187
29434
  type: boolean
29435
+ - name: IncludeActivityFacets
29436
+ in: query
29437
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
29438
+ schema:
29439
+ type: boolean
29188
29440
  - name: SearchGeoCenter
29189
29441
  in: query
29190
29442
  description: Gets or sets SearchGeoCenter.
@@ -29201,6 +29453,12 @@ paths:
29201
29453
  schema:
29202
29454
  type: integer
29203
29455
  format: int32
29456
+ - name: ActivityTypeCategoryId
29457
+ in: query
29458
+ description: Gets or sets Activity type category id.
29459
+ schema:
29460
+ type: integer
29461
+ format: int32
29204
29462
  - name: ActivityIds
29205
29463
  in: query
29206
29464
  description: Gets or sets the queryable session Activity ids.
@@ -29514,6 +29772,11 @@ paths:
29514
29772
  description: Gets or sets a value indicating does session is private or no.
29515
29773
  schema:
29516
29774
  type: boolean
29775
+ - name: IncludeActivityFacets
29776
+ in: query
29777
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
29778
+ schema:
29779
+ type: boolean
29517
29780
  - name: SearchGeoCenter
29518
29781
  in: query
29519
29782
  description: Gets or sets SearchGeoCenter.
@@ -29530,6 +29793,12 @@ paths:
29530
29793
  schema:
29531
29794
  type: integer
29532
29795
  format: int32
29796
+ - name: ActivityTypeCategoryId
29797
+ in: query
29798
+ description: Gets or sets Activity type category id.
29799
+ schema:
29800
+ type: integer
29801
+ format: int32
29533
29802
  - name: ActivityIds
29534
29803
  in: query
29535
29804
  description: Gets or sets the queryable session Activity ids.
@@ -29840,6 +30109,11 @@ paths:
29840
30109
  description: Gets or sets a value indicating does session is private or no.
29841
30110
  schema:
29842
30111
  type: boolean
30112
+ - name: IncludeActivityFacets
30113
+ in: query
30114
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
30115
+ schema:
30116
+ type: boolean
29843
30117
  - name: SearchGeoCenter
29844
30118
  in: query
29845
30119
  description: Gets or sets SearchGeoCenter.
@@ -29856,6 +30130,12 @@ paths:
29856
30130
  schema:
29857
30131
  type: integer
29858
30132
  format: int32
30133
+ - name: ActivityTypeCategoryId
30134
+ in: query
30135
+ description: Gets or sets Activity type category id.
30136
+ schema:
30137
+ type: integer
30138
+ format: int32
29859
30139
  - name: ActivityIds
29860
30140
  in: query
29861
30141
  description: Gets or sets the queryable session Activity ids.
@@ -30172,6 +30452,11 @@ paths:
30172
30452
  description: Gets or sets a value indicating does session is private or no.
30173
30453
  schema:
30174
30454
  type: boolean
30455
+ - name: IncludeActivityFacets
30456
+ in: query
30457
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
30458
+ schema:
30459
+ type: boolean
30175
30460
  - name: SearchGeoCenter
30176
30461
  in: query
30177
30462
  description: Gets or sets SearchGeoCenter.
@@ -30188,6 +30473,12 @@ paths:
30188
30473
  schema:
30189
30474
  type: integer
30190
30475
  format: int32
30476
+ - name: ActivityTypeCategoryId
30477
+ in: query
30478
+ description: Gets or sets Activity type category id.
30479
+ schema:
30480
+ type: integer
30481
+ format: int32
30191
30482
  - name: ActivityIds
30192
30483
  in: query
30193
30484
  description: Gets or sets the queryable session Activity ids.
@@ -67603,6 +67894,12 @@ paths:
67603
67894
  schema:
67604
67895
  type: string
67605
67896
  format: uuid
67897
+ - name: ProviderId
67898
+ in: query
67899
+ description: Gets or sets the queryable Provider Id.
67900
+ schema:
67901
+ type: string
67902
+ format: uuid
67606
67903
  - name: SurveyId
67607
67904
  in: query
67608
67905
  description: Gets or sets the queryable Survey Id.
@@ -68275,6 +68572,12 @@ paths:
68275
68572
  schema:
68276
68573
  type: string
68277
68574
  format: uuid
68575
+ - name: ProviderId
68576
+ in: query
68577
+ description: Gets or sets the queryable Provider Id.
68578
+ schema:
68579
+ type: string
68580
+ format: uuid
68278
68581
  - name: SurveyId
68279
68582
  in: query
68280
68583
  description: Gets or sets the queryable Survey Id.
@@ -70291,6 +70594,11 @@ paths:
70291
70594
  description: Gets or sets a value indicating does session is private or no.
70292
70595
  schema:
70293
70596
  type: boolean
70597
+ - name: IncludeActivityFacets
70598
+ in: query
70599
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
70600
+ schema:
70601
+ type: boolean
70294
70602
  - name: SearchGeoCenter
70295
70603
  in: query
70296
70604
  description: Gets or sets SearchGeoCenter.
@@ -70307,6 +70615,12 @@ paths:
70307
70615
  schema:
70308
70616
  type: integer
70309
70617
  format: int32
70618
+ - name: ActivityTypeCategoryId
70619
+ in: query
70620
+ description: Gets or sets Activity type category id.
70621
+ schema:
70622
+ type: integer
70623
+ format: int32
70310
70624
  - name: ActivityIds
70311
70625
  in: query
70312
70626
  description: Gets or sets the queryable session Activity ids.
@@ -70617,6 +70931,11 @@ paths:
70617
70931
  description: Gets or sets a value indicating does session is private or no.
70618
70932
  schema:
70619
70933
  type: boolean
70934
+ - name: IncludeActivityFacets
70935
+ in: query
70936
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
70937
+ schema:
70938
+ type: boolean
70620
70939
  - name: SearchGeoCenter
70621
70940
  in: query
70622
70941
  description: Gets or sets SearchGeoCenter.
@@ -70633,6 +70952,12 @@ paths:
70633
70952
  schema:
70634
70953
  type: integer
70635
70954
  format: int32
70955
+ - name: ActivityTypeCategoryId
70956
+ in: query
70957
+ description: Gets or sets Activity type category id.
70958
+ schema:
70959
+ type: integer
70960
+ format: int32
70636
70961
  - name: ActivityIds
70637
70962
  in: query
70638
70963
  description: Gets or sets the queryable session Activity ids.
@@ -70835,13 +71160,13 @@ paths:
70835
71160
  content:
70836
71161
  text/plain:
70837
71162
  schema:
70838
- $ref: '#/components/schemas/GenericActivityPage'
71163
+ $ref: '#/components/schemas/ActivitySearchResponse'
70839
71164
  application/json:
70840
71165
  schema:
70841
- $ref: '#/components/schemas/GenericActivityPage'
71166
+ $ref: '#/components/schemas/ActivitySearchResponse'
70842
71167
  text/json:
70843
71168
  schema:
70844
- $ref: '#/components/schemas/GenericActivityPage'
71169
+ $ref: '#/components/schemas/ActivitySearchResponse'
70845
71170
  '400':
70846
71171
  description: Bad Request
70847
71172
  content:
@@ -70948,6 +71273,11 @@ paths:
70948
71273
  description: Gets or sets a value indicating does session is private or no.
70949
71274
  schema:
70950
71275
  type: boolean
71276
+ - name: IncludeActivityFacets
71277
+ in: query
71278
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
71279
+ schema:
71280
+ type: boolean
70951
71281
  - name: SearchGeoCenter
70952
71282
  in: query
70953
71283
  description: Gets or sets SearchGeoCenter.
@@ -70964,6 +71294,12 @@ paths:
70964
71294
  schema:
70965
71295
  type: integer
70966
71296
  format: int32
71297
+ - name: ActivityTypeCategoryId
71298
+ in: query
71299
+ description: Gets or sets Activity type category id.
71300
+ schema:
71301
+ type: integer
71302
+ format: int32
70967
71303
  - name: ActivityIds
70968
71304
  in: query
70969
71305
  description: Gets or sets the queryable session Activity ids.
@@ -71219,33 +71555,290 @@ paths:
71219
71555
  get:
71220
71556
  tags:
71221
71557
  - PublicGenericActivity
71222
- summary: Retrieves a list of activity facets.
71558
+ summary: "Retrieves activity facets with counts for the given location/distance. Call this first after user selects location,\r\nthen use the activity ids to filter the main search (network or network/optimized)."
71223
71559
  operationId: GetActivityFacets
71224
71560
  parameters:
71561
+ - name: Wildcard
71562
+ in: query
71563
+ description: Gets or sets the wildcard for use in a query search.
71564
+ schema:
71565
+ type: string
71566
+ - name: VenueId
71567
+ in: query
71568
+ description: Gets or sets the queryable Venue Id.
71569
+ schema:
71570
+ type: string
71571
+ format: uuid
71572
+ - name: ProviderId
71573
+ in: query
71574
+ description: Gets or sets the queryable Provider Id.
71575
+ schema:
71576
+ type: string
71577
+ format: uuid
71578
+ - name: ProgrammeId
71579
+ in: query
71580
+ description: Gets or sets the queryable Programme Id.
71581
+ schema:
71582
+ type: string
71583
+ format: uuid
71584
+ - name: Online
71585
+ in: query
71586
+ description: Gets or sets a value indicating whether return online activities.
71587
+ schema:
71588
+ type: boolean
71589
+ - name: Archived
71590
+ in: query
71591
+ description: Gets or sets a value indicating whether to include archived activities.
71592
+ schema:
71593
+ type: boolean
71594
+ - name: Deleted
71595
+ in: query
71596
+ description: Gets or sets a value indicating whether to include deleted activities.
71597
+ schema:
71598
+ type: boolean
71599
+ - name: ActivityType
71600
+ in: query
71601
+ description: Gets or sets the activity type.
71602
+ schema:
71603
+ $ref: '#/components/schemas/ActivityType'
71604
+ - name: IncludeNextOpportunity
71605
+ in: query
71606
+ description: Gets or sets a value indicating whether to inlcude the activities next availability.
71607
+ schema:
71608
+ type: boolean
71609
+ - name: Featured
71610
+ in: query
71611
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
71612
+ schema:
71613
+ type: boolean
71614
+ - name: Private
71615
+ in: query
71616
+ description: Gets or sets a value indicating does session is private or no.
71617
+ schema:
71618
+ type: boolean
71619
+ - name: IncludeActivityFacets
71620
+ in: query
71621
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
71622
+ schema:
71623
+ type: boolean
71624
+ - name: SearchGeoCenter
71625
+ in: query
71626
+ description: Gets or sets SearchGeoCenter.
71627
+ schema:
71628
+ type: string
71629
+ - name: OpenactiveActivityId
71630
+ in: query
71631
+ description: Gets or sets OpenactiveActivityId.
71632
+ schema:
71633
+ type: string
71634
+ - name: ActivityId
71635
+ in: query
71636
+ description: Gets or sets Activity id.
71637
+ schema:
71638
+ type: integer
71639
+ format: int32
71640
+ - name: ActivityTypeCategoryId
71641
+ in: query
71642
+ description: Gets or sets Activity type category id.
71643
+ schema:
71644
+ type: integer
71645
+ format: int32
71646
+ - name: ActivityIds
71647
+ in: query
71648
+ description: Gets or sets the queryable session Activity ids.
71649
+ schema:
71650
+ type: array
71651
+ items:
71652
+ type: integer
71653
+ format: int32
71654
+ - name: NetworkId
71655
+ in: query
71656
+ description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
71657
+ schema:
71658
+ type: string
71659
+ format: uuid
71660
+ - name: TenantStatus
71661
+ in: query
71662
+ description: Gets or sets a value indicating whether the results should return a specific tenant status.
71663
+ schema:
71664
+ $ref: '#/components/schemas/TenantStatus'
71225
71665
  - name: Lat
71226
71666
  in: query
71227
- description: Gets or sets lat.
71667
+ description: Gets or sets Lat.
71228
71668
  schema:
71229
71669
  type: number
71230
71670
  format: float
71231
71671
  - name: Lng
71232
71672
  in: query
71233
- description: Gets or sets lng.
71673
+ description: Gets or sets Lng.
71234
71674
  schema:
71235
71675
  type: number
71236
71676
  format: float
71237
- - name: Radius
71677
+ - name: Distance
71238
71678
  in: query
71239
- description: Gets or sets id.
71679
+ description: Gets or sets Distance.
71240
71680
  schema:
71241
71681
  type: number
71242
71682
  format: float
71243
- - name: NetworkId
71683
+ - name: MinAgeLTE
71244
71684
  in: query
71245
- description: Gets or sets NetworkId.
71685
+ description: Gets or sets MinAgeLTE.
71686
+ schema:
71687
+ type: integer
71688
+ format: int32
71689
+ - name: MinAgeGTE
71690
+ in: query
71691
+ description: Gets or sets MinAgeGTE.
71692
+ schema:
71693
+ type: integer
71694
+ format: int32
71695
+ - name: MaxAgeLTE
71696
+ in: query
71697
+ description: Gets or sets MaxAgeLTE.
71698
+ schema:
71699
+ type: integer
71700
+ format: int32
71701
+ - name: MaxAgeGTE
71702
+ in: query
71703
+ description: Gets or sets MaxAgeGTE.
71704
+ schema:
71705
+ type: integer
71706
+ format: int32
71707
+ - name: PriceTotalGTE
71708
+ in: query
71709
+ description: Gets or sets PriceTotalGTE.
71710
+ schema:
71711
+ type: number
71712
+ format: double
71713
+ - name: PriceTotalLTE
71714
+ in: query
71715
+ description: Gets or sets PriceTotalLTE.
71716
+ schema:
71717
+ type: number
71718
+ format: double
71719
+ - name: TimeOfDay
71720
+ in: query
71721
+ description: Gets or sets TimeOfDay.
71722
+ schema:
71723
+ type: string
71724
+ - name: StartDateTimeGTE
71725
+ in: query
71726
+ description: Gets or sets StartDateTimeGTE.
71727
+ schema:
71728
+ type: string
71729
+ format: date-time
71730
+ - name: EndDateTimeLTE
71731
+ in: query
71732
+ description: Gets or sets EndDateTimeLTE.
71733
+ schema:
71734
+ type: string
71735
+ format: date-time
71736
+ - name: Gender
71737
+ in: query
71738
+ description: Gets or sets Gender.
71739
+ schema:
71740
+ $ref: '#/components/schemas/Gender'
71741
+ - name: PeriodsOfWeek
71742
+ in: query
71743
+ description: Gets or sets PeriodsOfWeek.
71744
+ schema:
71745
+ $ref: '#/components/schemas/PeriodsOfWeek'
71746
+ - name: AdditionalSupport
71747
+ in: query
71748
+ description: Gets or sets AdditionalSupport.
71749
+ schema:
71750
+ type: array
71751
+ items:
71752
+ type: string
71753
+ - name: Amenity
71754
+ in: query
71755
+ description: Gets or sets AmenityId.
71756
+ schema:
71757
+ type: array
71758
+ items:
71759
+ type: integer
71760
+ format: int32
71761
+ - name: VenueTypeIds
71762
+ in: query
71763
+ description: Gets or sets a list of venue type ids.
71764
+ schema:
71765
+ type: array
71766
+ items:
71767
+ type: string
71768
+ format: uuid
71769
+ - name: ProgrammeIds
71770
+ in: query
71771
+ description: Gets or sets the Programme ids.
71772
+ schema:
71773
+ type: array
71774
+ items:
71775
+ type: string
71776
+ format: uuid
71777
+ - name: PageNumber
71778
+ in: query
71779
+ description: Gets or sets the page number for paged queries.
71780
+ schema:
71781
+ type: integer
71782
+ format: int32
71783
+ - name: Take
71784
+ in: query
71785
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
71786
+ schema:
71787
+ type: integer
71788
+ format: int32
71789
+ - name: Skip
71790
+ in: query
71791
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
71792
+ schema:
71793
+ type: integer
71794
+ format: int32
71795
+ - name: LimitListRequests
71796
+ in: query
71797
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
71798
+ schema:
71799
+ type: boolean
71800
+ - name: TenantId
71801
+ in: query
71802
+ description: Gets or sets the Tenant Id.
71246
71803
  schema:
71247
71804
  type: string
71248
71805
  format: uuid
71806
+ - name: ModifiedById
71807
+ in: query
71808
+ description: Gets or sets the Modifed By Id.
71809
+ schema:
71810
+ type: string
71811
+ format: uuid
71812
+ - name: ModifiedByIds
71813
+ in: query
71814
+ description: Gets or sets the Modifed By Ids.
71815
+ schema:
71816
+ type: array
71817
+ items:
71818
+ type: string
71819
+ format: uuid
71820
+ - name: DateCreatedGTE
71821
+ in: query
71822
+ description: Gets or sets the Date Created greater than equal to.
71823
+ schema:
71824
+ type: string
71825
+ format: date-time
71826
+ - name: DateCreatedLTE
71827
+ in: query
71828
+ description: Gets or sets the Date Created less than equal to.
71829
+ schema:
71830
+ type: string
71831
+ format: date-time
71832
+ - name: IsLive
71833
+ in: query
71834
+ description: Gets or sets the queryable only is live status.
71835
+ schema:
71836
+ type: boolean
71837
+ - name: SortOrderDirection
71838
+ in: query
71839
+ description: Gets or sets the sort order direction.
71840
+ schema:
71841
+ $ref: '#/components/schemas/SearchSortOrderDirection'
71249
71842
  responses:
71250
71843
  '200':
71251
71844
  description: OK
@@ -71254,17 +71847,17 @@ paths:
71254
71847
  schema:
71255
71848
  type: array
71256
71849
  items:
71257
- $ref: '#/components/schemas/Activity'
71850
+ $ref: '#/components/schemas/ActivityFacet'
71258
71851
  application/json:
71259
71852
  schema:
71260
71853
  type: array
71261
71854
  items:
71262
- $ref: '#/components/schemas/Activity'
71855
+ $ref: '#/components/schemas/ActivityFacet'
71263
71856
  text/json:
71264
71857
  schema:
71265
71858
  type: array
71266
71859
  items:
71267
- $ref: '#/components/schemas/Activity'
71860
+ $ref: '#/components/schemas/ActivityFacet'
71268
71861
  '400':
71269
71862
  description: Bad Request
71270
71863
  content:
@@ -71366,6 +71959,11 @@ paths:
71366
71959
  description: Gets or sets a value indicating does session is private or no.
71367
71960
  schema:
71368
71961
  type: boolean
71962
+ - name: IncludeActivityFacets
71963
+ in: query
71964
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
71965
+ schema:
71966
+ type: boolean
71369
71967
  - name: SearchGeoCenter
71370
71968
  in: query
71371
71969
  description: Gets or sets SearchGeoCenter.
@@ -71382,6 +71980,12 @@ paths:
71382
71980
  schema:
71383
71981
  type: integer
71384
71982
  format: int32
71983
+ - name: ActivityTypeCategoryId
71984
+ in: query
71985
+ description: Gets or sets Activity type category id.
71986
+ schema:
71987
+ type: integer
71988
+ format: int32
71385
71989
  - name: ActivityIds
71386
71990
  in: query
71387
71991
  description: Gets or sets the queryable session Activity ids.
@@ -71584,13 +72188,13 @@ paths:
71584
72188
  content:
71585
72189
  text/plain:
71586
72190
  schema:
71587
- $ref: '#/components/schemas/GenericActivityPage'
72191
+ $ref: '#/components/schemas/ActivitySearchResponse'
71588
72192
  application/json:
71589
72193
  schema:
71590
- $ref: '#/components/schemas/GenericActivityPage'
72194
+ $ref: '#/components/schemas/ActivitySearchResponse'
71591
72195
  text/json:
71592
72196
  schema:
71593
- $ref: '#/components/schemas/GenericActivityPage'
72197
+ $ref: '#/components/schemas/ActivitySearchResponse'
71594
72198
  '400':
71595
72199
  description: Bad Request
71596
72200
  content:
@@ -71697,6 +72301,11 @@ paths:
71697
72301
  description: Gets or sets a value indicating does session is private or no.
71698
72302
  schema:
71699
72303
  type: boolean
72304
+ - name: IncludeActivityFacets
72305
+ in: query
72306
+ description: "Gets or sets a value indicating whether to include activity facets (with counts) in the search response.\r\nOnly applies when SearchGeoCenter or Lat/Lng are provided. Use for single-call fetches of activities and facets."
72307
+ schema:
72308
+ type: boolean
71700
72309
  - name: SearchGeoCenter
71701
72310
  in: query
71702
72311
  description: Gets or sets SearchGeoCenter.
@@ -71713,6 +72322,12 @@ paths:
71713
72322
  schema:
71714
72323
  type: integer
71715
72324
  format: int32
72325
+ - name: ActivityTypeCategoryId
72326
+ in: query
72327
+ description: Gets or sets Activity type category id.
72328
+ schema:
72329
+ type: integer
72330
+ format: int32
71716
72331
  - name: ActivityIds
71717
72332
  in: query
71718
72333
  description: Gets or sets the queryable session Activity ids.
@@ -73153,6 +73768,12 @@ paths:
73153
73768
  schema:
73154
73769
  type: string
73155
73770
  format: uuid
73771
+ - name: ProviderId
73772
+ in: query
73773
+ description: Gets or sets the queryable Provider Id.
73774
+ schema:
73775
+ type: string
73776
+ format: uuid
73156
73777
  - name: IncludeNextOpportunity
73157
73778
  in: query
73158
73779
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -80156,6 +80777,12 @@ paths:
80156
80777
  schema:
80157
80778
  type: string
80158
80779
  format: uuid
80780
+ - name: ProviderId
80781
+ in: query
80782
+ description: Gets or sets the queryable Provider Id.
80783
+ schema:
80784
+ type: string
80785
+ format: uuid
80159
80786
  - name: IncludeNextOpportunity
80160
80787
  in: query
80161
80788
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -81185,6 +81812,12 @@ paths:
81185
81812
  schema:
81186
81813
  type: string
81187
81814
  format: uuid
81815
+ - name: ProviderId
81816
+ in: query
81817
+ description: Gets or sets the queryable Provider Id.
81818
+ schema:
81819
+ type: string
81820
+ format: uuid
81188
81821
  - name: IncludeNextOpportunity
81189
81822
  in: query
81190
81823
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -98772,6 +99405,12 @@ paths:
98772
99405
  schema:
98773
99406
  type: string
98774
99407
  format: uuid
99408
+ - name: ProviderId
99409
+ in: query
99410
+ description: Gets or sets the queryable Provider Id.
99411
+ schema:
99412
+ type: string
99413
+ format: uuid
98775
99414
  - name: IncludeNextOpportunity
98776
99415
  in: query
98777
99416
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -99253,6 +99892,12 @@ paths:
99253
99892
  schema:
99254
99893
  type: string
99255
99894
  format: uuid
99895
+ - name: ProviderId
99896
+ in: query
99897
+ description: Gets or sets the queryable Provider Id.
99898
+ schema:
99899
+ type: string
99900
+ format: uuid
99256
99901
  - name: IncludeNextOpportunity
99257
99902
  in: query
99258
99903
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -99556,6 +100201,12 @@ paths:
99556
100201
  schema:
99557
100202
  type: string
99558
100203
  format: uuid
100204
+ - name: ProviderId
100205
+ in: query
100206
+ description: Gets or sets the queryable Provider Id.
100207
+ schema:
100208
+ type: string
100209
+ format: uuid
99559
100210
  - name: IncludeNextOpportunity
99560
100211
  in: query
99561
100212
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -99862,6 +100513,12 @@ paths:
99862
100513
  schema:
99863
100514
  type: string
99864
100515
  format: uuid
100516
+ - name: ProviderId
100517
+ in: query
100518
+ description: Gets or sets the queryable Provider Id.
100519
+ schema:
100520
+ type: string
100521
+ format: uuid
99865
100522
  - name: IncludeNextOpportunity
99866
100523
  in: query
99867
100524
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -100171,6 +100828,12 @@ paths:
100171
100828
  schema:
100172
100829
  type: string
100173
100830
  format: uuid
100831
+ - name: ProviderId
100832
+ in: query
100833
+ description: Gets or sets the queryable Provider Id.
100834
+ schema:
100835
+ type: string
100836
+ format: uuid
100174
100837
  - name: IncludeNextOpportunity
100175
100838
  in: query
100176
100839
  description: Gets or sets a value indicating whether to inlcude the sessions next availability.
@@ -146999,6 +147662,11 @@ components:
146999
147662
  description: Gets or sets the activities Icon url.
147000
147663
  format: uri
147001
147664
  nullable: true
147665
+ activityTypeCategoryId:
147666
+ type: integer
147667
+ description: Gets or sets the activities type category id.
147668
+ format: int32
147669
+ nullable: true
147002
147670
  surfaces:
147003
147671
  type: array
147004
147672
  items:
@@ -147007,6 +147675,29 @@ components:
147007
147675
  nullable: true
147008
147676
  additionalProperties: false
147009
147677
  description: Represents an activity category within the Reach application.
147678
+ ActivityFacet:
147679
+ type: object
147680
+ properties:
147681
+ id:
147682
+ type: integer
147683
+ description: Gets or sets the activity id.
147684
+ format: int32
147685
+ default: 0
147686
+ name:
147687
+ type: string
147688
+ description: Gets or sets the activity name.
147689
+ nullable: true
147690
+ openactiveActivityId:
147691
+ type: string
147692
+ description: Gets or sets the OpenActive activity identifier.
147693
+ nullable: true
147694
+ count:
147695
+ type: integer
147696
+ description: Gets or sets the count of activities of this type within the search criteria.
147697
+ format: int32
147698
+ default: 0
147699
+ additionalProperties: false
147700
+ description: Represents an activity facet with count for filtering in location-based search.
147010
147701
  ActivityPerformance:
147011
147702
  required:
147012
147703
  - dateCreated
@@ -147145,6 +147836,25 @@ components:
147145
147836
  format: uuid
147146
147837
  additionalProperties: false
147147
147838
  description: Post model for Activity Performance inserts.
147839
+ ActivitySearchResponse:
147840
+ type: object
147841
+ properties:
147842
+ pagination:
147843
+ $ref: '#/components/schemas/Pagination'
147844
+ items:
147845
+ type: array
147846
+ items:
147847
+ $ref: '#/components/schemas/GenericActivity'
147848
+ description: Gets or sets the activity items.
147849
+ nullable: true
147850
+ activityFacets:
147851
+ type: array
147852
+ items:
147853
+ $ref: '#/components/schemas/ActivityFacet'
147854
+ description: 'Gets or sets the activity facets with counts, when includeActivityFacets=true and location params are provided.'
147855
+ nullable: true
147856
+ additionalProperties: false
147857
+ description: Response wrapper for activity search that can optionally include activity facets.
147148
147858
  ActivityType:
147149
147859
  enum:
147150
147860
  - Facility
@@ -147152,6 +147862,20 @@ components:
147152
147862
  - Course
147153
147863
  type: string
147154
147864
  description: The activity type.
147865
+ ActivityTypeCategory:
147866
+ type: object
147867
+ properties:
147868
+ id:
147869
+ type: integer
147870
+ description: Gets or sets the activities Id.
147871
+ format: int32
147872
+ default: 0
147873
+ name:
147874
+ type: string
147875
+ description: Gets or sets the activities type category Name.
147876
+ nullable: true
147877
+ additionalProperties: false
147878
+ description: Represents an activity type category within the Reach application.
147155
147879
  AddressBookItem:
147156
147880
  type: object
147157
147881
  properties:
@@ -156478,6 +157202,8 @@ components:
156478
157202
  type: string
156479
157203
  description: Gets or sets the contact website.
156480
157204
  nullable: true
157205
+ upcomingLayout:
157206
+ $ref: '#/components/schemas/UpcomingLayout'
156481
157207
  facebookUrl:
156482
157208
  type: string
156483
157209
  description: Gets or sets the facebook url.
@@ -156518,10 +157244,29 @@ components:
156518
157244
  $ref: '#/components/schemas/User'
156519
157245
  description: Gets or sets the providers assigned users.
156520
157246
  nullable: true
157247
+ activityLocations:
157248
+ type: array
157249
+ items:
157250
+ $ref: '#/components/schemas/ProviderActivityLocation'
157251
+ description: Gets or sets the distinct locations/venues where the provider offers activities.
157252
+ nullable: true
156521
157253
  country:
156522
157254
  $ref: '#/components/schemas/Country'
156523
157255
  additionalProperties: false
156524
157256
  description: Represents a Provider within the Reach application.
157257
+ ProviderActivityLocation:
157258
+ type: object
157259
+ properties:
157260
+ formattedAddress:
157261
+ type: string
157262
+ description: Gets or sets the full formatted address.
157263
+ nullable: true
157264
+ formattedAddressShortened:
157265
+ type: string
157266
+ description: 'Gets or sets the shortened formatted address (locality, region, postal code).'
157267
+ nullable: true
157268
+ additionalProperties: false
157269
+ description: Represents a location (venue) where a provider offers activities.
156525
157270
  ProviderCreate:
156526
157271
  required:
156527
157272
  - addressPostalcode
@@ -156722,6 +157467,8 @@ components:
156722
157467
  type: string
156723
157468
  description: Gets or sets the contact website.
156724
157469
  nullable: true
157470
+ upcomingLayout:
157471
+ $ref: '#/components/schemas/UpcomingLayout'
156725
157472
  facebookUrl:
156726
157473
  type: string
156727
157474
  description: Gets or sets the organisations social media Urls.
@@ -161923,6 +162670,10 @@ components:
161923
162670
  type: boolean
161924
162671
  description: Gets or sets a value indicating whether providers are enabled for the tenant (only applicable to enterprise tenants).
161925
162672
  default: false
162673
+ enableProgrammes:
162674
+ type: boolean
162675
+ description: Gets or sets a value indicating whether programmes are enabled for the tenant (only applicable to enterprise tenants).
162676
+ default: false
161926
162677
  walletTrackingLevel:
161927
162678
  $ref: '#/components/schemas/WalletTrackingLevel'
161928
162679
  walletOnlyPayments:
@@ -162051,6 +162802,23 @@ components:
162051
162802
  nullable: true
162052
162803
  upcomingLayout:
162053
162804
  $ref: '#/components/schemas/UpcomingLayout'
162805
+ defaultUpcomingLayoutForVenues:
162806
+ $ref: '#/components/schemas/UpcomingLayout'
162807
+ defaultUpcomingLayoutForProviders:
162808
+ $ref: '#/components/schemas/UpcomingLayout'
162809
+ defaultUpcomingLayoutForProgrammes:
162810
+ $ref: '#/components/schemas/UpcomingLayout'
162811
+ defaultMapDistance:
162812
+ type: integer
162813
+ description: Gets or sets the default map distance in kilometres. Used when displaying the map on the website.
162814
+ format: int32
162815
+ nullable: true
162816
+ defaultMapCenterPlaceId:
162817
+ type: string
162818
+ description: Gets or sets the default map center Google Place ID. Used when displaying the map on the website.
162819
+ nullable: true
162820
+ websiteHomepage:
162821
+ $ref: '#/components/schemas/WebsiteHomepage'
162054
162822
  additionalProperties: false
162055
162823
  description: Represents an organisation within the Reach application.
162056
162824
  TenantWebsiteSettingPage:
@@ -162133,6 +162901,25 @@ components:
162133
162901
  type: string
162134
162902
  description: Gets or sets the tenants website marketing optin text.
162135
162903
  nullable: true
162904
+ upcomingLayout:
162905
+ $ref: '#/components/schemas/UpcomingLayout'
162906
+ defaultUpcomingLayoutForVenues:
162907
+ $ref: '#/components/schemas/UpcomingLayout'
162908
+ defaultUpcomingLayoutForProviders:
162909
+ $ref: '#/components/schemas/UpcomingLayout'
162910
+ defaultUpcomingLayoutForProgrammes:
162911
+ $ref: '#/components/schemas/UpcomingLayout'
162912
+ defaultMapDistance:
162913
+ type: integer
162914
+ description: Gets or sets the default map distance in kilometres. Used when displaying the map on the website.
162915
+ format: int32
162916
+ nullable: true
162917
+ defaultMapCenterPlaceId:
162918
+ type: string
162919
+ description: Gets or sets the default map center Google Place ID. Used when displaying the map on the website.
162920
+ nullable: true
162921
+ websiteHomepage:
162922
+ $ref: '#/components/schemas/WebsiteHomepage'
162136
162923
  additionalProperties: false
162137
162924
  description: Post model for tenant website setting updates.
162138
162925
  TenantWebsiteSettingPost:
@@ -164974,4 +165761,10 @@ components:
164974
165761
  - Refund
164975
165762
  - Adjustment
164976
165763
  type: string
164977
- description: Controls the wallet transaction type.
165764
+ description: Controls the wallet transaction type.
165765
+ WebsiteHomepage:
165766
+ enum:
165767
+ - Default
165768
+ - Map
165769
+ type: string
165770
+ description: Determines the website homepage display.