POST api/Referrals

Permite añadir referidos al cliente, solo es posible enviar un referido a la vez

Request Information

URI Parameters

None.

Body Parameters

NewReferralContactInfo
NameDescriptionTypeAdditional information
PreLeadID

globally unique identifier

None.

MemberInvitation

boolean

None.

Code

string

None.

FromTime

time interval

None.

ToTime

time interval

None.

ReferredBy

string

None.

LeadTypeID

integer

None.

Phone

string

None.

Relationship

string

None.

Notes

string

None.

ContactAwareness

boolean

None.

IsAnonymous

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": "11afcd33-53d3-4fc3-8dad-785daa9f2a89",
  "MemberInvitation": true,
  "Code": "sample string 3",
  "FromTime": "00:00:00.1234567",
  "ToTime": "00:00:00.1234567",
  "ReferredBy": "sample string 4",
  "LeadTypeID": 1,
  "Phone": "sample string 5",
  "Relationship": "sample string 6",
  "Notes": "sample string 7",
  "ContactAwareness": true,
  "IsAnonymous": true,
  "Email": "sample string 10",
  "TerminalID": 11,
  "SourceChannelID": 12,
  "Referrer": "sample string 13",
  "LeadSourceID": 14,
  "IPv4": "sample string 15",
  "TrackingID": "ed225fae-c933-422f-9770-d311811e83d9",
  "FirstName": "sample string 16",
  "LastName": "sample string 17"
}

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 16</FirstName>
  <LastName>sample string 17</LastName>
  <Email>sample string 10</Email>
  <IPv4>sample string 15</IPv4>
  <LeadSourceID>14</LeadSourceID>
  <Referrer>sample string 13</Referrer>
  <SourceChannelID>12</SourceChannelID>
  <TerminalID>11</TerminalID>
  <TrackingID>ed225fae-c933-422f-9770-d311811e83d9</TrackingID>
  <ContactAwareness>true</ContactAwareness>
  <IsAnonymous>true</IsAnonymous>
  <Notes>sample string 7</Notes>
  <Phone>sample string 5</Phone>
  <Relationship>sample string 6</Relationship>
  <Code>sample string 3</Code>
  <FromTime>PT0.1234567S</FromTime>
  <LeadTypeID>1</LeadTypeID>
  <MemberInvitation>true</MemberInvitation>
  <PreLeadID>11afcd33-53d3-4fc3-8dad-785daa9f2a89</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
NameDescriptionTypeAdditional information
Type

Guarda el valor del tipo de resultado de la ejecución de las instrucciones de código en la función ejecutada.

Attempt_ResponseTypes

None.

Exception

Presenta los errores que se producen cuando la ejecución de las instrucciones de código no terminan correctamente.

Exception

None.

ObjectID

Objeto que permite establecer cualquier tipo de valor como respuesta, sin la necesidad de que la información almacenada tenga que seguir una estructura.

Object

None.

Message

Mensage personalizado para emitir una respuesta después de la correcta ejecución de las instrucciones de código.

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>