POST api/Peppermint

Request Information

URI Parameters

None.

Body Parameters

ReferralDataContract
NameDescriptionTypeAdditional information
Contact

PeppermintContact

None.

Contact1

PeppermintContact

None.

EstateAgent

PeppermintContact

None.

Properties

Collection of PeppermintProperty

None.

ReferringAgent

PeppermintContact

None.

ReferringNegotiator

PeppermintContact

None.

Request Formats

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,
    "Email": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "HomePhone": "sample string 16",
    "LastName": "sample string 17",
    "MobilePhone": "sample string 18",
    "PostCode": "sample string 19",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 20",
    "Salutation": "sample string 21",
    "StreetAddress1": "sample string 22",
    "StreetAddress2": "sample string 23",
    "Town": "sample string 24",
    "WebSite": "sample string 25"
  },
  "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,
    "Email": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "HomePhone": "sample string 16",
    "LastName": "sample string 17",
    "MobilePhone": "sample string 18",
    "PostCode": "sample string 19",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 20",
    "Salutation": "sample string 21",
    "StreetAddress1": "sample string 22",
    "StreetAddress2": "sample string 23",
    "Town": "sample string 24",
    "WebSite": "sample string 25"
  },
  "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,
    "Email": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "HomePhone": "sample string 16",
    "LastName": "sample string 17",
    "MobilePhone": "sample string 18",
    "PostCode": "sample string 19",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 20",
    "Salutation": "sample string 21",
    "StreetAddress1": "sample string 22",
    "StreetAddress2": "sample string 23",
    "Town": "sample string 24",
    "WebSite": "sample string 25"
  },
  "Properties": [
    {
      "ContactsRelationshipWithThisProperty": 0,
      "DezrezPropertyID": 1,
      "PanelReference": "sample string 2",
      "Postcode": "sample string 3",
      "Price": 4.0,
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6",
      "Tenure": 956690000,
      "Town": "sample string 7"
    },
    {
      "ContactsRelationshipWithThisProperty": 0,
      "DezrezPropertyID": 1,
      "PanelReference": "sample string 2",
      "Postcode": "sample string 3",
      "Price": 4.0,
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6",
      "Tenure": 956690000,
      "Town": "sample string 7"
    }
  ],
  "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,
    "Email": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "HomePhone": "sample string 16",
    "LastName": "sample string 17",
    "MobilePhone": "sample string 18",
    "PostCode": "sample string 19",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 20",
    "Salutation": "sample string 21",
    "StreetAddress1": "sample string 22",
    "StreetAddress2": "sample string 23",
    "Town": "sample string 24",
    "WebSite": "sample string 25"
  },
  "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,
    "Email": "sample string 13",
    "Fax": "sample string 14",
    "FirstName": "sample string 15",
    "HomePhone": "sample string 16",
    "LastName": "sample string 17",
    "MobilePhone": "sample string 18",
    "PostCode": "sample string 19",
    "PreferredMethodOfContact": 1,
    "ReferralNotes": "sample string 20",
    "Salutation": "sample string 21",
    "StreetAddress1": "sample string 22",
    "StreetAddress2": "sample string 23",
    "Town": "sample string 24",
    "WebSite": "sample string 25"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReferralDataContract'.

Response Information

Resource Description

PeppermintResponseDataContract
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

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