{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http://localhost" } ], "info": { "name": "api", "_postman_id": "00000000-0000-0000-0000-000000000000", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Projects", "description": "", "item": [ { "name": "List projects", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all projects accessible to the authenticated user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Create a project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"organization_id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"construction_type\":\"office\",\"managers\":[{\"id\":\"977e5426-8d13-3824-86aa-b092f8ae52c5\"}],\"trade_list_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"response_type\":\"DPGF\",\"end_of_offer_date\":\"2025-01-01T00:00:00\",\"end_works_construction\":\"2025-01-01T00:00:00\",\"commencement_works_construction\":\"2025-01-01T00:00:00\",\"tenders_closing_activated\":true,\"published_on_chantier_prive\":false,\"scopes\":{\"currency\":\"EUR\",\"vat\":7,\"prorate\":16,\"levels\":27},\"site_address\":{\"number\":35,\"zip_code\":4326.41688},\"optional_dates\":{\"noc\":\"2025-01-01T00:00:00\",\"responses_opening_date\":\"2025-01-01T00:00:00\"}}" }, "description": "Create a new project in the authenticated user's organization (or a specified one)." }, "response": [] }, { "name": "Get a project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a project by its UUID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Archive a project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/archive", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/archive", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark a project as archived." }, "response": [] }, { "name": "Get project statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/statistics", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/statistics", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get statistics for a project, including contractor counts and DCE downloads." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] } ] }, { "name": "Project Trades", "description": "", "item": [ { "name": "List project trades", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/trades", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/trades", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all trades for a given project." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Add a trade", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/trades", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/trades", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"number\":\"architecto\",\"short_name\":\"architecto\"}" }, "description": "Add a new trade to a project's trade list." }, "response": [] }, { "name": "Update a project trade", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/trades\/:tradeId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/trades\/:tradeId", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "tradeId", "key": "tradeId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"number\":\"architecto\",\"short_name\":\"architecto\",\"comment\":\"architecto\"}" }, "description": "Update the name, number or short name of a trade within a project." }, "response": [] }, { "name": "Remove a project trade", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/trades\/:tradeId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/trades\/:tradeId", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "tradeId", "key": "tradeId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a trade from a project's trade list." }, "response": [] } ] }, { "name": "Project Templates", "description": "", "item": [ { "name": "List DPGF templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all DPGF templates for a project." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "List DPGF templates with documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates\/documents", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates\/documents", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve templates with contractor documents for a specific project UUID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Add a DPGF template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"trade_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"slice_name\":\"architecto\",\"budget\":4326.41688}" }, "description": "Add a DPGF template to a project, or add a slice if a template already exists for the trade." }, "response": [] }, { "name": "Get a DPGF template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates\/:templateId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates\/:templateId", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "templateId", "key": "templateId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a DPGF template with its associated contractor documents." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Delete a DPGF template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates\/:templateId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates\/:templateId", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "templateId", "key": "templateId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a DPGF template from a project, or delete a slice if the template is of type \"slice\"." }, "response": [] }, { "name": "Invite contractors to a template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates\/:templateId\/contractors", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates\/:templateId\/contractors", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "templateId", "key": "templateId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contractors\":[{\"name\":\"architecto\",\"email\":\"architecto\"}]}" }, "description": "Invite a list of contractors into a project trade template." }, "response": [] }, { "name": "Download a contractor document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/projects\/:projectId\/templates\/:templateId\/documents\/:documentId\/download\/:version", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/projects\/:projectId\/templates\/:templateId\/documents\/:documentId\/download\/:version", "variable": [ { "id": "projectId", "key": "projectId", "value": "architecto", "description": "" }, { "id": "templateId", "key": "templateId", "value": "architecto", "description": "" }, { "id": "documentId", "key": "documentId", "value": "architecto", "description": "" }, { "id": "version", "key": "version", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get download URLs for a specific contractor document version within a project template. Returns available versions if none specified." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] } ] }, { "name": "Organizations", "description": "", "item": [ { "name": "List organizations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/organizations", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/organizations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List architect organizations accessible to the authenticated user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "List organizations for a user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/organizations\/users\/:userId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/organizations\/users\/:userId", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List architect organizations accessible to a specific user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Switch active organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/organizations\/switch", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/organizations\/switch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"organization_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"}" }, "description": "Switch the authenticated user's active organization." }, "response": [] }, { "name": "Get an organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/organizations\/:organizationId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/organizations\/:organizationId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get an architect organization by its UUID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Get organization headquarters", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/organizations\/headquarters\/:organizationId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/organizations\/headquarters\/:organizationId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the headquarters associated with an organization." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] } ] }, { "name": "Contractors", "description": "", "item": [ { "name": "Get a contractor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/contractors\/:contractorId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/contractors\/:contractorId", "variable": [ { "id": "contractorId", "key": "contractorId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a contractor from the current organization's directory." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] } ] }, { "name": "Trades", "description": "", "item": [ { "name": "List trade lists", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/trades\/list", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/trades\/list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List trade list templates accessible to the authenticated user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Get a trade list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/trades\/list\/:tradeListId", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/trades\/list\/:tradeListId", "variable": [ { "id": "tradeListId", "key": "tradeListId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a trade list with all its associated trades." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] } ] }, { "name": "Tools", "description": "", "item": [ { "name": "Convert IDs to UUIDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/tools\/ids-to-uuids", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/tools\/ids-to-uuids" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[[\"bngzmiyvdljnikhwa\"]]}" }, "description": "Convert a list of MongoDB IDs to their corresponding UUIDs." }, "response": [] } ] }, { "name": "PFo User Roles", "description": "", "item": [ { "name": "Get PFo roles for a user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/pfo\/:userId\/roles", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/pfo\/:userId\/roles", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the PFo roles currently authorized for a user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Assign a PFo role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/pfo\/:userId\/roles", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/pfo\/:userId\/roles", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Assign a PFo role to a user." }, "response": [] }, { "name": "Remove PFo roles from a user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aos\/v1\/pfo\/:userId\/roles", "query": [], "raw": "{{baseUrl}}\/api\/aos\/v1\/pfo\/:userId\/roles", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove all PFo roles from a user." }, "response": [] } ] }, { "name": "Internal", "description": "", "item": [ { "name": "Get trade categories by name", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/trades\/mapping\/:tradeName", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/trades\/mapping\/:tradeName", "variable": [ { "id": "tradeName", "key": "tradeName", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get trade categories from a trade name." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Get trade categories by AOS ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/trades\/mapping\/AOS\/:tradeId", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/trades\/mapping\/AOS\/:tradeId", "variable": [ { "id": "tradeId", "key": "tradeId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get trade categories from an AOS trade ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Get trade categories by CP ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/trades\/mapping\/CP\/:tradeId", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/trades\/mapping\/CP\/:tradeId", "variable": [ { "id": "tradeId", "key": "tradeId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get trade categories from a CP trade ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "correlation-id", "value": "00060100-0000-4000-8000-000000000000" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"code\":401,\"message\":\"You are not authenticated\"}", "name": "" } ] }, { "name": "Get company contacts by SIRET.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/company\/contacts\/:siret", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/company\/contacts\/:siret", "variable": [ { "id": "siret", "key": "siret", "value": "12345678901234", "description": "The company SIRET code (14 digits)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"siret\":\"82256977549171\"}" }, "description": "Retrieves all contractor organizations matching a given SIRET (fiscal number)\nand returns their users as contacts." }, "response": [ { "header": [], "code": 200, "body": "{\"siret\":\"12345678901234\",\"companies\":[{\"id\":\"550e8400-e29b-41d4-a716-446655440000\",\"name\":\"Acme Corp\",\"contacts\":[{\"first_name\":\"Jean\",\"last_name\":\"Dupont\",\"email\":\"jean@example.com\",\"phone\":\"+33123456789\",\"mobile\":\"+33612345678\"}]}]}", "name": "" }, { "header": [], "code": 400, "body": "{\"message\":\"Invalid SIRET format. Must be 14 digits.\"}", "name": "Invalid SIRET format" }, { "header": [], "code": 404, "body": "{\"siret\":\"12345678901234\",\"message\":\"No contractor organizations found for this SIRET.\",\"data\":[]}", "name": "No organizations found" } ] }, { "name": "Get company trades by SIRET.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/company\/trades\/:siret", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/company\/trades\/:siret", "variable": [ { "id": "siret", "key": "siret", "value": "12345678901234", "description": "The company SIRET code (14 digits)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"siret\":\"82256977549171\"}" }, "description": "Retrieves contractor organizations matching the given SIRET,\nthen resolves their business sectors and trades from DPGF documents\/templates." }, "response": [ { "header": [], "code": 200, "body": "{\"siret\":\"12345678901234\",\"companies\":[{\"id\":\"550e8400-e29b-41d4-a716-446655440000\",\"name\":\"Acme Corp\",\"business_sectors\":[\"Maconnerie\"],\"trades\":[{\"id\":\"660e8400-e29b-41d4-a716-446655440000\",\"name\":\"Electricite\"}]}]}", "name": "" }, { "header": [], "code": 400, "body": "{\"message\":\"Invalid SIRET format. Must be 14 digits.\"}", "name": "Invalid SIRET format" }, { "header": [], "code": 404, "body": "{\"siret\":\"12345678901234\",\"message\":\"No contractor organizations found for this SIRET.\",\"data\":[]}", "name": "No organizations found" } ] }, { "name": "Convert UUIDs to IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/internal\/v1\/tools\/uuids-to-ids", "query": [], "raw": "{{baseUrl}}\/api\/internal\/v1\/tools\/uuids-to-ids" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[[\"bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcp\"]]}" }, "description": "Convert a list of UUIDs to their corresponding MongoDB IDs." }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }