POST api/Referrals

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PreLeadID	globally unique identifier	None.
MemberInvitation	boolean	None.
Code	string	None.
FromTime	time interval	None.
ToTime	time interval	None.
ReferredBy	string	None.
Phone	string	None.
Relationship	string	None.
Notes	string	None.
ContactAwareness	boolean	None.
Email	string	Required
TerminalID	integer	Required
SourceChannelID	integer	Required
Referrer	string	None.
LeadSourceID	integer	None.
IPv4	string	None.
TrackingID	globally unique identifier	None.
FirstName	string	None.
LastName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PreLeadID": "d0bcf0f6-21af-4563-b0db-57408d2a5e72",
  "MemberInvitation": true,
  "Code": "sample string 3",
  "FromTime": "00:00:00.1234567",
  "ToTime": "00:00:00.1234567",
  "ReferredBy": "sample string 4",
  "Phone": "sample string 5",
  "Relationship": "sample string 6",
  "Notes": "sample string 7",
  "ContactAwareness": true,
  "Email": "sample string 9",
  "TerminalID": 10,
  "SourceChannelID": 11,
  "Referrer": "sample string 12",
  "LeadSourceID": 13,
  "IPv4": "sample string 14",
  "TrackingID": "49665af3-08e8-48ff-923f-b98908e66d86",
  "FirstName": "sample string 15",
  "LastName": "sample string 16"
}

application/xml, text/xml

Sample:

<ApiReferralsViewModel.NewReferralContactInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <FirstName>sample string 15</FirstName>
  <LastName>sample string 16</LastName>
  <Email>sample string 9</Email>
  <IPv4>sample string 14</IPv4>
  <LeadSourceID>13</LeadSourceID>
  <Referrer>sample string 12</Referrer>
  <SourceChannelID>11</SourceChannelID>
  <TerminalID>10</TerminalID>
  <TrackingID>49665af3-08e8-48ff-923f-b98908e66d86</TrackingID>
  <ContactAwareness>true</ContactAwareness>
  <Notes>sample string 7</Notes>
  <Phone>sample string 5</Phone>
  <Relationship>sample string 6</Relationship>
  <Code>sample string 3</Code>
  <FromTime>PT0.1234567S</FromTime>
  <MemberInvitation>true</MemberInvitation>
  <PreLeadID>d0bcf0f6-21af-4563-b0db-57408d2a5e72</PreLeadID>
  <ReferredBy>sample string 4</ReferredBy>
  <ToTime>PT0.1234567S</ToTime>
</ApiReferralsViewModel.NewReferralContactInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AttemptResponse

Name	Type	Additional information
Type	Attempt_ResponseTypes	None.
Exception	Exception	None.
ObjectID	Object	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Type": 0,
  "Exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  },
  "ObjectID": {},
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<AttemptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.Utils">
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <ObjectID />
  <Type>Warning</Type>
</AttemptResponse>