Overview

Skill Level: Intermediate

Step-by-step

  1. Syntax of the request and response XML for GetScoringModels

    Standard permissions are applied to this API so that only those Scoring Models are returned that the authenticated user has access to see. Only Score Components that are defined for the Model returned are included in the response.

    The Rank section of a Scoring Model was not defined (as is a possible scenario), then it would
    not be listed as one of the Score Components that define that returned Scoring Model.

    Operation <GetScoringModels>
    Example

     

    <Envelope>
  <Body>
    <GetScoringModels>
    </GetScoringModels>
  </Body>
</Envelope>
    Response <RESULT>
    Elements SUCCESS TRUE if successful.
      MODELS XML Node defining Scoring Models
      ChildElement MODEL XML Node defining each Scoring Model
        ChildElements ID ID of the Scoring Model
          NAME Name of the Scoring Model
          DESCRIPTION Description of the Scoring Model as described by the user in the UI
          CREATED Created Date of the Scoring Model
          LAST_MODIFIED Last Modified Date of the Scoring Model
          SCORE_COMPONENT_TYPE

    The components (or sections) that define the Scoring Model.
          ChildElements SCORE_COMPONENT_TYPE XML Node defining each defined component in the model
            ChildElements KEY The name of the component
              DESCRIPTION The definition of the score component. (Acoustic Campaign‘s definition, not something the user specifies).
              VALUES XML Node defining the possible values that the specified component might return.
              ChildElements VALUE A defined value that can be returned from the score component.
    Example

     

    <Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <MODELS>
        <MODEL>
          <ID>5435</ID>
          <NAME>LeadStatusScoringModel</NAME>
          <DESCRIPTION>This model is used to qualify leads 
              into SFDC promotions</DESCRIPTION>
          <CREATED>10/12/11 10:15 PM</CREATED>
          <LAST_MODIFIED>10/23/11 04:18 PM</LAST_MODIFIED>
          <SCORE_COMPONENT_TYPES>
            <SCORE_COMPONENT_TYPE>
              <KEY>totalScore</KEY>
              <DESCRIPTION>
              This is the overall score for the contact</DESCRIPTION>
            </SCORE_COMPONENT_TYPE>
            <SCORE_COMPONENT_TYPE>
              <KEY>behaviorScore</KEY>
              <DESCRIPTION>
              This is the behavior score for the contact</DESCRIPTION>
            </SCORE_COMPONENT_TYPE>
            <SCORE_COMPONENT_TYPE>
              <KEY>totalRank</KEY>
              <DESCRIPTION>
              This is the rank for the contact based on total score</DESCRIPTION>
              <VALUES>
                <VALUE>Hot</VALUE>
                <VALUE>Warm</VALUE>
                <VALUE>Cold</VALUE>
              </VALUES>
            </SCORE_COMPONENT_TYPE>
          </SCORE_COMPONENT_TYPES>
        </MODEL>
        <MODEL>
          <ID>5435</ID>
          <NAME>CustomerValueScoringModel</NAME>
          <DESCRIPTION>This model is used to qualify leads 
              into SFDC promotions</DESCRIPTION>
          <CREATED>10/12/11 10:15 PM</CREATED>
          <LAST_MODIFIED>
          10/23/11 04:18 PM</LAST_MODIFIED
          <SCORE_COMPONENT_TYPES>
            <SCORE_COMPONENT_TYPE>
              <KEY>totalScore</KEY>
              <DESCRIPTION>
              This is the overall score for the contact</DESCRIPTION>
            </SCORE_COMPONENT_TYPE>
            <SCORE_COMPONENT_TYPE>
              <KEY>behaviorScore</KEY>
              <DESCRIPTION>
              This is the behavior score for the contact</DESCRIPTION>
            </SCORE_COMPONENT_TYPE>
            <SCORE_COMPONENT_TYPE>
              <KEY>totalRank</KEY>
              <DESCRIPTION>
              This is the rank for the contact based on total score</DESCRIPTION>
              <VALUES>
                <VALUE>High</VALUE>
                <VALUE>Average</VALUE>
                <VALUE>Low</VALUE>
              </VALUES>
            </SCORE_COMPONENT_TYPE>
          </SCORE_COMPONENT_TYPES>
        </MODEL>
      </MODELS>
    </RESULT>
  </Body>
</Envelope>
    ErrorCodes 145 User session is invalid or expired.
      6001 Scoring Models are not available for this ORG.
      6002 Scoring Model database is not set for this ORG.
      6003 Scoring Models are not available for this user.
      6004 No Scoring Models defined for this ORG.
    Error Message Response Example

     

    <Envelope>
  <Body>
    <RESULT>
      <SUCCESS>false</SUCCESS>
    </RESULT>
    <Fault>
      <Request/>
      <FaultCode/>
      <FaultString>User session is invalid or expired.
          </FaultString>
      <detail>
        <error>
          <errorid>145</errorid>
          <module/>
          <class>SP.API</class>
          <method/>
        </error>
      </detail>
    </Fault>
  </Body>
</Envelope>

Join The Discussion

Your email address will not be published. Required fields are marked *