POST api/referrals/status

Updates the status of a referral.

Request Information

URI Parameters

Query String:

None.

Body Parameters

A structure containing the referral information and new status.

Type: ReferralStatus

NameDescriptionTypeAdditional information
referralId

ID of the referral.

string

None.

programId

ID of the program that the referral belongs to. Optional.

string

None.

status

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

string

None.

amount

Amount Not required.

decimal number

None.

publicNote

Public Note

string

None.

Request Formats

application/json, text/json

Sample:
{
  "referralId": "sample string 1",
  "programId": "sample string 2",
  "status": "sample string 3",
  "amount": 1.0,
  "publicNote": "sample string 4"
}

application/xml, text/xml

Sample:
<referralStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <amount>1</amount>
  <programId>sample string 2</programId>
  <publicNote>sample string 4</publicNote>
  <referralId>sample string 1</referralId>
  <status>sample string 3</status>
</referralStatus>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: ReferralConfirmation

NameDescriptionTypeAdditional information
referral

Structure containing details about the referral.

Referral

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "referral": {
    "id": "bc96c05b-99ff-4628-9911-0a6bfc29a778",
    "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-23T07:56:09.5757924Z",
    "programId": "38c988ff-b5a7-4231-933c-70e8eea1323a",
    "programName": "sample string 11",
    "programTitle": "sample string 12",
    "referringMemberId": "c1aee947-1921-4033-b91d-0c18790ced45",
    "referringMemberName": "sample string 14",
    "approvedDate": "2018-01-23T07:56:09.5757924Z",
    "qualifiedDate": "2018-01-23T07:56:09.5757924Z",
    "status": "sample string 15",
    "companyName": "sample string 16"
  }
}

application/xml, text/xml

Sample:
<referralConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <referral>
    <id>bc96c05b-99ff-4628-9911-0a6bfc29a778</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-23T02:56:09.5757924-05:00</createDate>
    <programId>38c988ff-b5a7-4231-933c-70e8eea1323a</programId>
    <programName>sample string 11</programName>
    <programTitle>sample string 12</programTitle>
    <referringMemberId>c1aee947-1921-4033-b91d-0c18790ced45</referringMemberId>
    <referringMemberName>sample string 14</referringMemberName>
    <approvedDate>2018-01-23T02:56:09.5757924-05:00</approvedDate>
    <qualifiedDate>2018-01-23T02:56:09.5757924-05:00</qualifiedDate>
    <status>sample string 15</status>
    <companyName>sample string 16</companyName>
  </referral>
</referralConfirmation>