POST v1/referralTransaction/createprospect

Request Information

URI Parameters

None.

Body Parameters

createprospectRequest
NameDescriptionTypeAdditional information
title

string

None.

surname

string

None.

othername

string

None.

emailAddress

string

None.

mobileNo

string

None.

user_id

integer

None.

state

string

None.

city

string

None.

occupationName

string

None.

referralProduct_ids

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "title": "sample string 1",
  "surname": "sample string 2",
  "othername": "sample string 3",
  "emailAddress": "sample string 4",
  "mobileNo": "sample string 5",
  "user_id": 6,
  "state": "sample string 7",
  "city": "sample string 8",
  "occupationName": "sample string 9",
  "referralProduct_ids": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<createprospectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createprospect">
  <city>sample string 8</city>
  <emailAddress>sample string 4</emailAddress>
  <mobileNo>sample string 5</mobileNo>
  <occupationName>sample string 9</occupationName>
  <othername>sample string 3</othername>
  <referralProduct_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </referralProduct_ids>
  <state>sample string 7</state>
  <surname>sample string 2</surname>
  <title>sample string 1</title>
  <user_id>6</user_id>
</createprospectRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"title":"sample string 1","surname":"sample string 2","othername":"sample string 3","emailAddress":"sample string 4","mobileNo":"sample string 5","user_id":6,"state":"sample string 7","city":"sample string 8","occupationName":"sample string 9","referralProduct_ids":[1,2]}

Response Information

Resource Description

createprospectResult
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

errorMsg

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3"
}

application/xml, text/xml

Sample:
<createprospectResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createprospect">
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <success>true</success>
</createprospectResult>

text/html

Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3"}