GET api/referral/getsingle

Get a single Referral

Request Information

URI Parameters

Query String: referralQuery={referralQuery}

NameDescriptionTypeAdditional information
referralQuery

Referral Query. Check by ReferralID, email address or External Id

string

Default value is

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A single Referral.

Type: Referral

NameDescriptionTypeAdditional information
id

The unique ID of the referral.

globally unique identifier

None.

firstName

string

None.

lastName

string

None.

email

string

None.

externalIdentifier

An alternative ID provided to help link the member to relevant data in external systems.

string

None.

phoneNumber

string

None.

amount

decimal number

None.

preferredContact

The preferred means to contact the referral. The values an be 'email', 'callMorning', 'callAfternoon', or 'callEvening'.

string

None.

createDate

date

None.

programId

The unique ID of the referral program that the referral responded to.

globally unique identifier

None.

programName

string

None.

programTitle

string

None.

referringMemberId

The unique ID of the member that made the referral.

globally unique identifier

None.

referringMemberName

The name of the member that made the referral.

string

None.

approvedDate

date

None.

qualifiedDate

date

None.

status

The value can be "pending", "qualified", "approved", "denied".

string

None.

companyName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "8fe7f778-9e6f-4516-bc29-ac8dd49bdea7",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "email": "sample string 4",
  "externalIdentifier": "sample string 5",
  "phoneNumber": "sample string 6",
  "amount": 7.0,
  "preferredContact": "sample string 8",
  "createDate": "2018-01-23T08:14:02.7657Z",
  "programId": "236be828-9c01-4643-b99f-86e228eb842a",
  "programName": "sample string 11",
  "programTitle": "sample string 12",
  "referringMemberId": "5f87ff62-9704-46a8-908c-c62acce26e47",
  "referringMemberName": "sample string 14",
  "approvedDate": "2018-01-23T08:14:02.7657Z",
  "qualifiedDate": "2018-01-23T08:14:02.7657Z",
  "status": "sample string 15",
  "companyName": "sample string 16"
}

application/xml, text/xml

Sample:
<referral xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>8fe7f778-9e6f-4516-bc29-ac8dd49bdea7</id>
  <firstName>sample string 2</firstName>
  <lastName>sample string 3</lastName>
  <email>sample string 4</email>
  <externalIdentifier>sample string 5</externalIdentifier>
  <phoneNumber>sample string 6</phoneNumber>
  <amount>7</amount>
  <preferredContact>sample string 8</preferredContact>
  <createDate>2018-01-23T03:14:02.7657-05:00</createDate>
  <programId>236be828-9c01-4643-b99f-86e228eb842a</programId>
  <programName>sample string 11</programName>
  <programTitle>sample string 12</programTitle>
  <referringMemberId>5f87ff62-9704-46a8-908c-c62acce26e47</referringMemberId>
  <referringMemberName>sample string 14</referringMemberName>
  <approvedDate>2018-01-23T03:14:02.7657-05:00</approvedDate>
  <qualifiedDate>2018-01-23T03:14:02.7657-05:00</qualifiedDate>
  <status>sample string 15</status>
  <companyName>sample string 16</companyName>
</referral>