GET api/Sites/{SiteId}/Sessions
Returns the Sessions for a Site.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SiteId |
Application identifier for the Site |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Session objects for the specified SiteId
Collection of SessionName | Description | Type | Additional information |
---|---|---|---|
SiteId |
The application identifier of the Site for the Session. |
globally unique identifier |
None. |
Description |
The description for the Session in the Site. |
string |
None. |
SessionNumber |
The session number for the Session. |
integer |
None. |
BeginDate |
The begin date for the Session. |
date |
None. |
EndDate |
The end date for the Session. |
date |
None. |
SIFRefId |
The SIFRefId of the Session. |
globally unique identifier |
None. |
Id |
The application identifier for the object. This cannot be changed by the user. |
globally unique identifier |
None. |
DataVersion |
The version of the API data |
string |
None. |
ApiName |
The name of the object without the Api suffix |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "SiteId": "6a86f3fc-99bc-4c91-91d1-5538688c094b", "Description": "sample string 2", "SessionNumber": 3, "BeginDate": "2025-06-15T03:30:57.7153528-05:00", "EndDate": "2025-06-15T03:30:57.7153528-05:00", "SIFRefId": "727b479b-700e-41bf-a5b6-020994e7cda3", "Id": "619eb650-db78-45e3-b79d-b58bf4c2b399", "DataVersion": "sample string 8", "ApiName": "" }, { "SiteId": "6a86f3fc-99bc-4c91-91d1-5538688c094b", "Description": "sample string 2", "SessionNumber": 3, "BeginDate": "2025-06-15T03:30:57.7153528-05:00", "EndDate": "2025-06-15T03:30:57.7153528-05:00", "SIFRefId": "727b479b-700e-41bf-a5b6-020994e7cda3", "Id": "619eb650-db78-45e3-b79d-b58bf4c2b399", "DataVersion": "sample string 8", "ApiName": "" } ]
application/xml, text/xml
Sample:
<ArrayOfSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <Session> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 8</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">619eb650-db78-45e3-b79d-b58bf4c2b399</Id> <BeginDate>2025-06-15T03:30:57.7153528-05:00</BeginDate> <Description>sample string 2</Description> <EndDate>2025-06-15T03:30:57.7153528-05:00</EndDate> <SIFRefId>727b479b-700e-41bf-a5b6-020994e7cda3</SIFRefId> <SessionNumber>3</SessionNumber> <SiteId>6a86f3fc-99bc-4c91-91d1-5538688c094b</SiteId> </Session> <Session> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 8</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">619eb650-db78-45e3-b79d-b58bf4c2b399</Id> <BeginDate>2025-06-15T03:30:57.7153528-05:00</BeginDate> <Description>sample string 2</Description> <EndDate>2025-06-15T03:30:57.7153528-05:00</EndDate> <SIFRefId>727b479b-700e-41bf-a5b6-020994e7cda3</SIFRefId> <SessionNumber>3</SessionNumber> <SiteId>6a86f3fc-99bc-4c91-91d1-5538688c094b</SiteId> </Session> </ArrayOfSession>