Search
K
[dev] 🇫🇷 Classifieds Management V3

Classifieds

CRUD operations about classifieds.

Create a new classified.

This endpoint allows you to create a new classified to be published on Aviv’s portals. Depending on the parameters sent along with the body payload, the classified can be created but not published. This endpoint returns synchronously a response informing if the body payload format is valid or not. In the case of a valid format, the endpoint will return a 202 Accepted HTTP status code with URL links to related resources. In the case of invalid format, the endpoint will return a 400 Invalid format HTTP status code with the details of the rejection’s reasons.

post

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Body

application/json

AvivClassified

* Additional properties are NOT allowed.
portalsarray[string]requiredunique-items

Portals where the classified has to be published on.

Allowed values:SLBUCOMBDLRLISLCSLN

>= 0 characters>= 0 items<= 5 items

Example:["SL","LI"]

dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
specificobject

Information related to the classified

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Accepted

classifiedIdstring(uuid)

Example:5c597a63-6932-4b0c-a2a0-2fd935be1755

linksarray
Show Child Parameters
post/classifieds

Body

{ "portals": [ "SL", "LI" ], "data": { "estateType": "HOUSE", "distributionType": "BUY", "location": { "postalcode": "22455", "city": "Hamburg", "street": "Hauptstrasse", "houseNumber": "10", "country": "DEU" }, "prices": {}, "metaData": { "source": { "sourceSystem": "Example Property Software System", "sourceSystemVersion": "1.0.2", "offererMarketingKey": "HH-AH61a-WE15a-1", "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981" } } } }
 
application/json

Return all the classifieds.

This endpoint allows you retrieve all your classifieds that have been published on Aviv’s portals.

get

Query Parameters

offererEstateIdstring

Get the classified by ExternalID.

>= 1 characters

limitinteger

Limit the number of results to be returned

Default:250

nextTokenstring

Use this value to start a new operation, excluding this value in the new request.

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Response

application/json

Success

itemsarrayrequired
* Additional properties are NOT allowed.
Show Child Parameters
nextTokenstring

Example:eyJ2ZXJzaW9uIjoiMiIsImNsYXNzaWZpZWRJZCI6IjdiMzg0YjM5LTBlNWEtNDFiMS05ODQ3LTE1MWEwYjNmY2U1MSIsImN1c3RvbWVySWQiOiJSQy0zNjgwMTMifQ==

get/classifieds
 
application/json

Return an existing classified.

This endpoint allows you to retrieve an existing classified.

get

Path Parameters

classifiedIdstring(uuid)required

ID of classified

>= 1 characters

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Response

application/json

Success

* Additional properties are NOT allowed.
portalsarray[string]requiredunique-items

Portals where the classified has to be published on.

Allowed values:SLBUCOMBDLRLISLCSLN

>= 0 characters>= 0 items<= 5 items

Example:["SL","LI"]

dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
specificobject

Information related to the classified

* Additional properties are NOT allowed.
Show Child Parameters
get/classifieds/{classifiedId}
 
application/json

Update an existing classified.

This endpoint allows you to update an existing classified.

put

Path Parameters

classifiedIdstring(uuid)required

ID of the classified to update

>= 1 characters

Headers

If-Matchstring

Check if the modification of a resource that the user wants to upload will not override
another change that has been done since the original resource was fetched.

Example:"1", "2", "3"

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Body

application/json

AvivClassified

* Additional properties are NOT allowed.
portalsarray[string]requiredunique-items

Portals where the classified has to be published on.

Allowed values:SLBUCOMBDLRLISLCSLN

>= 0 characters>= 0 items<= 5 items

Example:["SL","LI"]

dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
specificobject

Information related to the classified

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Accepted

classifiedIdstring(uuid)

Example:5c597a63-6932-4b0c-a2a0-2fd935be1755

linksarray
Show Child Parameters
put/classifieds/{classifiedId}

Body

{ "portals": [ "SL", "LI" ], "data": { "estateType": "HOUSE", "distributionType": "BUY", "location": { "postalcode": "22455", "city": "Hamburg", "street": "Hauptstrasse", "houseNumber": "10", "country": "DEU" }, "prices": {}, "metaData": { "source": { "sourceSystem": "Example Property Software System", "sourceSystemVersion": "1.0.2", "offererMarketingKey": "HH-AH61a-WE15a-1", "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981" } } } }
 
application/json