POST associations({associationId})/ereferral

This method takes in lots of data and sends out a eReferral

Request Information

Parameters

NameDescriptionAdditional information
associationId
Association identifier

Define this parameter in the request URI.

postData
Information for sending a eReferral

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "PotentialCustomerName": "sample string 1",
  "PotentialCustomerContactPreference": "sample string 2",
  "PotentialCustomerContactPreferenceId": 1,
  "PotentialCustomerCompanyName": "sample string 3",
  "PotentialCustomerAddressLine1": "sample string 4",
  "PotentialCustomerAddressLine2": "sample string 5",
  "PotentialCustomerPhone": "sample string 6",
  "PotentialCustomerFax": "sample string 7",
  "PotentialCustomerCity": "sample string 8",
  "PotentialCustomerState": "sample string 9",
  "PotentialCustomerZip": "sample string 10",
  "PotentialCustomerEMail": "sample string 11",
  "PotentialCustomerCountry": "sample string 12",
  "ERefferalFrom": "sample string 13",
  "IncludeCCToSender": true,
  "ERefferalSubjectLine": "sample string 14",
  "ERefferalMessage": "sample string 15",
  "Recipients": [
    {
      "RepresentativeId": 1,
      "MemberId": 1,
      "EmailAddress": "sample string 1",
      "GroupId": 1
    },
    {
      "RepresentativeId": 1,
      "MemberId": 1,
      "EmailAddress": "sample string 1",
      "GroupId": 1
    },
    {
      "RepresentativeId": 1,
      "MemberId": 1,
      "EmailAddress": "sample string 1",
      "GroupId": 1
    }
  ],
  "RecipientEMailList": "sample string 16",
  "CCRepId": 1,
  "AssociationId": 1
}

application/xml, text/xml

Sample:
<EReferralPP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MicroNet.Common.API.Transfer.Associations">
  <AssociationId>1</AssociationId>
  <CCRepId>1</CCRepId>
  <ERefferalFrom>sample string 13</ERefferalFrom>
  <ERefferalMessage>sample string 15</ERefferalMessage>
  <ERefferalSubjectLine>sample string 14</ERefferalSubjectLine>
  <IncludeCCToSender>true</IncludeCCToSender>
  <PotentialCustomerAddressLine1>sample string 4</PotentialCustomerAddressLine1>
  <PotentialCustomerAddressLine2>sample string 5</PotentialCustomerAddressLine2>
  <PotentialCustomerCity>sample string 8</PotentialCustomerCity>
  <PotentialCustomerCompanyName>sample string 3</PotentialCustomerCompanyName>
  <PotentialCustomerContactPreference>sample string 2</PotentialCustomerContactPreference>
  <PotentialCustomerContactPreferenceId>1</PotentialCustomerContactPreferenceId>
  <PotentialCustomerCountry>sample string 12</PotentialCustomerCountry>
  <PotentialCustomerEMail>sample string 11</PotentialCustomerEMail>
  <PotentialCustomerFax>sample string 7</PotentialCustomerFax>
  <PotentialCustomerName>sample string 1</PotentialCustomerName>
  <PotentialCustomerPhone>sample string 6</PotentialCustomerPhone>
  <PotentialCustomerState>sample string 9</PotentialCustomerState>
  <PotentialCustomerZip>sample string 10</PotentialCustomerZip>
  <RecipientEMailList>sample string 16</RecipientEMailList>
  <Recipients>
    <RecipientPP>
      <EmailAddress>sample string 1</EmailAddress>
      <GroupId>1</GroupId>
      <MemberId>1</MemberId>
      <RepresentativeId>1</RepresentativeId>
    </RecipientPP>
    <RecipientPP>
      <EmailAddress>sample string 1</EmailAddress>
      <GroupId>1</GroupId>
      <MemberId>1</MemberId>
      <RepresentativeId>1</RepresentativeId>
    </RecipientPP>
    <RecipientPP>
      <EmailAddress>sample string 1</EmailAddress>
      <GroupId>1</GroupId>
      <MemberId>1</MemberId>
      <RepresentativeId>1</RepresentativeId>
    </RecipientPP>
  </Recipients>
</EReferralPP>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Results of insert

Response body formats

application/json, text/json

Sample:
{
  "InsertSuccess": true
}

application/xml, text/xml

Sample:
<EReferralTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MicroNet.Common.API.Transfer.Associations">
  <InsertSuccess>true</InsertSuccess>
</EReferralTO>