POST api/Leads/PushExternalLeadNMI

Request Information

URI Parameters

None.

Body Parameters

CreateNMILeadRequest
NameDescriptionTypeAdditional information
DealerID

integer

None.

nmiLead

NMILead

None.

Request Formats

application/json, text/json

Sample:
{
  "DealerID": 1,
  "nmiLead": {
    "leadType": 1,
    "dealershipID": 2,
    "source": "sample string 3",
    "message": "sample string 4",
    "customer": {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "email": "sample string 3",
      "contactNumber": "sample string 4"
    },
    "vehicle": {
      "vehicleID": 1,
      "vehicleMake": "sample string 2",
      "vehicleModel": "sample string 3",
      "vehicleYear": "sample string 4",
      "stockBookNumber": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:
<CreateNMILeadRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DealerID>1</DealerID>
  <nmiLead>
    <leadTypeEnum>1</leadTypeEnum>
    <dealershipID>2</dealershipID>
    <source>sample string 3</source>
    <message>sample string 4</message>
    <customer>
      <firstName>sample string 1</firstName>
      <lastName>sample string 2</lastName>
      <email>sample string 3</email>
      <contactNumber>sample string 4</contactNumber>
    </customer>
    <vehicle>
      <vehicleID>1</vehicleID>
      <vehicleMake>sample string 2</vehicleMake>
      <vehicleModel>sample string 3</vehicleModel>
      <vehicleYear>sample string 4</vehicleYear>
      <stockBookNumber>sample string 5</stockBookNumber>
    </vehicle>
  </nmiLead>
</CreateNMILeadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateNMILeadResponse
NameDescriptionTypeAdditional information
APICallSuccess

boolean

None.

success

boolean

None.

message

string

None.

data

string

None.

SuccessMessage

string

None.

FriendlyErrorMessage

string

None.

id_swpApi_Log

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "APICallSuccess": true,
  "success": true,
  "message": "sample string 3",
  "data": "sample string 4",
  "SuccessMessage": "sample string 5",
  "FriendlyErrorMessage": "sample string 6",
  "id_swpApi_Log": 7
}

application/xml, text/xml

Sample:
<CreateNMILeadResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APICallSuccess>true</APICallSuccess>
  <success>true</success>
  <message>sample string 3</message>
  <data>sample string 4</data>
  <SuccessMessage>sample string 5</SuccessMessage>
  <FriendlyErrorMessage>sample string 6</FriendlyErrorMessage>
  <id_swpApi_Log>7</id_swpApi_Log>
</CreateNMILeadResponse>