POST immoscoop/contactonme/{secretKey}

This function will create/update person, task, history.

Request Information

URI Parameters

Name	Description	Type	Additional information
secretKey	is used to authenticate user	string	Required

Body Parameters

person info, property id, some fields from history

MediaLinkContactOnMeParameters

Name	Description	Type	Additional information
CustomerId	Identity of customer	integer	None.
Name	Person Name	string	None.
FirstName	Person FirstName	string	None.
AddressTitle	Person Address Title	string	None.
LetterTitle	Person Letter Title	string	None.
Address	Person Address Information	string	None.
City	Person City	string	None.
Zip	Person Zip	string	None.
Email	Person Email	string	None.
Password	Person Password	string	None.
PhoneNumber	Person PhoneNumber	string	None.
GSM	Person GSM Phone	string	None.
OfficeId	Person OfficeId	integer	None.
IsReceivedEmail	This person will be received Email or not	boolean	None.
SourceId	Person SourceId from owner or immoweb or century or ...	integer	None.
CountryId	Person CountryId	integer	None.
Subject	History Subject	string	None.
Content	History Content	string	None.
PropertyId	Property identifier	integer	None.
Profession	Person Profession	string	None.
Fax	Person fax	string	None.
CategorieIds	Categories id list of persons (example:'1,2,3')	string	None.
CompanyName	Company Name of Person	string	None.
LanguageIdFromParameter	This value is used for updating language of persons	integer	None.
LanguageId	1: NL, 2: FR, 3: EN, Default value = 1	integer	None.
IsWriteLogSQL	Write sql query for debug	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "Name": "sample string 2",
  "FirstName": "sample string 3",
  "AddressTitle": "sample string 4",
  "LetterTitle": "sample string 5",
  "Address": "sample string 6",
  "City": "sample string 7",
  "Zip": "sample string 8",
  "Email": "sample string 9",
  "Password": "sample string 10",
  "PhoneNumber": "sample string 11",
  "GSM": "sample string 12",
  "OfficeId": 1,
  "IsReceivedEmail": true,
  "SourceId": 1,
  "CountryId": 1,
  "Subject": "sample string 13",
  "Content": "sample string 14",
  "PropertyId": 15,
  "Profession": "sample string 16",
  "Fax": "sample string 17",
  "CategorieIds": "sample string 18",
  "CompanyName": "sample string 19",
  "LanguageIdFromParameter": 20,
  "LanguageId": 21,
  "IsWriteLogSQL": true
}

application/xml, text/xml

Sample:

<MediaLinkContactOnMeParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Parameters">
  <IsWriteLogSQL>true</IsWriteLogSQL>
  <LanguageId>21</LanguageId>
  <Address>sample string 6</Address>
  <AddressTitle>sample string 4</AddressTitle>
  <CategorieIds>sample string 18</CategorieIds>
  <City>sample string 7</City>
  <CompanyName>sample string 19</CompanyName>
  <Content>sample string 14</Content>
  <CountryId>1</CountryId>
  <CustomerId>1</CustomerId>
  <Email>sample string 9</Email>
  <Fax>sample string 17</Fax>
  <FirstName>sample string 3</FirstName>
  <GSM>sample string 12</GSM>
  <IsReceivedEmail>true</IsReceivedEmail>
  <LanguageIdFromParameter>20</LanguageIdFromParameter>
  <LetterTitle>sample string 5</LetterTitle>
  <Name>sample string 2</Name>
  <OfficeId>1</OfficeId>
  <Password>sample string 10</Password>
  <PhoneNumber>sample string 11</PhoneNumber>
  <Profession>sample string 16</Profession>
  <PropertyId>15</PropertyId>
  <SourceId>1</SourceId>
  <Subject>sample string 13</Subject>
  <Zip>sample string 8</Zip>
</MediaLinkContactOnMeParameters>

Response Information

Resource Description

Return person id from Value field

ReturnResultOfInt32

Name	Description	Type	Additional information
Success	Value = true is successful (If this value = false, then we should see Code and Message to have more info about error.)	boolean	None.
Code	It's error code (If value = 0, it's successful)	integer	None.
Message	It's error message (If value = empty, it's successful).	string	None.
Value	Data which you need to get.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Code": 2,
  "Message": "sample string 3",
  "Value": 4
}

application/xml, text/xml

Sample:

<ReturnResultOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Models">
  <Code>2</Code>
  <Message>sample string 3</Message>
  <Success>true</Success>
  <Value>4</Value>
</ReturnResultOfint>