API reference
Help CenterCommunityDevelopersAcademyStatus

Get an organization's scoring models - GetScoringModels

Returns scoring models for a specific organization.

📘

Notes

Scoring models return based on the authenticated user's access.

Only defined score components for the model returned are included in the response. If the rank section of a scoring model was not defined, then it would not be listed as one of the defined score components for the returned scoring model.

Element (Required)

You do not need to define any of the elements for this call: Envelope, Body, GetScoringModels. See "Example call - XML" for exact input.

<Envelope>
  <Body>
    <GetScoringModels>
    </GetScoringModels>
  </Body>
</Envelope>

<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>

<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>

Elements (Result)

SUCCESS - True if successful; False if not.

MODELS - XML node defining scoring models containing MODEL and its children.

MODEL - XML node defining each scoring model. Contains ID, NAME, DESCRIPTION, CREATED, LAST_MODIFIED, and SCORE_COMPONENT_TYPES as children.
ID - The ID of the scoring model
NAME - The name of the scoring model
DESCRIPTION - The user description of the scoring model from the UI
CREATED - The created date of the scoring model
LAST_MODIFIED - The last modified date of the scoring model

SCORE_COMPONENT_TYPES - The components (or sections) that define the scoring model containing SCORE_COMPONENT_TYPE and its children.

SCORE_COMPONENT_TYPE - XML node defining each component in the model. Contains KEY, DESCRIPTION, and VALUES as children.
KEY - The name of the component.
DESCRIPTION - Acoustic Campaign's definition of the score component.
VALUES - XML node defining the possible values that the specified component might return. Contains VALUE as a child.
VALUE - A defined value that can be returned from the score component.

Error Codes

Error CodeDescription
145User session is invalid or expired.
6001Scoring models are not available for this org.
6002Scoring model database is not set for this org.
6003Scoring models are not available for this user.
6004No scoring models defined for this org.