Create a project

Create a new project

POST /aos/v1/projects

Headers

Header Value
Content-Type application/json
Accept application/json

Body params

Parameter Type Mandatory Description
name string yes The name of the project
construction_type string yes The type of construction. It must be one of those values: collective_building, extension, health_building, mall, office, other, public_building, public_space, single_flat, warehouse.
managers.*.id string yes The UUID of the manager(s) of the project (at least 1).
organization_id string no The UUID of the organization if you want to create the project to a specific organization where the user is allowed to access.
managers.*.first_name string The first name of the manager
managers.*.last_name string The last name of the manager
managers.*.phone string The phone number of the manager
managers.*.mobile string The mobile number of the manager
end_of_offer_date string (DateTime) Max date to send an answer as contractor.
trade_list_id string (UUID) yes The trade list UUID to use in the project.
description string The description of the project.
response_type string yes The type of the response. It must be one of those values: DPGF, DPGF_QUOTE or QUOTE.
published_on_chantier_prive boolean If the project must published on https://chantierprive.fr.
tenders_closing_activated boolean If the feature "Fermeture des plis" must be activated.
contributors.architect string The name of the architect.
contributors.project_manager_consultant string The project manager consultant.
contributors.scheduling_management_coordination string The scheduling management coordinator.
contributors.construction_supervisors string The construction supervisor.
customer.id string The UUID of the customer if already exists.
customer.name string The name of customer. He will be created if he does not exist.
customer.country string The country of customer.
customer.is_archived boolean The customer is archived.
site_address.number string The number of the street where is located the project.
site_address.primary_address string The primary name of the street where is located the project.
site_address.secondary_address string The secondary name of the street where is located the project.
site_address.zip_code string The postal code of the city where is located the project.
site_address.city string The name of the city where is located the project.
site_address.country string The country where is located the project.
site_address.geo.coordinates array[long, lat] An array with coordinate of where is located the project. For example: 48.873834, 2.294995.
site_address.geo.coordinates string Type of coordinate of where is located the project. The value must be Point.
optional_dates.noc string (DateTime)
optional_dates.commencement_works_construction string (DateTime)
optional_dates.end_works_construction string (DateTime)
optional_dates.responses_opening_date string (DateTime)
scopes.prorate integer
scopes.currency string Must a valid currency in uppercase with only 3 characters.
scopes.vat double yes The VAT applied to the project. The minimum is 1 and the maximum is 100.
scopes.levels integer
scopes.plot_surface_area double
scopes.foundation_level_surface_area double
scopes.total_floor_surface_area double
scopes.green_spaces_area double
scopes.road_surface_area double
scopes.internal_reference string

Example of request with mandatory fields

{
  "name": "MON PROJET",
  "construction_type": "collective_building",
  "managers": [
    {
      "id": "977600e6-5ec6-41df-807a-e221af668591"
    }
  ],
  "trade_list_id": "977600e6-93b8-43d0-9f1c-1eaf7b1f334a",
  "response_type": "QUOTE",
  "scopes": {
    "vat": 20
  }
}

Example of request with all fields

{
    "name": "MON PROJET",
    "construction_type": "collective_building",
    "managers": [
        {
            "id": "977600e6-5ec6-41df-807a-e221af668591",
            "first_name": "User",
            "last_name": "Name",
            "phone": "+33102030405",
            "mobile": "+33102030405"
        }
    ],
    "end_of_offer_date": "2019-07-30T22:00:00.000000Z",
    "trade_list_id": "977600e6-93b8-43d0-9f1c-1eaf7b1f334a",
    "description": "Construction d'un monument.",
    "response_type": "QUOTE",
    "published_on_chantier_prive": false,
    "tenders_closing_activated": false,
    "contributors": {
        "architect": "Saqara Architecte",
        "project_manager_consultant": null,
        "scheduling_management_coordination": null,
        "construction_supervisors": null
    },
    "customer": {
        "id": "977600e6-a91c-4d6d-9b09-c396451d02c6",
        "name": "SAQARA IMMOBILIER",
        "country": "fr",
        "is_archived": false
    },
    "site_address": {
        "number": "23",
        "primary_address": "Place Charles de Gaulle",
        "secondary_address": null,
        "zip_code": "75008",
        "city": "Paris",
        "country": "FR",
        "locality": null,
        "geo": {
            "coordinates": [
              48.873834,
              2.294995
            ],
            "type": "Point"
        }
    },
    "optional_dates": {
        "noc": "2019-04-16T22:00:00.000000Z",
        "commencement_works_construction": "2019-05-14T22:00:00.000000Z",
        "end_works_construction": "2020-04-07T22:00:00.000000Z",
        "responses_opening_date": "2018-04-14T22:00:00.000000Z"
    },
    "scopes": {
        "prorate": 2,
        "currency": "EUR",
        "vat": 20,
        "levels": 2,
        "plot_surface_area": 3000,
        "foundation_level_surface_area": 1700,
        "total_floor_surface_area": 10000,
        "green_spaces_area": 5000,
        "road_surface_area": 4000,
        "internal_reference": null
    }
}

Response

Status: 201 Created

It returns a project object as described in the Retrieve a project section

{
    "project": {
        "id": "97d005ae-dfde-4abd-9a48-8383300b7894",
        // ...
    }
}

{warning.fa-warning} If you specify an organization not authorized the API will return a 403. If the organization does not exist the API will return a 404.