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": "bd0d1cb9-fcbb-4034-9aa6-7cb07d387fde",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2026-02-19T11:04:58.1388098-06:00",
"EndDate": "2026-02-19T11:04:58.1388098-06:00",
"SIFRefId": "3019c71c-efa6-4ddd-bc58-8f9c1ce8ef03",
"Id": "6bce7824-1c63-4957-9e1c-f1cfe5ac0938",
"DataVersion": "sample string 8",
"ApiName": ""
},
{
"SiteId": "bd0d1cb9-fcbb-4034-9aa6-7cb07d387fde",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2026-02-19T11:04:58.1388098-06:00",
"EndDate": "2026-02-19T11:04:58.1388098-06:00",
"SIFRefId": "3019c71c-efa6-4ddd-bc58-8f9c1ce8ef03",
"Id": "6bce7824-1c63-4957-9e1c-f1cfe5ac0938",
"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">6bce7824-1c63-4957-9e1c-f1cfe5ac0938</Id>
<BeginDate>2026-02-19T11:04:58.1388098-06:00</BeginDate>
<Description>sample string 2</Description>
<EndDate>2026-02-19T11:04:58.1388098-06:00</EndDate>
<SIFRefId>3019c71c-efa6-4ddd-bc58-8f9c1ce8ef03</SIFRefId>
<SessionNumber>3</SessionNumber>
<SiteId>bd0d1cb9-fcbb-4034-9aa6-7cb07d387fde</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">6bce7824-1c63-4957-9e1c-f1cfe5ac0938</Id>
<BeginDate>2026-02-19T11:04:58.1388098-06:00</BeginDate>
<Description>sample string 2</Description>
<EndDate>2026-02-19T11:04:58.1388098-06:00</EndDate>
<SIFRefId>3019c71c-efa6-4ddd-bc58-8f9c1ce8ef03</SIFRefId>
<SessionNumber>3</SessionNumber>
<SiteId>bd0d1cb9-fcbb-4034-9aa6-7cb07d387fde</SiteId>
</Session>
</ArrayOfSession>