GET api/salesreceiver/config

Gets a list of options used to map the right settings

Request Information

URI Parameters

Query String: id={id}&buildversion={buildversion}

NameDescriptionTypeAdditional information
id

Key for CRM Settings. Required.

string

None.

buildversion

Specify the build version. Optional.

string

None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] Sales Config Options

Type: SalesConfig

NameDescriptionTypeAdditional information
id

The unique ID of the salesconfig.

globally unique identifier

None.

memberMap

Salesconfig fields that map to finding the member

MemberMap

None.

referralStatusMap

Salesconfig fields that map to setting a referal status

ReferralStatusMap

None.

referralFields

Salesconfig fields that map to setting a referal fields

ReferralFields

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "67621025-6be7-49cf-b4fa-7d9b828ff615",
  "memberMap": {
    "memberCodeObject": "sample string 1",
    "memberCodeField": "sample string 2",
    "memberIDObject": "sample string 3",
    "memberIDField": "sample string 4",
    "memberExternalIDObject": "sample string 5",
    "memberExternalIDField": "sample string 6",
    "memberEmailObject": "sample string 7",
    "memberEmailField": "sample string 8"
  },
  "referralStatusMap": {
    "qualifiedStatusObject": "sample string 1",
    "qualifiedStatusField": "sample string 2",
    "qualifiedStatusValueMatch": "sample string 3",
    "approvedStatusObject": "sample string 4",
    "approvedStatusField": "sample string 5",
    "approvedStatusValueMatch": "sample string 6",
    "deniedStatusObject": "sample string 7",
    "deniedStatusField": "sample string 8",
    "deniedStatusValueMatch": "sample string 9",
    "deniedStatusExtraObject": "sample string 10",
    "deniedStatusExtraField": "sample string 11",
    "deniedStatusExtraValueMatch": "sample string 12"
  },
  "referralFields": {
    "referralIDObject": "sample string 1",
    "referralIDField": "sample string 2",
    "referralExternalIDObject": "sample string 3",
    "referralExternalIDField": "sample string 4",
    "publicNoteObject": "sample string 5",
    "publicNoteField": "sample string 6",
    "privateNoteObject": "sample string 7",
    "privateNoteField": "sample string 8",
    "businessNameObject": "sample string 9",
    "businessNameField": "sample string 10",
    "amountObject": "sample string 11",
    "amountField": "sample string 12",
    "customFields": [
      {
        "objectType": "sample string 1",
        "field": "sample string 2",
        "name": "sample string 3"
      },
      {
        "objectType": "sample string 1",
        "field": "sample string 2",
        "name": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<salesConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>67621025-6be7-49cf-b4fa-7d9b828ff615</id>
  <memberMap>
    <memberCodeObject>sample string 1</memberCodeObject>
    <memberCodeField>sample string 2</memberCodeField>
    <memberIDObject>sample string 3</memberIDObject>
    <memberIDField>sample string 4</memberIDField>
    <memberExternalIDObject>sample string 5</memberExternalIDObject>
    <memberExternalIDField>sample string 6</memberExternalIDField>
    <memberEmailObject>sample string 7</memberEmailObject>
    <memberEmailField>sample string 8</memberEmailField>
  </memberMap>
  <referralStatusMap>
    <qualifiedStatusObject>sample string 1</qualifiedStatusObject>
    <qualifiedStatusField>sample string 2</qualifiedStatusField>
    <qualifiedStatusValueMatch>sample string 3</qualifiedStatusValueMatch>
    <approvedStatusObject>sample string 4</approvedStatusObject>
    <approvedStatusField>sample string 5</approvedStatusField>
    <approvedStatusValueMatch>sample string 6</approvedStatusValueMatch>
    <deniedStatusObject>sample string 7</deniedStatusObject>
    <deniedStatusField>sample string 8</deniedStatusField>
    <deniedStatusValueMatch>sample string 9</deniedStatusValueMatch>
    <deniedStatusExtraObject>sample string 10</deniedStatusExtraObject>
    <deniedStatusExtraField>sample string 11</deniedStatusExtraField>
    <deniedStatusExtraValueMatch>sample string 12</deniedStatusExtraValueMatch>
  </referralStatusMap>
  <referralFields>
    <referralIDObject>sample string 1</referralIDObject>
    <referralIDField>sample string 2</referralIDField>
    <referralExternalIDObject>sample string 3</referralExternalIDObject>
    <referralExternalIDField>sample string 4</referralExternalIDField>
    <publicNoteObject>sample string 5</publicNoteObject>
    <publicNoteField>sample string 6</publicNoteField>
    <privateNoteObject>sample string 7</privateNoteObject>
    <privateNoteField>sample string 8</privateNoteField>
    <businessNameObject>sample string 9</businessNameObject>
    <businessNameField>sample string 10</businessNameField>
    <amountObject>sample string 11</amountObject>
    <amountField>sample string 12</amountField>
    <customFields>
      <customField>
        <objectType>sample string 1</objectType>
        <field>sample string 2</field>
        <name>sample string 3</name>
      </customField>
      <customField>
        <objectType>sample string 1</objectType>
        <field>sample string 2</field>
        <name>sample string 3</name>
      </customField>
    </customFields>
  </referralFields>
</salesConfig>