GET api/Sites/{SiteId}/Sessions

Returns the Sessions for a Site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "bc7f6756-04d4-4aa5-b0b5-63267ff8974c",
    "Description": "sample string 2",
    "SessionNumber": 3,
    "BeginDate": "2025-04-26T00:23:26.6678214-05:00",
    "EndDate": "2025-04-26T00:23:26.6678214-05:00",
    "SIFRefId": "8e46fcf9-32b7-46ae-a43b-1ce098937d7d",
    "Id": "d2e61fa8-22cf-406f-a65f-4542db2a46c4",
    "DataVersion": "sample string 8",
    "ApiName": ""
  },
  {
    "SiteId": "bc7f6756-04d4-4aa5-b0b5-63267ff8974c",
    "Description": "sample string 2",
    "SessionNumber": 3,
    "BeginDate": "2025-04-26T00:23:26.6678214-05:00",
    "EndDate": "2025-04-26T00:23:26.6678214-05:00",
    "SIFRefId": "8e46fcf9-32b7-46ae-a43b-1ce098937d7d",
    "Id": "d2e61fa8-22cf-406f-a65f-4542db2a46c4",
    "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">d2e61fa8-22cf-406f-a65f-4542db2a46c4</Id>
    <BeginDate>2025-04-26T00:23:26.6678214-05:00</BeginDate>
    <Description>sample string 2</Description>
    <EndDate>2025-04-26T00:23:26.6678214-05:00</EndDate>
    <SIFRefId>8e46fcf9-32b7-46ae-a43b-1ce098937d7d</SIFRefId>
    <SessionNumber>3</SessionNumber>
    <SiteId>bc7f6756-04d4-4aa5-b0b5-63267ff8974c</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">d2e61fa8-22cf-406f-a65f-4542db2a46c4</Id>
    <BeginDate>2025-04-26T00:23:26.6678214-05:00</BeginDate>
    <Description>sample string 2</Description>
    <EndDate>2025-04-26T00:23:26.6678214-05:00</EndDate>
    <SIFRefId>8e46fcf9-32b7-46ae-a43b-1ce098937d7d</SIFRefId>
    <SessionNumber>3</SessionNumber>
    <SiteId>bc7f6756-04d4-4aa5-b0b5-63267ff8974c</SiteId>
  </Session>
</ArrayOfSession>