readPerson

Method description

readPerson is the method used to read one person object from itslearning

Preconditions for use

You will need to know the syncID of the person you want to read.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
<sourcedId><identifier>	The *syncID* of the person to be inserted	Text	Max 64 chars	M

Response message elements

Name	Description	Data type
<person>	The Person data to be stored in the new record. Refer to Managing persons for full details on the person object	Object

The <ExtensionField> 'IsExternalUser' will be returned with <fieldValue> 'True' in the response if the user was created externally, i.e. the user is from another site and participating in a community course.

This is in addition to the <Extension> that can be inserted/updated using create/update/replacePerson(s) (CustomString fields, email information, relationship, see description under createPerson').

Example

Description

I want to read person data from person with syncID = 333222 from itslearning.

Example request message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns:ims1="http://www.imsglobal.org/services/pms/xsd/imsPersonManMessSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">
    <soapenv:Header>
        <ims:syncRequestHeaderInfo>
            <ims:messageIdentifier>1</ims:messageIdentifier>
        </ims:syncRequestHeaderInfo>
    </soapenv:Header>
    <soapenv:Body>
        <ims1:readPersonRequest>
            <ims1:sourcedId>
                <ims2:identifier>333222</ims2:identifier>
            </ims1:sourcedId>
        </ims1:readPersonRequest>
    </soapenv:Body>
</soapenv:Envelope>

Example response message

<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>
      <h:syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
         <messageIdentifier>1</messageIdentifier>
         <statusInfo>
            <codeMajor>success</codeMajor>
            <severity>status</severity>
            <messageIdRef>1</messageIdRef>
         </statusInfo>
      </h: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>2013-07-25T07:48:37.640Z</u:Created>
            <u:Expires>2013-07-25T07:53:37.640Z</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/pms/xsd/imsPersonManMessSchema_v1p0">
         <person>
            <formatName xsi:nil="true" xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0"/>
            <name xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <partName>
                  <namePartType>First</namePartType>
                  <namePartValue>Marilyn</namePartValue>
               </partName>
               <partName>
                  <namePartType>Last</namePartType>
                  <namePartValue>Monroe</namePartValue>
               </partName>
               <partName>
                  <namePartType>Nick</namePartType>
                  <namePartValue>The Blonde Bombshell</namePartValue>
               </partName>
            </name>
            <email xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">[email protected]</email>
            <URL xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0"/>
            <userId xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <userIdValue xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">marmon</userIdValue>
            </userId>
            <address xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <extadd/>
               <locality/>
               <postcode/>
               <street/>
            </address>
            <demographics xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <gender>Male</gender>
               <bday>1926-06-01</bday>
            </demographics>
            <institutionRole xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <institutionRoleType>Student</institutionRoleType>
               <primaryRoleType>true</primaryRoleType>
            </institutionRole>
            <tel xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <telType>Voice</telType>
               <telValue>55567645</telValue>
            </tel>
            <tel xmlns="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
               <telType>Mobile</telType>
               <telValue>7412689</telValue>
            </tel>
         </person>
      </readPersonResponse>
   </s:Body>
</s:Envelope>