POST api/Peppermint

Submits a referral to dezrez legal Processes this peppermint API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The referral data contract supplied with the request.

ReferralDataContract

Name	Description	Type	Additional information
Contact	The contact value.	PeppermintContact	None.
Contact1	The contact1 value.	PeppermintContact	None.
EstateAgent	The estate agent value.	PeppermintContact	None.
Properties	The collection of properties.	Collection of PeppermintProperty	None.
ReferringAgent	The referring agent value.	PeppermintContact	None.
ReferringNegotiator	The referring negotiator value.	PeppermintContact	None.
ReferredSolicitor	The referred solicitor value.	PeppermintContact	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Contact": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  },
  "Contact1": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  },
  "EstateAgent": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  },
  "Properties": [
    {
      "ContactsRelationshipWithThisProperty": 0,
      "DezrezPropertyID": 1,
      "DezrezPropertyRoleID": 2,
      "PanelReference": "sample string 3",
      "Postcode": "sample string 4",
      "Price": 5.0,
      "StreetAddress1": "sample string 6",
      "StreetAddress2": "sample string 7",
      "Tenure": 956690000,
      "Town": "sample string 8"
    },
    {
      "ContactsRelationshipWithThisProperty": 0,
      "DezrezPropertyID": 1,
      "DezrezPropertyRoleID": 2,
      "PanelReference": "sample string 3",
      "Postcode": "sample string 4",
      "Price": 5.0,
      "StreetAddress1": "sample string 6",
      "StreetAddress2": "sample string 7",
      "Tenure": 956690000,
      "Town": "sample string 8"
    }
  ],
  "ReferringAgent": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  },
  "ReferringNegotiator": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  },
  "ReferredSolicitor": {
    "BusinessPhone": "sample string 1",
    "CompanyName": "sample string 2",
    "ContactMethodDoNotBulkEmail": true,
    "ContactMethodDoNotEmail": true,
    "ContactMethodDoNotFax": true,
    "ContactMethodDoNotMail": true,
    "ContactMethodDoNotPhone": true,
    "Country": "sample string 8",
    "DezrezAgentID": 9,
    "DezrezBranchID": 10,
    "DezrezContactID": 11,
    "DezrezNegotiatorID": 12,
    "DezrezGroupID": 13,
    "Email": "sample string 14",
    "Fax": "sample string 15",
    "FirstName": "sample string 16",
    "HomePhone": "sample string 17",
    "LastName": "sample string 18",
    "MobilePhone": "sample string 19",
    "PostCode": "sample string 20",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 21",
    "Salutation": "sample string 22",
    "StreetAddress1": "sample string 23",
    "StreetAddress2": "sample string 24",
    "Town": "sample string 25",
    "WebSite": "sample string 26"
  }
}

Response Information

Resource Description

The response returned after the operation completes.

ReferralResponseDataContract

Name	Description	Type	Additional information
Success	Indicates whether success is true.	boolean	None.
ErrorMessage	The error message value.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2"
}