GET restapi/personal/progressreport/reportsubjects/v1?personSyncKey={personSyncKey}&fromDateTime={fromDateTime}&toDateTime={toDateTime}&subjectIds={subjectIds}

Gets list of subjects the person learning objectives aggregated progress report is based on.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
personSyncKey

[Optional] The person sync key. Optional, if not supplied the report is constructed based on a caller of the this api method (gets identity from a authorization information).

string

None.

fromDateTime

[Optional] Report period start date. Optional, if not supplied a date of the earliest learning objective assessment date is used. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.

date

None.

toDateTime

[Optional] Report period stop date. Optional, if not supplied the current date is used. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.

date

None.

subjectIds

[Optional] The subject ids to filter by.

string

None.

Body Parameters

None.

Response Information

Resource Description

EntityListOfItslearning.RestApi.Entities.LearningObjectiveProgressReport.ReportSubject
NameDescriptionTypeAdditional information
EntityArray

Collection of Itslearning.RestApi.Entities.LearningObjectiveProgressReport.ReportSubject

None.

Total

integer

None.

CurrentPageIndex

integer

None.

PageSize

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityArray": [
    {
      "Id": 1,
      "Title": "sample string 2"
    },
    {
      "Id": 1,
      "Title": "sample string 2"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <ReportSubject>
      <Id>1</Id>
      <Title>sample string 2</Title>
    </ReportSubject>
    <ReportSubject>
      <Id>1</Id>
      <Title>sample string 2</Title>
    </ReportSubject>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>