Account Reporting Service (ARS)

Location: /external/readi/services/v1/reporting.cfc?wsdl

The Account Reporting Service allows third party systems to easily query the SmarterMeasure system to gain access to valuable assessment data. Data points that can be retrieved with this service include: completion percentage, section scoring, sub-scale scoring, account requested data, demographic data, and more.


properties:
methods: getTests, getUserOverview


getTests
remote xml getTests ( string AccessKey="", string TimeStamp="", string Resource="", string RequestSignature="", string UserID="", string InternalID="", string FirstName="", string LastName="", string EmailAddress="", string Gender="", string AdminGroupUserName="0", string TestingGroupUserName="0", string ExtendedData="", boolean IncludeAccountRequestedData="false", struct AccountRequestedDataCriteriaStruct="[runtime expression]", string StartDate="", string EndDate="", string UpdateStartDate="", string UpdateEndDate="", numeric StartRecord="0", numeric EndRecord="0", boolean IncludeQuestionLevelData="false", string ReturnFormat="xml" )

Returns assessment data based on the criteria provided.

Output: suppressed
Parameters:
   AccessKey: string, optional, AccessKey - The access key issued by SmarterMeasure
   TimeStamp: string, optional, TimeStamp - The time stamp of the current request
   Resource: string, optional, Resource - The resource being accessed.
   RequestSignature: string, optional, RequestSignature - The request signature that was generated based on the SmarterMeasure integration documentation.
   UserID: string, optional, UserID - This can be a comma sep. list of SmarterMeasure user Ids.
   InternalID: string, optional, InternalID
   FirstName: string, optional, FirstName
   LastName: string, optional, LastName
   EmailAddress: string, optional, EmailAddress
   Gender: string, optional, Gender
   AdminGroupUserName: string, optional, AdminGroupUserName
   TestingGroupUserName: string, optional, TestingGroupUserName
   ExtendedData: string, optional, ExtendedData - If passed, the results will include the detailed scores for the sections passed in here. This is a comma delimited list. Valid data points are LifeFactors, LearnStyles, PersonalAttributes, TechComp, TechKnowledge, Demographic.
   IncludeAccountRequestedData: boolean, optional, IncludeAccountRequestedData
   AccountRequestedDataCriteriaStruct: struct, optional, AccountRequestedDataCriteriaStruct
   StartDate: string, optional, StartDate - When wanting to filter by date started, this is the start date of the date range.
   EndDate: string, optional, EndDate - When wanting to filter by date started, this is the end date of the date range.
   UpdateStartDate: string, optional, UpdateStartDate - When wanting to filter by date updated, this is the start date of the date range.
   UpdateEndDate: string, optional, UpdateEndDate - When wanting to filter by date updated, this is the end date of the date range.
   StartRecord: numeric, optional, StartRecord
   EndRecord: numeric, optional, EndRecord
   IncludeQuestionLevelData: boolean, optional, IncludeQuestionLevelData
   ReturnFormat: string, optional, ReturnFormat - Only xml is supported at this time.

getUserOverview
remote xml getUserOverview ( string AccessKey="", string TimeStamp="", string Resource="", string RequestSignature="", string UserID="", string InternalID="", string UseSSL="false", string ReturnFormat="xml" )

Returns a general overview for a specific user. This includes information about each section - details, section order, and score. This can be used to create dashboard like components in third party systems.

Output: suppressed
Parameters:
   AccessKey: string, optional, AccessKey - The access key issued by SmarterMeasure
   TimeStamp: string, optional, TimeStamp - The time stamp of the current request
   Resource: string, optional, Resource - The resource being accessed.
   RequestSignature: string, optional, RequestSignature - The request signature that was generated based on the SmarterMeasure integration documentation.
   UserID: string, optional, UserID - This can be a comma sep. list of SmarterMeasure user Ids.
   InternalID: string, optional, InternalID - The ID of the user from an external system.
   UseSSL: string, optional, UseSSL - If URL or IMG SRC references should be returned with SSL. This default to True.
   ReturnFormat: string, optional, ReturnFormat - Only xml is supported at this time.