createPerson

Cirrus Assessment Support Team -

Method description

createPerson is the method used to create a new person in Cirrus. Please note: user is also restored from Trash Can via createPerson. You can use extension 'Deleted' to see if user is in Trash Can via ReadPerson.

Request parameters

Name

Data type

Description

sourcedId

GUID

The unique identifier of new person

personRecord

Object

The person data. See mapping here

Please refer to the WSDL for the full element structure, only key elements are described here

Response parameters

Empty.

Example

Request message

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
   <soapenv:Header>
      <ims:imsx_syncRequestHeaderInfo>
         <ims:imsx_version>V1.0</ims:imsx_version>
         <ims:imsx_messageIdentifier>1234567890</ims:imsx_messageIdentifier>
      </ims:imsx_syncRequestHeaderInfo>
   </soapenv:Header>
   <soapenv:Body>
      <ims:createPersonRequest>
         <ims:sourcedId>fd842a1dbe9f47a6a258f14adcbc83b7</ims:sourcedId>
         <ims:personRecord>
            <ims:sourcedGUID>
               <ims:refAgentInstanceID>YourSystemName</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:instanceValue>
                        <ims:textString>EmailPrimary</ims:textString>
                     </ims:instanceValue>
                  </ims:contactinfoType>
                  <ims:contactinfoValue>
                     <ims:textString>richardthelionheart@cirrus.com</ims:textString>
                  </ims:contactinfoValue>
               </ims:contactinfo>
               <ims:contactinfo>
                  <ims:contactinfoType>
                     <ims:instanceValue>
                        <ims:textString>Mobile</ims:textString>
                     </ims:instanceValue>
                  </ims:contactinfoType>
                  <ims:contactinfoValue>
                     <ims:textString>012345678</ims:textString>
                  </ims:contactinfoValue>
               </ims:contactinfo>
                <ims:contactinfo>
                  <ims:contactinfoType>
                     <ims:instanceValue>
                        <ims:textString>TelephonePrimary</ims:textString>
                     </ims:instanceValue>
                  </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>0123456789</ims:fieldValue>
                  </ims:extensionField>
<!--Disable Cirrus Login-->
<ims:extensionField>
<ims:fieldName>DisableLogin</ims:fieldName>
<ims:fieldType>Boolean</ims:fieldType>
<ims:fieldValue>true</ims:fieldValue>
</ims:extensionField>
<!--Disable Password Reset-->
<ims:extensionField>
<ims:fieldName>DisablePasswordReset</ims:fieldName>
<ims:fieldType>Boolean</ims:fieldType>
<ims:fieldValue>false</ims:fieldValue>
</ims:extensionField> </ims:extension> </ims:person> </ims:personRecord> </ims:createPersonRequest> </soapenv:Body> </soapenv:Envelope>

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: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-17T08:39:58.212Z</u:Created>
            <u:Expires>2015-07-17T08:44:58.212Z</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"/>
</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