Person Management Service overview

Cirrus Assessment Support Team -

Managing persons

The Person Management Service contains the basic operations defined by the IMS consortium.

Data mapping Person Record Mapping
Data mapping Cirrus Person Record Extensions
Methods for person management List of operations supported by the Cirrus platform
Service URL http://svc.cirrusplatform.com/IMSLIS/PersonManagementService.svc
WSDL URL  https://svc.cirrusplatform.com/IMSLIS/PersonManagementService.svc?wsdl

IMS LIS online documentation.

 

Function descriptions, original WSDL files, request/response examples:

https://www.imsglobal.org/lis/
https://www.imsglobal.org/lis/lisv2p0p1/PMSInfoModelv2p0p1.html

Methods for person management

Cirrus platform supports the following operations:

Data mapping

Person record mapping

IMS LIS Field

Mandatory

Cirrus

Comment

sourcedId

X

SyncKey

Synchronization key. Unique Mandatory for all requests except CreatebyProxyPerson. Needs to be GUID.

name/firstName

X

Firstname

 

name/middleName

 

Middlename

 

name/lastName

X

Lastname

 

userId/userIdValue

X

Username

Unique

- See Extensions below -

 

UserId

 -See Extensions below-

Password

 

Password

If password isn't provided then user can only reset it by email or system administrator can change it manually.

InstitutionRoleType

X

Profile

Important! See transformation table and detailed information in section 'How to give a person the correct profile in cirrusassessment'.

contactInfo/EmailPrimary

Email

 

contactInfo/Mobile

 

Cellular Phone

 

contactInfo/Phone

 

Phone

 

Extensions

    - See below -

 

Cirrus IMS LIS Extensions

Cirrus has defined a "StudentNumber" extension to the standard IMS person object. Using this you can set the User Id of a user's profile in Cirrus. This is often used for student number / student registration number. 

Extension Field name Extension Field value Cirrus
fieldName StudentNumber  
fieldType String  
fieldValue <any alphabetical string; max length 20; needs to be unique>
  • Maps to User Id in Cirrus
  • Needs to be unique!
  • If you don't set this extension field or leave it empty a unique value will be generated by Cirrus.
     
fieldName SpecialNeeds Maps to the Special needs checkbox in the user's profile. This is also know as Ability Accommodation check box.
fieldType Boolean  
fieldValue true/false  
     
fieldName DisableLogin  
fieldType Boolean  
fieldValue true/false Disables Cirrus Login
     
fieldName DisablePasswordReset  
fieldType Boolean  
fieldValue true/false Disables password reset
     
fieldName  UserLabels  

 

fieldType  String  
fieldValue  <alphabetical string of (comma separated list of) value(s)>  
     
fieldName Deleted
  • When user is Deleted and in Trash Can in UI: true; otherwise: false
fieldType Boolean  
  • Person can be updated while in Trash Can via updatePerson. 
fieldValue true/false  

 

Person record example

The following example represents a valid person record for using in Person Management Service.

<ims:personRecord>
  <ims:sourcedGUID>
    <ims:refAgentInstanceID>SystemName</ims:refAgentInstanceID>
    <ims:sourcedId>fd842a1dbe9f47a6a258f14adcbc83b7</ims:sourcedId>
  </ims:sourcedGUID>
  <ims:person>
    <ims:name>
      <ims:nameType>
        <ims:instanceValue>
          <ims:textString>Full</ims:textString>
        </ims:instanceValue>
      </ims:nameType>
      <ims:partName>
        <ims:instanceName>
          <ims:textString>First</ims:textString>
        </ims:instanceName>
        <ims:instanceValue>
          <ims:textString>Richard</ims:textString>
        </ims:instanceValue>
      </ims:partName>
      <ims:partName>
        <ims:instanceName>
          <ims:textString>Last</ims:textString>
        </ims:instanceName>
        <ims:instanceValue>
          <ims:textString>The Lionheart</ims:textString>
        </ims:instanceValue>
      </ims:partName>
      <!--Optional-->
      <ims:partName>
        <ims:instanceName>
          <ims:textString>Middle</ims:textString>
        </ims:instanceName>
        <ims:instanceValue>
          <ims:textString>I</ims:textString>
        </ims:instanceValue>
      </ims:partName>
    </ims:name>
    <ims:contactinfo>
      <ims:contactinfoType>
        <ims:instanceIdentifier>
          <ims:textString>EmailPrimary</ims:textString>
        </ims:instanceIdentifier>
      </ims:contactinfoType>
      <ims:contactinfoValue>
        <ims:textString>richardthelionheart@cirrus.com</ims:textString>
      </ims:contactinfoValue>
    </ims:contactinfo>
    <ims:contactinfo>
      <ims:contactinfoType>
        <ims:instanceIdentifier>
          <ims:textString>Mobile</ims:textString>
        </ims:instanceIdentifier>
      </ims:contactinfoType>
      <ims:contactinfoValue>
        <ims:textString>012345678</ims:textString>
      </ims:contactinfoValue>
    </ims:contactinfo>
    <ims:contactinfo>
      <ims:contactinfoType>
        <ims:instanceIdentifier>
          <ims:textString>TelephonePrimary</ims:textString>
        </ims:instanceIdentifier>
      </ims:contactinfoType>
      <ims:contactinfoValue>
        <ims:textString>012345678</ims:textString>
      </ims:contactinfoValue>
    </ims:contactinfo>
    <ims:roles>
      <ims:institutionRole>
        <ims:institutionroletype>
          <ims:instanceValue>
            <ims:textString>Administrator</ims:textString>
          </ims:instanceValue>
        </ims:institutionroletype>
        <ims:primaryroletype>true</ims:primaryroletype>
      </ims:institutionRole>
      <ims:userId>
        <ims:userIdValue>
          <ims:textString>richardthelionheart</ims:textString>
        </ims:userIdValue>
        <!--Optional-->
        <ims:password>
          <ims:textString>password</ims:textString>
        </ims:password>
      </ims:userId>
    </ims:roles>
    <!--Optional-->
    <ims:extension>
      <ims:extensionField>
        <ims:fieldName>StudentNumber</ims:fieldName>
        <ims:fieldType>String</ims:fieldType>
        <ims:fieldValue>01234567</ims:fieldValue>
      </ims:extensionField>
<!--Enable / Disable Special Needs-->
<ims:extensionField>
<ims:fieldName>SpecialNeeds</ims:fieldName>
<ims:fieldType>Boolean</ims:fieldType>
<ims:fieldValue>false</ims:fieldValue>
</ims:extensionField>
<ims:extensionField>
<ims:fieldName>DisableLogin</ims:fieldName>
<ims:fieldType>Boolean</ims:fieldType>
<ims:fieldValue>true</ims:fieldValue>
</ims:extensionField>
<ims:extensionField>
<ims:fieldName>DisablePasswordReset</ims:fieldName>
<ims:fieldType>Boolean</ims:fieldType>
<ims:fieldValue>false</ims:fieldValue>
</ims:extensionField>
      <ims:extensionField>
  <ims:fieldName>UserLabels</ims:fieldName>
       <ims:fieldType>String</ims:fieldType>
       <ims:fieldValue>label1,label2</ims:fieldValue>
     </ims:extensionField>
<ims:extensionField>
<ims:fieldName>Deleted</fieldName>
<ims:fieldType>Boolean</fieldType>
<ims:fieldValue>false</fieldValue>
<ims:/extensionField>     </ims:extension>   </ims:person> </ims:personRecord>

 

 

Comments 0

Cirrus uses Zendesk to provide our Help Center services. Check out Zendesk's Terms of Service and Privacy Policy, as they govern your use of these services.

Powered by Zendesk