Search
K
[dev] 🇫🇷 Network Management France

Network Management API v1

1.0.3OAS 3.0
API Base URL
  • Server 1:https://api.aviv-group.com/network-management/v1

    Production server

  • Server 2:https://api.aviv-group.com/sandbox/network-management/v1

    Sandbox server

Security
Bearer (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Intermediaries

Intermediary API.

Create an intermediary

post

Path Parameters

networkIdstring(uuid)required

Network Id

Body

Intermediary Data

* Additional properties are NOT allowed.
realEstateIntermediaryExternalIdstringrequired

Your internal id for the intermediary

>= 3 characters<= 20 characters

Example:id-int-42

siretstring | null

Company siret number

Match pattern:^[0-9]{9,14}$

Example:71425177424826

registeredCompanyNamestringrequired

The legal company name registered

>= 2 characters<= 255 characters

Example:SARL Agence Dupont

commercialNamestringrequired

The company commercial name

>= 2 characters<= 100 characters

Example:Dupont immobilier 15ème

emailstringrequired

Email address

>= 1 characters

Example:jean.dupont@gmail.com

phonestringrequired

Phone number

>= 1 characters

Example:+330601020304

realEstateIntermediaryURLstring | null

Intermediary’s website url

Example:https://google.com

contactsarray[object]required

Admin and principal contacts information are required

* Additional properties are NOT allowed.
Show Child Parameters
addressobjectrequired

Company address

* Additional properties are NOT allowed.
Show Child Parameters
socialNetworksarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
logosarray | null[object]

Company logos

* Additional properties are NOT allowed.
Show Child Parameters
legalInformationsarray | null[object]

Company legal informations

* Additional properties are NOT allowed.
Show Child Parameters
openingHoursarray | null[object]

Heures d’ouvertures et fermetures

* Additional properties are NOT allowed.
Show Child Parameters
closurePeriodsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
presentationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
activityobject
* Additional properties are NOT allowed.
Show Child Parameters
scaleOfFeesURLstring | null

The URL of your slace of fees in PDF

Example:https://yourdomain.com/honoraires.pdf

secondaryExternalIdstring | null

Specific id to match classifieds from flow

>= 0 characters<= 10 characters

Example:MatchingId-for-classifieds

accountCategorystringrequired

Category of account. Possible values :
[Agence de Pub, Agence Immobilière, Agent Commercial, Agent Commercial en Portage, Annonceur, Architecte, Avocat, Camping, cat1, cat2, cat3, cat4, Commercialisateur Neuf, Conseil en Immobilier d’Entreprise, Conseil/Gestion, Constructeur Maison Individuelle, Huissier, Institutionnel, Maître d’oeuvre, Notaire, Point de Vente/Marque, Portail de Diffusion, Promoteur, Régie Publicitaire, Relais Départementaux, Résidence & Village de vacances, Société Civile Immobilière, Tours Opérateurs et Partenaires Généraux]

>= 1 characters

Example:Agence Immobilière

Response

application/json

The intermediary is successfully created.

CreateIntermediaryResponse

* Additional properties are NOT allowed.
externalIdstring | null
post/intermediaries/{networkId}

Body

{ "realEstateIntermediaryExternalId": "id-int-42", "registeredCompanyName": "SARL Agence Dupont", "commercialName": "Dupont immobilier 15ème", "email": "jean.dupont@gmail.com", "phone": "+330601020304", "contacts": [ { "type": "admin", "title": "Monsieur", "firstname": "Jean", "lastname": "Dupont", "email": "jean.dupont@gmail.com", "phone": "+330601020304" } ], "address": { "street": "Rue des Italiens", "postalCode": "75009", "city": "Paris 9ème", "countryCode": "FR" }, "accountCategory": "Agence Immobilière" }
 
application/json