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": "341fef49-d3a4-4413-88ad-b7a41ef9cb89",
"Description": "sample string 2",
"SessionNumber": 3,
"BeginDate": "2025-11-04T08:56:41.2456358-06:00",
"EndDate": "2025-11-04T08:56:41.2456358-06:00",
"SIFRefId": "e4b11c78-a9e8-4010-bead-aa6b869d2034",
"Id": "753ccf74-77d1-4039-b0c6-2d775d3d91cc",
"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">753ccf74-77d1-4039-b0c6-2d775d3d91cc</Id> <BeginDate>2025-11-04T08:56:41.2456358-06:00</BeginDate> <Description>sample string 2</Description> <EndDate>2025-11-04T08:56:41.2456358-06:00</EndDate> <SIFRefId>e4b11c78-a9e8-4010-bead-aa6b869d2034</SIFRefId> <SessionNumber>3</SessionNumber> <SiteId>341fef49-d3a4-4413-88ad-b7a41ef9cb89</SiteId> </Session>