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 Session| Name | 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": "6a8206a7-2208-4036-8951-59509ae3c5da",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2026-11-17T10:16:44.0089829-06:00",
"EndDate": "2026-11-17T10:16:44.0089829-06:00",
"SIFRefId": "341921a0-1824-4659-a06b-37c6d22970b0",
"Id": "b5d9873a-dd56-4c4a-807e-dd57cf7e7330",
"DataVersion": "sample string 8",
"ApiName": ""
},
{
"SiteId": "6a8206a7-2208-4036-8951-59509ae3c5da",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2026-11-17T10:16:44.0089829-06:00",
"EndDate": "2026-11-17T10:16:44.0089829-06:00",
"SIFRefId": "341921a0-1824-4659-a06b-37c6d22970b0",
"Id": "b5d9873a-dd56-4c4a-807e-dd57cf7e7330",
"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">b5d9873a-dd56-4c4a-807e-dd57cf7e7330</Id>
<BeginDate>2026-11-17T10:16:44.0089829-06:00</BeginDate>
<Description>sample string 2</Description>
<EndDate>2026-11-17T10:16:44.0089829-06:00</EndDate>
<SIFRefId>341921a0-1824-4659-a06b-37c6d22970b0</SIFRefId>
<SessionNumber>3</SessionNumber>
<SiteId>6a8206a7-2208-4036-8951-59509ae3c5da</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">b5d9873a-dd56-4c4a-807e-dd57cf7e7330</Id>
<BeginDate>2026-11-17T10:16:44.0089829-06:00</BeginDate>
<Description>sample string 2</Description>
<EndDate>2026-11-17T10:16:44.0089829-06:00</EndDate>
<SIFRefId>341921a0-1824-4659-a06b-37c6d22970b0</SIFRefId>
<SessionNumber>3</SessionNumber>
<SiteId>6a8206a7-2208-4036-8951-59509ae3c5da</SiteId>
</Session>
</ArrayOfSession>