GET SessionInformation?SessionCode={SessionCode}

Gets information for the session, based on the SessionCode provided

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SessionCode

The SessionCode for the desired Session

string

Required

Body Parameters

None.

Response Information

Resource Description

EventSessionLimited
NameDescriptionTypeAdditional information
Eventpk

A reference for the event that this session is tied to.

string

None.

Sessionpk

A reference for this session.

string

None.

isVerificationVisit

If the session is a verification visit, this value will be set to true.

boolean

None.

SiteContactName

The name of the site contact.

string

None.

SiteContactPhoneNumber

The name of the site phone number.

string

None.

EstimatedParticipants

The number of participants we estimate will be there.

integer

None.

RegisteredParticipants

The number of participants that registered. This could be null if a registration did not occur for the session.

integer

None.

ArrivalTime

The time service providers should arrive at the session.

string

None.

StartTime

The time the examinations should begin.

string

None.

EndTime

The time the examinations should end.

string

None.

DepartureTime

The time service providers should be leaving the site.

string

None.

AssignedExaminers

The examiners assigned to the session.

Collection of AssignedExaminer

None.

Response Formats

application/json, text/json

Sample:
{
  "SiteContactName": "sample string 1",
  "SiteContactPhoneNumber": "sample string 2",
  "EstimatedParticipants": 3,
  "RegisteredParticipants": 1,
  "ArrivalTime": "sample string 4",
  "StartTime": "sample string 5",
  "EndTime": "sample string 6",
  "DepartureTime": "sample string 7",
  "AssignedExaminers": [
    {
      "Name": "sample string 1",
      "Phone": "sample string 2",
      "Role": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Phone": "sample string 2",
      "Role": "sample string 3"
    }
  ],
  "Eventpk": "sample string 1",
  "Sessionpk": "sample string 2",
  "isVerificationVisit": true
}

application/xml, text/xml

Sample:
<EventSessionLimited xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SiteContactName>sample string 1</SiteContactName>
  <SiteContactPhoneNumber>sample string 2</SiteContactPhoneNumber>
  <EstimatedParticipants>3</EstimatedParticipants>
  <RegisteredParticipants>1</RegisteredParticipants>
  <ArrivalTime>sample string 4</ArrivalTime>
  <StartTime>sample string 5</StartTime>
  <EndTime>sample string 6</EndTime>
  <DepartureTime>sample string 7</DepartureTime>
  <AssignedExaminers>
    <AssignedExaminer>
      <Name>sample string 1</Name>
      <Phone>sample string 2</Phone>
      <Role>sample string 3</Role>
    </AssignedExaminer>
    <AssignedExaminer>
      <Name>sample string 1</Name>
      <Phone>sample string 2</Phone>
      <Role>sample string 3</Role>
    </AssignedExaminer>
  </AssignedExaminers>
  <Eventpk>sample string 1</Eventpk>
  <Sessionpk>sample string 2</Sessionpk>
  <isVerificationVisit>true</isVerificationVisit>
</EventSessionLimited>