Skip to content

Create proposal for new project

This method creates a proposal for contract negotiations of a new project

POST /offer/v1.0/user/{username}/realestateproject/project-proposal

Supported media types:
XML
JSON

Note

Only one proposal can be created for a single externalId.

Request

Path Parameters

PARAMETER DESCRIPTION
username the username which the user uses for logging in to www.immobilienscout24.de

"me" can be used instead of the username, when the user is logged in by 3-legged OAuth 1.0

Payload

PARAMETER CONSTRAINTS
customerName max. 80 characters
companyName max. 100 characters
email max. 300 characters
phoneNumber max. 40 characters
projectName max. 40 characters
postcode max. 20 characters
city max. 50 characters
startDate YYYY-MM-DD
numberOfHousingUnits max. 9999
externalId max. 100 characters
crmName max. 80 characters

XML: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:projectProposal xmlns:ns2="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0">
  <customerName>customer name</customerName>
  <companyName>company name</companyName>
  <email>email@domain.com</email>
  <phoneNumber>+49 123 456 789</phoneNumber>
  <projectName>project name</projectName>
  <postcode>12345</postcode>
  <city>some city</city>
  <startDate>2021-01-01</startDate>
  <numberOfHousingUnits>999</numberOfHousingUnits>
  <externalId>some_external_id</externalId>
  <crmName>name_of_crm</crmName>
</ns2:projectProposal>

JSON: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "realestateproject.projectProposal": {
    "customerName": "customer name",
    "companyName": "company name",
    "email": "email@domain.com",
    "phoneNumber": "+49 123 456 789",
    "projectName": "project name",
    "postcode": "12345",
    "city": "some city",
    "startDate": "2021-01-01",
    "numberOfHousingUnits": 999,
    "externalId": "some_external_id",
    "crmName": "name_of_crm"
  }
}

Successful response

HTTP Code: 200

XML: 

1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages
    xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
    xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
    <message>
        <messageCode>MESSAGE_OPERATION_SUCCESSFUL</messageCode>
        <message>Operation successful</message>
    </message>
</common:messages>

JSON: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "common.messages": [
        {
            "message": {
                "messageCode": "MESSAGE_OPERATION_SUCCESSFUL",
                "message": "Operation successful"
            }
        }
    ]
}

Unsuccessful responses

Invalid or missing data

HTTP Code: 412

XML: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
                 xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: customerName : : MANDATORY_FIELD_EMPTY]</message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: companyName :
      cyPoMCPwUeNZTVLkkmMFSHDSuAxKfrazEzPYnUOGnvMnTzDQjVcUcCDrXVFJLHnSjmNRNqCqPnaqPLnczLPZoOOGLoHDhqYvrlnmA :
      LENGTH_EXCEEDED]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: email : email@domain : INVALID_EMAIL_FORMAT]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: phoneNumber : &lt;b&gt;+49&lt;/b&gt; 123 456 789 :
      CONTAINS_HTML]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: projectName : : MANDATORY_FIELD_EMPTY]</message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: postcode : 488087698123672600821 :
      LENGTH_EXCEEDED]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: city : &lt;em&gt;CITY&lt;/em&gt; :
      CONTAINS_HTML]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: startDate : null : MANDATORY_FIELD_EMPTY]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: numberOfHousingUnits : 10000 : NOT_IN_RANGE]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: externalId : null : MANDATORY_FIELD_EMPTY]
    </message>
  </message>
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: crmName : null : MANDATORY_FIELD_EMPTY]
    </message>
  </message>
</common:messages>

JSON: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
  "common.messages": [
    {
      "message": [
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: customerName :  : MANDATORY_FIELD_EMPTY]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: companyName : aWfelCegIiPYKVeYVJelfqhnmQxHlGIwHFaLOCmppBFCnoQUlmPoABvecFuatslSvhkXmndCAzpBIdHRUKfyuFQtPKRaBRnxUiFPW : LENGTH_EXCEEDED]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: email : email@domain : INVALID_EMAIL_FORMAT]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: phoneNumber : <b>+49</b> 123 456 789 : CONTAINS_HTML]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: projectName :  : MANDATORY_FIELD_EMPTY]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: postcode : 784687824669880636422 : LENGTH_EXCEEDED]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: city : <em>CITY</em> : CONTAINS_HTML]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: startDate : null : MANDATORY_FIELD_EMPTY]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: numberOfHousingUnits : 10000 : NOT_IN_RANGE]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: externalId : null : MANDATORY_FIELD_EMPTY]"
        },
        {
          "messageCode": "ERROR_RESOURCE_VALIDATION",
          "message": "Error while validating input for the resource. [MESSAGE: crmName : null : MANDATORY_FIELD_EMPTY]"
        }
      ]
    }
  ]
}

Duplicated externalId

HTTP Code: 412

XML: 

1
2
3
4
5
6
7
8
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
                 xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
  <message>
    <messageCode>ERROR_RESOURCE_VALIDATION</messageCode>
    <message>Error while validating input for the resource. [MESSAGE: externalId : some_external_id : projectProposal.externalId.alreadyExists]</message>
  </message>
</common:messages>

JSON: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "common.messages": [
    {
      "message": {
        "messageCode": "ERROR_RESOURCE_VALIDATION",
        "message": "Error while validating input for the resource. [MESSAGE: externalId : some_external_id : projectProposal.externalId.alreadyExists]"
      }
    }
  ]
}