Case_Retrieve

Retrieves details for a Case including details, threads and files. Use EntityID to retrieve owner Contact/Company information for case.

Request

  • Method: SOAP
  • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
  • Path: /catalystwebservice/catalystcrmwebservice.asmx
  • The username and password fields:You can make SOAP API calls can be authorized either by using the actual username or password of an Admin username or, if you are making the calls from an app leave the username field empty and use the authorization token as the password.

Parameters

  • siteId - ID of the site (integer)
  • username - email address of user account, leave empty if using site token (string)
  • password - password of user account, or site authentication token for specified site (string)
  • caseId - (integer)

To use a site token instead of username/password, send an empty username field and the site token as the password. See example below.

Response

A Case_RetrieveResponse object with the following properties:

  • Case_RetrieveResult - (object)
    • entityId - (integer)
    • caseId - (integer)
    • assignedTo - (integer)
    • caseSubject - (string)
    • createDate - (dateTime) - e.g. 2014-09-9T10:24:00
    • lastUpdateDate - (dateTime) - e.g. 2014-09-9T10:24:00
    • messageThreads- (object)
      • message - (string)
      • createDate - (dateTime) - e.g. 2014-09-9T10:24:00
      • objectId - (integer)
      • objectType - (integer)
      • isInternal - (boolean)
      • entityId - (integer)
    • crmForms - (object)
      • formId - (integer)
      • formName - (string)
      • crmFormFields
    • fileList - (object)
      • Files - (object)
        • fileId - (integer)
        • fileName - (string)
        • fileSize - (long)

Examples

Accepts and returns XML as Content-Type.

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values, please note the data in the request and response is only for explanatory purposes.

Request:

POST /catalystwebservice/catalystcrmwebservice.asmx HTTP/1.1
Host: worldsecuresystems.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Case_Retrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <username>jdoe@yourdomain.com</username>
      <password>Y0urP@ssw0rdH3re</password>
      <siteId>12345</siteId>
      <caseId>1234</caseId>
    </Case_Retrieve>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Case_RetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <Case_RetrieveResult>
        <entityId>1234</entityId>
        <caseId>1234</caseId>
        <assignedTo>1234</assignedTo>
        <caseSubject>Case subject</caseSubject>
        <createDate>2010-08-08T12:22:00</createDate>
        <lastUpdateDate>2012-08-08T12:22:00</lastUpdateDate>
            <messageThreads>
        <MessageThreads>
           <message>Case queued for assignment.</message>
           <createDate>2011-10-25T10:57:00</createDate>
           <objectId>138039</objectId>
           <objectType>14</objectType>
           <isInternal>true</isInternal>
           <entityId>0</entityId>
        </MessageThreads>
        <MessageThreads>
           <message>test reply&lt;br></message>
           <createDate>2011-10-25T10:57:00</createDate>
           <objectId>138039</objectId>
           <objectType>14</objectType>
           <isInternal>false</isInternal>
           <entityId>0</entityId>
        </MessageThreads>
            <crmForms>
        <CrmForms>
           <formId>86343</formId>
           <formName>attached to case</formName>
           <crmFormFields>
              <CrmFormFields>
                 <fieldId>244672</fieldId>
                 <fieldTypeId>1</fieldTypeId>
                 <fieldName>attached to case</fieldName>
                 <fieldValue/>
              </CrmFormFields>
           </crmFormFields>
        </CrmForms>
        <CrmForms>
           <formId>224</formId>
           <formName>Contact Us Form</formName>
           <crmFormFields>
              <CrmFormFields>
                 <fieldId>244672</fieldId>
                 <fieldTypeId>1</fieldTypeId>
                 <fieldName>attached to case</fieldName>
                 <fieldValue/>
              </CrmFormFields>
              <CrmFormFields>
                 <fieldId>868</fieldId>
                 <fieldTypeId>7</fieldTypeId>
                 <fieldName>Preferred Contact Method</fieldName>
                 <fieldValue>Never contact</fieldValue>
              </CrmFormFields>
              <CrmFormFields>
                 <fieldId>869</fieldId>
                 <fieldTypeId>9</fieldTypeId>
                 <fieldName>Your message:</fieldName>
                 <fieldValue>Your message:</fieldValue>
              </CrmFormFields>
           </crmFormFields>
        </CrmForms>
            </crmForms>
        <fileList>
          <Files>
           <fileId>147191</fileId>
           <fileName>file_name_here.txt</fileName>
           <fileSize>636</fileSize>
          </Files>
          <Files>
           <fileId>147192</fileId>
           <fileName>file2_name_here.txt</fileName>
           <fileSize>637</fileSize>
          </Files>
        </fileList>
      </Case_RetrieveResult>
    </Case_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>