readPerson

Cirrus Assessment Support Team -

Method description

readPerson is the method used to read person object from Cirrus.

Message Schema

Request parameters

Name

Data type

Description

sourcedId

GUID

The syncID of the person to be read

Response parameters

Name

Data type

Description

personRecord

Object

The person data. See mapping details here

Example

Request message

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
   <soap:Header>
      <ims:imsx_syncRequestHeaderInfo>
         <ims:imsx_version>V1.0</ims:imsx_version>
         <ims:imsx_messageIdentifier></ims:imsx_messageIdentifier>
      </ims:imsx_syncRequestHeaderInfo>
   </soap:Header>
   <soap:Body>
      <ims:readPersonRequest>
         <ims:sourcedId>fd842a1dbe9f47a6a258f14adcbc83b7</ims:sourcedId>
      </ims:readPersonRequest>
   </soap:Body>
</soap:Envelope>

Response message

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0/IPersonManagerSyncPortType/readPersonResponse</a:Action>
      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0" xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <imsx_version>V1.0</imsx_version>
         <imsx_statusInfo>
            <imsx_codeMajor>success</imsx_codeMajor>
            <imsx_severity>status</imsx_severity>
            <imsx_codeMinor>
               <imsx_codeMinorField>
                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>
                  <imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>
               </imsx_codeMinorField>
            </imsx_codeMinor>
         </imsx_statusInfo>
      </h:imsx_syncResponseHeaderInfo>
      <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>2015-07-17T10:10:36.635Z</u:Created>
            <u:Expires>2015-07-17T10:15:36.635Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <readPersonResponse xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
         <personRecord>
            <sourcedGUID>
               <refAgentInstanceID>Cirrus</refAgentInstanceID>
               <sourcedId>fd842a1dbe9f47a6a258f14adcbc83b7</sourcedId>
            </sourcedGUID>
            <person>
               <name>
                  <nameType>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>Preferred</textString>
                     </instanceValue>
                  </nameType>
                  <partName>
                     <instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</instanceVocabulary>
                     <instanceName>
                        <language>en-US</language>
                        <textString>First</textString>
                     </instanceName>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>Richard</textString>
                     </instanceValue>
                  </partName>
                  <partName>
                     <instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</instanceVocabulary>
                     <instanceName>
                        <language>en-US</language>
                        <textString>Middle</textString>
                     </instanceName>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>I</textString>
                     </instanceValue>
                  </partName>
                  <partName>
                     <instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</instanceVocabulary>
                     <instanceName>
                        <language>en-US</language>
                        <textString>Last</textString>
                     </instanceName>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>The Lionheart</textString>
                     </instanceValue>
                  </partName>
               </name>
               <contactinfo>
                  <contactinfoType>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>EmailPrimary</textString>
                     </instanceValue>
                  </contactinfoType>
                  <contactinfoValue>
                     <language>en-US</language>
                     <textString>richardthelionheart@cirrus.com</textString>
                  </contactinfoValue>
               </contactinfo>
               <contactinfo>
                  <contactinfoType>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>Mobile</textString>
                     </instanceValue>
                  </contactinfoType>
                  <contactinfoValue>
                     <language>en-US</language>
                     <textString>012345678</textString>
                  </contactinfoValue>
               </contactinfo>
               <contactinfo>
                  <contactinfoType>
                     <instanceValue>
                        <language>en-US</language>
                        <textString>Telephone</textString>
                     </instanceValue>
                  </contactinfoType>
                  <contactinfoValue>
                     <language>en-US</language>
                     <textString>012345678</textString>
                  </contactinfoValue>
               </contactinfo>
               <roles>
                  <institutionRole>
                     <institutionroletype>
                        <instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/institutionroletypevocabularyv1p0p2.xml</instanceVocabulary>
                        <instanceValue>
                           <language>en-US</language>
                           <textString>Administrator</textString>
                        </instanceValue>
                     </institutionroletype>
                     <primaryroletype>true</primaryroletype>
                  </institutionRole>
                  <userId>
                     <userIdValue>
                        <language>en-US</language>
                        <textString>richardthelionheart</textString>
                     </userIdValue>
                  </userId>
               </roles>
               <extension>
                  <extensionField>
<fieldName>StudentNumber</fieldName>
<fieldType>String</fieldType>
<fieldValue>0123456789876</fieldValue>
</extensionField>
<extensionField>
<fieldName>DisableLogin</fieldName>
<fieldType>Boolean</fieldType>
<fieldValue>false</fieldValue>
</extensionField>
<extensionField>
<fieldName>DisablePasswordReset</fieldName>
<fieldType>Boolean</fieldType>
<fieldValue>true</fieldValue>
</extensionField>
<extensionField>
<fieldName>Deleted</fieldName>
<fieldType>Boolean</fieldType>
<fieldValue>false</fieldValue>
</extensionField>
<extensionField>
<fieldName>SpecialNeeds</fieldName>
<fieldType>Boolean</fieldType>
<fieldValue>true</fieldValue>
<extensionField>
<fieldName>UserLabels</fieldName>
<fieldType>String</fieldType>
<fieldValue>ExampleString1</fieldValue>
</extensionField> </extension> </person> </personRecord> </readPersonResponse> </s:Body> </s:Envelope>

 

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