GET portal/{name}/projectandpropertycompact/{secretKey}?ChangeSince={ChangeSince}&CustomerId={CustomerId}&SiteId={SiteId}&IsLogHistory={IsLogHistory}
This function will get the project list and property list which are configured is Portal of the customer from ChangeSince value (Only for ImmoApp).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
portal name |
string |
Required |
| secretKey |
is used to authenticate user |
string |
Required |
| ChangeSince |
The filter condition: base on modified date (Default value = empty) |
date |
None. |
| CustomerId |
The filter condition: base on customer id. |
integer |
None. |
| SiteId | integer |
None. |
|
| IsLogHistory | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Return data
ReturnResultOfOmnicasaProjectsAndPropertiesForImmoApp| 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. |
OmnicasaProjectsAndPropertiesForImmoApp |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Code": 2,
"Message": "sample string 3",
"Value": {
"Projects": [
{
"Id": 1,
"ProjectId": 2,
"OfficeId": 3,
"Detail": {
"City": "sample string 1"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"Name": "sample string 3"
},
"sample string 2": {
"LanguageId": 2,
"Name": "sample string 3"
}
},
"Units": [
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
},
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
}
],
"OriginalId": 4
},
{
"Id": 1,
"ProjectId": 2,
"OfficeId": 3,
"Detail": {
"City": "sample string 1"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"Name": "sample string 3"
},
"sample string 2": {
"LanguageId": 2,
"Name": "sample string 3"
}
},
"Units": [
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
},
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
}
],
"OriginalId": 4
}
],
"Properties": [
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
},
{
"Id": 1,
"OfficeId": 2,
"Detail": {
"Ident": "sample string 1",
"Goal": 1,
"City": "sample string 2",
"SurfaceTotal": 1.1,
"NumberOfBedRooms": 1,
"Price": 1.0,
"BuildingId": 1,
"PropertyTypeCode": "sample string 3"
},
"Translations": {
"sample string 1": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
},
"sample string 2": {
"LanguageId": 2,
"TypeDescription": "sample string 3",
"StatusId": 1,
"StatusName": "sample string 4",
"SubstatusId": 1,
"SubstatusName": "sample string 5"
}
},
"OriginalId": 3
}
]
}
}
application/xml, text/xml
Sample:
<ReturnResultOfOmnicasaProjectsAndPropertiesForImmoAppOpzxWdDH 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>
<Projects>
<MediaLinkProjectForImmoApp>
<Detail>
<City>sample string 1</City>
</Detail>
<Id>1</Id>
<OfficeId>3</OfficeId>
<OriginalId>4</OriginalId>
<ProjectId>2</ProjectId>
<Translations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<Name>sample string 3</Name>
<PrimaryId>1</PrimaryId>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 2</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<Name>sample string 3</Name>
<PrimaryId>1</PrimaryId>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
</Translations>
<Units>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 2</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 2</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
</Units>
</MediaLinkProjectForImmoApp>
<MediaLinkProjectForImmoApp>
<Detail>
<City>sample string 1</City>
</Detail>
<Id>1</Id>
<OfficeId>3</OfficeId>
<OriginalId>4</OriginalId>
<ProjectId>2</ProjectId>
<Translations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<Name>sample string 3</Name>
<PrimaryId>1</PrimaryId>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 2</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<Name>sample string 3</Name>
<PrimaryId>1</PrimaryId>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkProjectTranslationForImmoAppUioCilC6>
</Translations>
<Units>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 2</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 1</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d7p1:Key>sample string 2</d7p1:Key>
<d7p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d7p1:Value>
</d7p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
</Units>
</MediaLinkProjectForImmoApp>
</Projects>
<Properties>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 2</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
<MediaLinkPropertyForImmoApp>
<Detail>
<BuildingId>1</BuildingId>
<City>sample string 2</City>
<Goal>1</Goal>
<Ident>sample string 1</Ident>
<NumberOfBedRooms>1</NumberOfBedRooms>
<Price>1</Price>
<ProjectId>1</ProjectId>
<PropertyTypeCode>sample string 3</PropertyTypeCode>
<SurfaceTotal>1.1</SurfaceTotal>
</Detail>
<Id>1</Id>
<OfficeId>2</OfficeId>
<OriginalId>3</OriginalId>
<Translations xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
<d5p1:Key>sample string 2</d5p1:Key>
<d5p1:Value>
<LanguageId>2</LanguageId>
<PrimaryId>1</PrimaryId>
<StatusId>1</StatusId>
<StatusName>sample string 4</StatusName>
<SubstatusId>1</SubstatusId>
<SubstatusName>sample string 5</SubstatusName>
<TypeDescription>sample string 3</TypeDescription>
</d5p1:Value>
</d5p1:KeyValueOfstringMediaLinkPropertyTranslationForImmoAppUioCilC6>
</Translations>
</MediaLinkPropertyForImmoApp>
</Properties>
</Value>
</ReturnResultOfOmnicasaProjectsAndPropertiesForImmoAppOpzxWdDH>