Read.BehaviourRemarks

This method allows you to retrieve behavior remarks for specified student or all students belonging specified hierarchy.

Input parameters

Name

Description

Type

Mandatory/Optional

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

PageIndex

Index of the requested page.

Integer

Optional (defaults to 0)

PageSize

Size of the requested page.

Integer

Optional (defaults to 100)

PersonId

Person's identifier

Integer

Optional

PersonSynckey

Person's synchronization key

NOTE: If person id/synckey is used, all behaviour remarks for the person will be returned

String

Optional

HierarchyId

Identifier of hierarchy

Integer

Optional

HierarchySyncKey

Synchronization key of hierarchy

NOTE: If hierarchy id/synckey is used, all behaviour remarks for all students in the hierarchy will be returned

NOTE: you cannot use both person and hierarchy

String

Optional

FromDate

From date filter

DateTime

Optional

ToDate

To date filter

DateTime

Optional

TermId

Identifier of the term

NOTE: use either TermId or FromDate and ToDate

Integer

Optional

Output parameters

Name

Description

Type

CurrentPageIndex

The index of the current page.

Integer

PageSize

The size of the current page.

Integer

Total

The total number of items which meet the input parameters.

Integer

BehaviourRemarks

Array of behavior remarks containing one row for each behavior remark in the page.

BehaviourRemark[]

  • PersonId

Person's identifier

Integer

  • PersonSyncKey

Person's synchronization key

String

  • Date

Date of the behaviour remark

DateTime

  • CourseId

Identifier of the course.

Integer

  • CourseSyncKey

SyncKey of the course.

String

  • Type

Type of the behaviour remark.

Enum

  • Positive

  • Negative

  • Code

The code of behavour remark.

  • Weight

The weight of behavour remark.

Boolean

  • Description

The description of behavour remark.

Integer

  • Reaction

The reaction for behavour remark.

String

  • LastEditBy

The person who have edited the behaviour remark the last time.

String

Example #1

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"
xmlns:its="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
xmlns:its1="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.ReadBehaviourRemarks">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadBehavourRemarks>
<tem:request>
<its1:PersonId>400001</its1:PersonId>
<its1:TermId>1</its1:TermId>
</tem:request>
</tem:ReadBehavourRemarks>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<u:Timestamp u:Id="_0">
<u:Created>2017-06-09T10:18:01.790Z</u:Created>
<u:Expires>2017-06-09T10:23:01.790Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<ReadBehavourRemarksResponse xmlns="http://tempuri.org/">
<ReadBehavourRemarksResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.ReadBehaviourRemarks" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CurrentPageIndex xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">0</CurrentPageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">100</PageSize>
<Total xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">3</Total>
<a:BehaviourRemarks>
<a:BehaviourRemark>
<a:Code>EW</a:Code>
<a:CourseId>6</a:CourseId>
<a:CourseSyncKey/>
<a:Date>2016-12-15T00:00:00</a:Date>
<a:Description>Yoooo</a:Description>
<a:LastEditBy>Admin, Admin</a:LastEditBy>
<a:PersonId>400001</a:PersonId>
<a:PersonSyncKey>9990</a:PersonSyncKey>
<a:Reaction/>
<a:Type>Positive</a:Type>
<a:Weight>1</a:Weight>
</a:BehaviourRemark>
<a:BehaviourRemark>
<a:Code>A</a:Code>
<a:CourseId>18</a:CourseId>
<a:CourseSyncKey/>
<a:Date>2016-01-26T00:00:00</a:Date>
<a:Description>tghhh</a:Description>
<a:LastEditBy>Admin, Admin</a:LastEditBy>
<a:PersonId>400001</a:PersonId>
<a:PersonSyncKey>9990</a:PersonSyncKey>
<a:Reaction>hghgghhg</a:Reaction>
<a:Type>Positive</a:Type>
<a:Weight>1</a:Weight>
</a:BehaviourRemark>
<a:BehaviourRemark>
<a:Code>CA</a:Code>
<a:CourseId>18</a:CourseId>
<a:CourseSyncKey/>
<a:Date>2016-01-26T00:00:00</a:Date>
<a:Description>yhthg</a:Description>
<a:LastEditBy>Admin, Admin</a:LastEditBy>
<a:PersonId>400001</a:PersonId>
<a:PersonSyncKey>9990</a:PersonSyncKey>
<a:Reaction>hghgg</a:Reaction>
<a:Type>Positive</a:Type>
<a:Weight>1</a:Weight>
</a:BehaviourRemark>
</a:BehaviourRemarks>
</ReadBehavourRemarksResult>
</ReadBehavourRemarksResponse>
</s:Body>
</s:Envelope>

Error states

The following cases will return an error:

  • The person or hierarchy are not specified.

  • Both person and hierarchy are specified.

  • The term or date range are not specified.

  • Both term and date range specified.

  • The requested person does not exists.

  • The requested person exists, but belongs to an organisation the requester does not have access to.

  • The requested hierarchy does not exists.