GET restapi/personal/immersivereader/v1?resourceId={resourceId}&resourceType={resourceType}&contentBlockId={contentBlockId}

Gets the required info for use with Immersive Reader.

Request Information

URI Parameters

Name	Description	Type	Additional information
resourceId	The unique identifier of the resource	integer	Required
resourceType	The type of resource being accessed	Itslearning.RestApi.Entities.ResourceType	Required
contentBlockId	Used for page text content block identification. Defaults to 0 when not applicable	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Itslearning.RestApi.Entities.ImmersiveReaderInfo

Name	Description	Type	Additional information
Title	The title to send to the immersive reader	string	None.
Text	The text to send to the immersive reader	string	None.
AccessToken	The access token to use with the immersive reader	string	None.
SubDomain	The subdomain to use with the immersive reader	string	None.
UiLang	The current language used in the UI	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Text": "sample string 2",
  "AccessToken": "sample string 3",
  "SubDomain": "sample string 4",
  "UiLang": "sample string 5"
}

application/xml, text/xml

Sample:

<ImmersiveReaderInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccessToken>sample string 3</AccessToken>
  <SubDomain>sample string 4</SubDomain>
  <Text>sample string 2</Text>
  <Title>sample string 1</Title>
  <UiLang>sample string 5</UiLang>
</ImmersiveReaderInfo>