POST api/referral/remove

Deletes referrals in a referral program. For each referral, a query object is specified to identiy the referral to delete. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A referral will only be deleted if it can be uniquely identifier by the query.

Request Information

URI Parameters

Query String:

None.

Body Parameters

Type: Collection of RemoveReferralInfo

NameDescriptionTypeAdditional information
query

A structure containing details to identify a referral to update.

ReferralQuery

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "query": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    }
  },
  {
    "query": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfremoveReferral xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <removeReferral>
    <query>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </query>
  </removeReferral>
  <removeReferral>
    <query>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </query>
  </removeReferral>
</ArrayOfremoveReferral>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: Collection of RemoveReferralResult

NameDescriptionTypeAdditional information
query

Echos the query sent in the request.

ReferralQuery

None.

resultInfo

Details about the results of the request.

ResultInfo

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "query": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  },
  {
    "query": {
      "primaryInfo": {
        "referralId": "sample string 1"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2",
        "phoneNumber": "sample string 3"
      },
      "tertiaryInfo": {
        "ProgramId": "sample string 1",
        "ProgramName": "sample string 2",
        "ProgramTitle": "sample string 3"
      },
      "fuzzyInfo": {
        "Identifier": "sample string 1"
      }
    },
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfremoveReferralResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <removeReferralResult>
    <query>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </query>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
  </removeReferralResult>
  <removeReferralResult>
    <query>
      <fuzzyInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:Identifier>sample string 1</d4p1:Identifier>
      </fuzzyInfo>
      <primaryInfo>
        <referralId>sample string 1</referralId>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
        <phoneNumber>sample string 3</phoneNumber>
      </secondaryInfo>
      <tertiaryInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models">
        <d4p1:ProgramId>sample string 1</d4p1:ProgramId>
        <d4p1:ProgramName>sample string 2</d4p1:ProgramName>
        <d4p1:ProgramTitle>sample string 3</d4p1:ProgramTitle>
      </tertiaryInfo>
    </query>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
  </removeReferralResult>
</ArrayOfremoveReferralResult>