GET api/Sessions/{SessionId}
Returns a Session.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionId |
Application identifier for the Session |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Session object for the specified SessionId
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": "e9c5fdf1-eb6e-4132-bdd3-faf5f80cb896",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2025-12-20T02:43:20.1394272-06:00",
"EndDate": "2025-12-20T02:43:20.1394272-06:00",
"SIFRefId": "d6fe36b6-2c15-4a21-8dfe-d9aa5e41afc9",
"Id": "fde68c31-d11a-4335-8ab8-607869468996",
"DataVersion": "sample string 8",
"ApiName": ""
}
application/xml, text/xml
Sample:
<Session xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 8</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">fde68c31-d11a-4335-8ab8-607869468996</Id> <BeginDate>2025-12-20T02:43:20.1394272-06:00</BeginDate> <Description>sample string 2</Description> <EndDate>2025-12-20T02:43:20.1394272-06:00</EndDate> <SIFRefId>d6fe36b6-2c15-4a21-8dfe-d9aa5e41afc9</SIFRefId> <SessionNumber>3</SessionNumber> <SiteId>e9c5fdf1-eb6e-4132-bdd3-faf5f80cb896</SiteId> </Session>