POST api/match/{contactGroupId}

Request Information

URI Parameters

Name	Description	Type	Additional information
contactGroupId		integer	Required

Body Parameters

MatchCriterium

Name	Type	Additional information
Id	integer	None.
Active	boolean	None.
TransactionType	TransactionType	None.
TransactionTypeDescription	string	None.
EstateCategory	EstateCategoryType	None.
EstateCategoryDescription	string	None.
EstateSort	EstateSortType	None.
EstateSortDescription	string	None.
EstateGenres	Collection of EstateGenreType	None.
EstateCharacterisations	Collection of EstateCharacterisationType	None.
ValidUntil	date	None.
Name	string	None.
Price	MatchRange	None.
RegionType	MatchRegionType	None.
Zones	Collection of Zone	None.
Cities	Collection of City	None.
Country	Country	None.
MarketingTypes	Collection of MarketingType	None.
NumberOfBedrooms	integer	None.
Comment	string	None.
Garden	boolean	None.
Garage	boolean	None.
Terrace	boolean	None.
Elevator	boolean	None.
NewEstate	boolean	None.
Furnished	boolean	None.
Parking	boolean	None.
Investment	boolean	None.
PolygonText	string	None.
EnergyClassLabel	string	None.
MaxEnergyClassValue	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "active": true,
  "transactionType": "SALE",
  "transactionTypeDescription": "sample string 2",
  "estateCategory": "Residential",
  "estateCategoryDescription": "sample string 3",
  "estateSort": "Dwelling",
  "estateSortDescription": "sample string 4",
  "estateGenres": [
    "ArchitectDwelling",
    "ArchitectDwelling"
  ],
  "estateCharacterisations": [
    "Dwelling_Corner",
    "Dwelling_Corner"
  ],
  "validUntil": "2024-09-19T12:51:29.6477952+02:00",
  "name": "sample string 5",
  "price": {
    "from": 1.0,
    "to": 1.0,
    "validRange": true
  },
  "regionType": "Country",
  "zones": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "cities": [
    {
      "id": 1,
      "name": "sample string 2",
      "zipCode": "sample string 3",
      "country": "AD"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "zipCode": "sample string 3",
      "country": "AD"
    }
  ],
  "country": "AD",
  "marketingTypes": [
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    },
    {
      "id": 1,
      "code": "sample string 1",
      "marketingSubjectType": "sample string 2",
      "description": "sample string 3",
      "selected": true
    }
  ],
  "numberOfBedrooms": 1,
  "comment": "sample string 6",
  "garden": true,
  "garage": true,
  "terrace": true,
  "elevator": true,
  "newEstate": true,
  "furnished": true,
  "parking": true,
  "investment": true,
  "polygonText": "sample string 15",
  "energyClassLabel": "sample string 16",
  "maxEnergyClassValue": 1
}

application/xml, text/xml

Sample:

<MatchCriterium xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Active>true</Active>
  <Cities>
    <City>
      <Country>AD</Country>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ZipCode>sample string 3</ZipCode>
    </City>
    <City>
      <Country>AD</Country>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ZipCode>sample string 3</ZipCode>
    </City>
  </Cities>
  <Comment>sample string 6</Comment>
  <Country>AD</Country>
  <Elevator>true</Elevator>
  <EnergyClassLabel>sample string 16</EnergyClassLabel>
  <EstateCategory>Residential</EstateCategory>
  <EstateCategoryDescription>sample string 3</EstateCategoryDescription>
  <EstateCharacterisations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Skarabee.Net.OM">
    <d2p1:Enums.EstateCharacterisationType>Dwelling_Corner</d2p1:Enums.EstateCharacterisationType>
    <d2p1:Enums.EstateCharacterisationType>Dwelling_Corner</d2p1:Enums.EstateCharacterisationType>
  </EstateCharacterisations>
  <EstateGenres xmlns:d2p1="http://schemas.datacontract.org/2004/07/Skarabee.Net.OM">
    <d2p1:Enums.EstateGenreType>ArchitectDwelling</d2p1:Enums.EstateGenreType>
    <d2p1:Enums.EstateGenreType>ArchitectDwelling</d2p1:Enums.EstateGenreType>
  </EstateGenres>
  <EstateSort>Dwelling</EstateSort>
  <EstateSortDescription>sample string 4</EstateSortDescription>
  <Furnished>true</Furnished>
  <Garage>true</Garage>
  <Garden>true</Garden>
  <Id>1</Id>
  <Investment>true</Investment>
  <MarketingTypes>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
    <MarketingType>
      <Code>sample string 1</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <MarketingSubjectType>sample string 2</MarketingSubjectType>
      <Selected>true</Selected>
    </MarketingType>
  </MarketingTypes>
  <MaxEnergyClassValue>1</MaxEnergyClassValue>
  <Name>sample string 5</Name>
  <NewEstate>true</NewEstate>
  <NumberOfBedrooms>1</NumberOfBedrooms>
  <Parking>true</Parking>
  <PolygonText>sample string 15</PolygonText>
  <Price>
    <From>1</From>
    <To>1</To>
  </Price>
  <RegionType>Country</RegionType>
  <Terrace>true</Terrace>
  <TransactionType>SALE</TransactionType>
  <TransactionTypeDescription>sample string 2</TransactionTypeDescription>
  <ValidUntil>2024-09-19T12:51:29.6477952+02:00</ValidUntil>
  <Zones>
    <Zone>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Zone>
    <Zone>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Zone>
  </Zones>
</MatchCriterium>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MatchUpdateResult

Name	Type	Additional information
Match	MatchCriterium	None.
Success	boolean	None.
Status	Errata	None.
Errors	Collection of string	None.
Message	string	None.
StackTrace	string	None.
Exception	Exception	None.

Response Formats

application/json, text/json

Sample:

{
  "match": {
    "id": 1,
    "active": true,
    "transactionType": "SALE",
    "transactionTypeDescription": "sample string 2",
    "estateCategory": "Residential",
    "estateCategoryDescription": "sample string 3",
    "estateSort": "Dwelling",
    "estateSortDescription": "sample string 4",
    "estateGenres": [
      "ArchitectDwelling",
      "ArchitectDwelling"
    ],
    "estateCharacterisations": [
      "Dwelling_Corner",
      "Dwelling_Corner"
    ],
    "validUntil": "2024-09-19T12:51:29.6477952+02:00",
    "name": "sample string 5",
    "price": {
      "from": 1.0,
      "to": 1.0,
      "validRange": true
    },
    "regionType": "Country",
    "zones": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "cities": [
      {
        "id": 1,
        "name": "sample string 2",
        "zipCode": "sample string 3",
        "country": "AD"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "zipCode": "sample string 3",
        "country": "AD"
      }
    ],
    "country": "AD",
    "marketingTypes": [
      {
        "id": 1,
        "code": "sample string 1",
        "marketingSubjectType": "sample string 2",
        "description": "sample string 3",
        "selected": true
      },
      {
        "id": 1,
        "code": "sample string 1",
        "marketingSubjectType": "sample string 2",
        "description": "sample string 3",
        "selected": true
      }
    ],
    "numberOfBedrooms": 1,
    "comment": "sample string 6",
    "garden": true,
    "garage": true,
    "terrace": true,
    "elevator": true,
    "newEstate": true,
    "furnished": true,
    "parking": true,
    "investment": true,
    "polygonText": "sample string 15",
    "energyClassLabel": "sample string 16",
    "maxEnergyClassValue": 1
  },
  "success": true,
  "status": "OK",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "message": "sample string 2",
  "stackTrace": "sample string 3",
  "exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:

<Result.MatchUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <StackTrace>sample string 3</StackTrace>
  <Status>OK</Status>
  <Success>true</Success>
  <Match>
    <Active>true</Active>
    <Cities>
      <City>
        <Country>AD</Country>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <ZipCode>sample string 3</ZipCode>
      </City>
      <City>
        <Country>AD</Country>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <ZipCode>sample string 3</ZipCode>
      </City>
    </Cities>
    <Comment>sample string 6</Comment>
    <Country>AD</Country>
    <Elevator>true</Elevator>
    <EnergyClassLabel>sample string 16</EnergyClassLabel>
    <EstateCategory>Residential</EstateCategory>
    <EstateCategoryDescription>sample string 3</EstateCategoryDescription>
    <EstateCharacterisations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Skarabee.Net.OM">
      <d3p1:Enums.EstateCharacterisationType>Dwelling_Corner</d3p1:Enums.EstateCharacterisationType>
      <d3p1:Enums.EstateCharacterisationType>Dwelling_Corner</d3p1:Enums.EstateCharacterisationType>
    </EstateCharacterisations>
    <EstateGenres xmlns:d3p1="http://schemas.datacontract.org/2004/07/Skarabee.Net.OM">
      <d3p1:Enums.EstateGenreType>ArchitectDwelling</d3p1:Enums.EstateGenreType>
      <d3p1:Enums.EstateGenreType>ArchitectDwelling</d3p1:Enums.EstateGenreType>
    </EstateGenres>
    <EstateSort>Dwelling</EstateSort>
    <EstateSortDescription>sample string 4</EstateSortDescription>
    <Furnished>true</Furnished>
    <Garage>true</Garage>
    <Garden>true</Garden>
    <Id>1</Id>
    <Investment>true</Investment>
    <MarketingTypes>
      <MarketingType>
        <Code>sample string 1</Code>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <MarketingSubjectType>sample string 2</MarketingSubjectType>
        <Selected>true</Selected>
      </MarketingType>
      <MarketingType>
        <Code>sample string 1</Code>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <MarketingSubjectType>sample string 2</MarketingSubjectType>
        <Selected>true</Selected>
      </MarketingType>
    </MarketingTypes>
    <MaxEnergyClassValue>1</MaxEnergyClassValue>
    <Name>sample string 5</Name>
    <NewEstate>true</NewEstate>
    <NumberOfBedrooms>1</NumberOfBedrooms>
    <Parking>true</Parking>
    <PolygonText>sample string 15</PolygonText>
    <Price>
      <From>1</From>
      <To>1</To>
    </Price>
    <RegionType>Country</RegionType>
    <Terrace>true</Terrace>
    <TransactionType>SALE</TransactionType>
    <TransactionTypeDescription>sample string 2</TransactionTypeDescription>
    <ValidUntil>2024-09-19T12:51:29.6477952+02:00</ValidUntil>
    <Zones>
      <Zone>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Zone>
      <Zone>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Zone>
    </Zones>
  </Match>
</Result.MatchUpdateResult>