{"info":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","description":"<html><head></head><body><p>This document describes the \"ideal\" Marina Management System (MMS) API for Falco to integrate with. This is not the Falco API.</p>\n<p>In any case, your API may vary and we will adapt, the only important thing is for us to be able to retrieve all the data we need :)</p>\n<p>All the URL format in this document can be adapted and are only provided here for understanding.</p>\n<h1 id=\"technical-requirements\">Technical requirements</h1>\n<p>All request and responses must be secured using TLS&gt;=1.2, signed by a trusted entity (X3 or above)</p>\n<p>The API <em>must</em> be accessible by domain (not IP only).<br><em>Uptime:</em> <em>should</em> be above 99%<br><em>Latency:</em> <em>should</em> be under 1sec for detail route and 5sec for list route</p>\n<h2 id=\"⚠️-important-⚠️\">⚠️ Important ⚠️</h2>\n<p>Each list endpoint should provide a way to list only \"recently modified\" items. For instance we should be able to provide a query parameter to list only items which has been modified since a defined date.</p>\n<p>Example:</p>\n<p>The <code>/contracts/</code> list endpoint can be called with <code>/contracts/?updated_since=2023-02-04T01:20:00</code>or <code>/contracts/?updated_since=2023-02-04T01:20:00-02:00</code></p>\n<p>This will be really helpful to not sync every data everytime.</p>\n<h1 id=\"falcos-architecture\">Falco's architecture</h1>\n<p>To understand why we need these APIs you may want to understand what Falco will do about those information.</p>\n<p>Falco ecosystem is split in several applications:</p>\n<h2 id=\"the-backend-api\">The backend (API)</h2>\n<p>This is the obvious part, we provide API for our own applications. This is also the part which will make request to your API to synchronize data.</p>\n<p><strong>Note:</strong> Not developped yet, but we will also provide webhooks to be notified when something changes on your side. This would prevent too much polling from our side.</p>\n<h2 id=\"the-boater-application\">The boater application</h2>\n<p>This is the mobile application (iOS/Android) for the end user, the boater. They use it to have information or news from the marina.</p>\n<p>In it, they can:</p>\n<ul>\n<li>See the weather predictions</li>\n<li>See their contracts and boats</li>\n<li>For some specific users: renew their contracts or waiting list requests</li>\n<li>...</li>\n</ul>\n<h2 id=\"the-agent-application\">The agent application</h2>\n<p>This is also a mobile application (iOS/Android) for the marina agents. the main use of this application is for agent to see their attributed tickets (or tasks) and manage them.</p>\n<h2 id=\"the-marina-application\">The marina application</h2>\n<p>This is a website, where the marina managers can:</p>\n<ul>\n<li>Manage news content to be displayed on the boater app</li>\n<li>Supervise the spot occupancy</li>\n<li>Supervise the electricity consumption</li>\n<li>Supervise the tickets attribution</li>\n<li>...</li>\n</ul>\n<h1 id=\"modelization\">Modelization</h1>\n<p>No surprise here, as most MMS, the data relations are quite straighforward:</p>\n<ul>\n<li><p>A boater (user) ;</p>\n</li>\n<li><p>A boat ;</p>\n</li>\n<li><p>A slip (or berth) ;</p>\n</li>\n<li><p>A contract which links the customer, the boat and the slip during a time period.</p>\n</li>\n<li><p>An invoice, which can be linked to a contract (or be directly linked to a customer)</p>\n</li>\n</ul>\n<img src=\"https://content.pstmn.io/0f0e2f01-260e-4e6b-b903-7fa7fe0e6348/aW1hZ2UucG5n\" width=\"1189\" height=\"293\">\n\n<p>Each fields for those models will be describe in the endpoint description below.</p>\n<h2 id=\"contract\">Contract</h2>\n<p>There are some specificities for the contract, because, several customers can be linked to it:</p>\n<ul>\n<li>The boat owner</li>\n<li>The boat co-owner</li>\n<li>The boat renter</li>\n<li>Other familly members related to the above</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Technical requirements","slug":"technical-requirements"},{"content":"Falco's architecture","slug":"falcos-architecture"},{"content":"Modelization","slug":"modelization"}],"owner":"13464747","collectionId":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","publishedId":"2s9YsQ89j5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-23T16:31:13.000Z"},"item":[{"name":"/users/","item":[{"name":"List users: Returns a list of users","id":"31a8744c-c1e8-499f-ae2b-22c99bcdd201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/users/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["users",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"7533935a-4059-4eb8-8659-0d15b7c3921a","name":"Response: List of Users","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/users/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": \"a0799326-26a0-0dce-3cb7-43f4ddef568b\",\n    \"phone\": \"nulla in Lorem\",\n    \"email\": \"user@example.com\",\n    \"name\": \"aliquip culpa sint aliqua\",\n    \"birthday\": \"voluptate est ut officia\",\n    \"billing_street_line1\": \"2 main street\",\n    \"billing_street_line2\": \"occ\",\n    \"billing_postal_code\": \"cillum quis Duis consequat est\",\n    \"billing_city\": \"St-Quay\",\n    \"billing_country\": 250,\n    \"last_update\": \"2019-05-18T15:17:00+00:00\",\n    \"contracts\": [\n        {\n        \"id\": \"7d40cd28-bf23-873c-25b8-8d9f6c09ad95\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"db41290b-10ca-e695-1c6a-4865c6348e04\",\n        \"boat\":{\n            \"id\": \"3e35de41-b288-9d90-f406-ea9ca3b5be3e\",\n            \"name\": \"laboris culpa\",\n            \"length\": 93368099.53876378,\n            \"width\": 12450946.003246034,\n            \"draft\": 8409424.98258721,\n            \"brand\": \"consectetur ex\",\n            \"model\": \"id\",\n            \"type\": \"mono-hull, sailboat\",\n            \"registration_number\": \"AW-834-XS\",\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        },\n        \"berth_name\": \"aliqua ullam\",\n        \"date_start\": \"1960-04-08\",\n        \"date_finish\": \"2013-09-14\",\n        \"renewal_campaign_end_date\": \"1947-05-20\",\n        \"price\": 45133667.15803941,\n        \"pdf\": \"minim non dolore Lorem\",\n        \"invoices\": [\n            {\n            \"id\": \"1e5e7846-2613-11ee-9f64-3f194a27e761\",\n            \"amount\": 213.45,\n            \"status\": \"due, paid,...\",\n            \"date_created\": \"2023-01-01\",\n            \"pdf\": \"3bd9e996-2613-11ee-97c3-6b5e372a366f\",\n            \"bill_schedule\": \"4446a916-2613-11ee-a1e7-e39c1cf9651a\",\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n            }\n        ],\n        \"status\": \"inactive, active, renew...\",\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        }\n    ]\n  },\n  {\n    \"id\": \"a7058d97-bd64-c161-2d2d-b5fe66ead90b\",\n    \"phone\": \"proident dolore\",\n    \"email\": \"user_2@example.com\",\n    \"name\": \"aute proident Lorem\",\n    \"birthday\": \"velit\",\n    \"billing_street_line1\": \"2 main street\",\n    \"billing_street_line2\": \"velit Excepteur fugiat Ut\",\n    \"billing_postal_code\": \"Duis tempor esse eiusmod\",\n    \"billing_city\": \"St-Quay\",\n    \"billing_country\": 250,\n    \"contracts\": [],\n    \"last_update\": \"2019-05-18T15:17:00+00:00\"\n  }\n]"},{"id":"9244ca31-6b59-40f2-b5a8-48fb9e1f3c2f","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/users/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"31a8744c-c1e8-499f-ae2b-22c99bcdd201"},{"name":"List users: Returns a list of users by phone number","id":"e16f53b8-f71b-47f1-ac65-7c4b77e96967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/users/?phone=+33684015496","description":"<p>This endpoint allows us to retrieve a user by their phone number, this is required for us to do \"on the fly\" sync when a user tries to connect for the first time on the mobile application. This endpoint may only be called when the user is not already synced in our database.</p>\n<p>The proposition here is to add a query parameter, but it could also be another URL.</p>\n<p>This endpoint should return only one user, but we know it might not always be the case, so if a list with sereval users is returned then we will try to figure out on our side which user is the most probable one we are looking for.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["users",""],"host":["https://themms.com"],"query":[{"description":{"content":"<p>full phone number with internationnal prefix</p>\n","type":"text/plain"},"key":"phone","value":"+33684015496"}],"variable":[]}},"response":[{"id":"58da5e42-cb7c-4a41-86ec-bf2e34b1c3a5","name":"Response: List of Users","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/users/?phone=+33684015496","protocol":"https","host":["themms","com"],"path":["users",""],"query":[{"key":"phone","value":"+33684015496","description":"full phone number with internationnal prefix"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": \"ebf8b29e-f898-00ab-7a65-3b363b43c0c4\",\n    \"phone\": \"+442083661177\",\n    \"email\": \"user@example.com\",\n    \"name\": \"do magna\",\n    \"birthday\": \"do\",\n    \"billing_street_line1\": \"2 main street\",\n    \"billing_street_line2\": \"laboris Duis qui irure\",\n    \"billing_postal_code\": \"occaecat aliquip Duis culpa\",\n    \"billing_city\": \"St-Quay\",\n    \"billing_country\": 250,\n    \"last_update\": \"2019-05-18T15:17:00+00:00\",\n    \"contracts\": [\n        {\n        \"id\": \"7d40cd28-bf23-873c-25b8-8d9f6c09ad95\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"db41290b-10ca-e695-1c6a-4865c6348e04\",\n        \"boat\":{\n            \"id\": \"3e35de41-b288-9d90-f406-ea9ca3b5be3e\",\n            \"name\": \"laboris culpa\",\n            \"length\": 93368099.53876378,\n            \"width\": 12450946.003246034,\n            \"draft\": 8409424.98258721,\n            \"brand\": \"consectetur ex\",\n            \"model\": \"id\",\n            \"type\": \"mono-hull, sailboat\",\n            \"registration_number\": \"AW-834-XS\",\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        },\n        \"berth_name\": \"aliqua ullam\",\n        \"date_start\": \"1960-04-08\",\n        \"date_finish\": \"2013-09-14\",\n        \"renewal_campaign_end_date\": \"1947-05-20\",\n        \"price\": 45133667.15803941,\n        \"pdf\": \"minim non dolore Lorem\",\n        \"invoices\": [\n            {\n            \"id\": \"1e5e7846-2613-11ee-9f64-3f194a27e761\",\n            \"amount\": 213.45,\n            \"status\": \"due, paid,...\",\n            \"date_created\": \"2023-01-01\",\n            \"pdf\": \"3bd9e996-2613-11ee-97c3-6b5e372a366f\",\n            \"bill_schedule\": \"4446a916-2613-11ee-a1e7-e39c1cf9651a\",\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n            }\n        ],\n        \"status\": \"inactive, active, renew...\",\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        }\n    ]\n  }\n]"},{"id":"47a18ef4-83ad-44f2-9ae2-655c3c4311fe","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/users/?phone=684015496&code=+33","host":["https://themms.com"],"path":["users",""],"query":[{"key":"phone","value":"684015496"},{"key":"code","value":"+33"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"e16f53b8-f71b-47f1-ac65-7c4b77e96967"},{"name":"Get user: Returns details about a particular user","id":"fe24097d-b0c1-4994-828a-39929eb27284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/users/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["users",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"cebabc4b-af2c-4fc2-b51e-53f392185af3","description":{"content":"<p>(Required) ID of the user</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"8254aab3-4c1e-4b23-a03e-7c973f524044","name":"Response: Details about a user by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/users/:id/","protocol":"https","host":["themms","com"],"path":["users",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"ebf8b29e-f898-00ab-7a65-3b363b43c0c4\",\n  \"phone\": \"+442083661177\",\n  \"email\": \"user@example.com\",\n  \"name\": \"do magna\",\n  \"birthday\": \"do\",\n  \"billing_street_line1\": \"2 main street\",\n  \"billing_street_line2\": \"laboris Duis qui irure\",\n  \"billing_postal_code\": \"occaecat aliquip Duis culpa\",\n  \"billing_city\": \"St-Quay\",\n  \"billing_country\": 250,\n  \"last_update\": \"2019-05-18T15:17:00+00:00\",\n  \"contracts\": [\n    {\n      \"id\": \"7d40cd28-bf23-873c-25b8-8d9f6c09ad95\",\n      \"type\": \"annual, précaire\",\n      \"port_id\": \"db41290b-10ca-e695-1c6a-4865c6348e04\",\n      \"boat\":{\n        \"id\": \"3e35de41-b288-9d90-f406-ea9ca3b5be3e\",\n        \"name\": \"laboris culpa\",\n        \"length\": 93368099.53876378,\n        \"width\": 12450946.003246034,\n        \"draft\": 8409424.98258721,\n        \"brand\": \"consectetur ex\",\n        \"model\": \"id\",\n        \"type\": \"mono-hull, sailboat\",\n        \"registration_number\": \"AW-834-XS\",\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n      },\n      \"berth_name\": \"aliqua ullam\",\n      \"date_start\": \"1960-04-08\",\n      \"date_finish\": \"2013-09-14\",\n      \"renewal_campaign_end_date\": \"1947-05-20\",\n      \"price\": 45133667.15803941,\n      \"pdf\": \"minim non dolore Lorem\",\n      \"invoices\": [\n        {\n          \"id\": \"1e5e7846-2613-11ee-9f64-3f194a27e761\",\n          \"amount\": 213.45,\n          \"status\": \"due, paid,...\",\n          \"date_created\": \"2023-01-01\",\n          \"pdf\": \"3bd9e996-2613-11ee-97c3-6b5e372a366f\",\n          \"bill_schedule\": \"4446a916-2613-11ee-a1e7-e39c1cf9651a\",\n          \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        }\n      ],\n      \"status\": \"inactive, active, renew...\",\n      \"last_update\": \"2019-05-18T15:17:00+00:00\"\n    }\n  ]\n}"},{"id":"d52709e2-96b5-4e06-b3ff-f73acf89c13d","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/users/:id/","host":["https://themms.com"],"path":["users",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the user"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"fe24097d-b0c1-4994-828a-39929eb27284"},{"name":"Update user: Update details about a particular user","id":"d6176be4-c258-431c-a85f-28be79d831fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@email.com\",\n  \"billing_street_line1\": \"2 main street\",\n  \"billing_street_line2\": \"id in cillum\",\n  \"billing_postal_code\": \"sint\",\n  \"billing_city\": \"St-Quay\",\n  \"billing_country\": 250\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/users/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["users",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"dc0c8fd8-61bc-45e7-8ac5-5699c675dda4","description":{"content":"<p>(Required) ID of the user</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"158dda1b-d4bf-40b9-a0e7-46f3e4648f0d","name":"Response: Details about a user by ID","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@email.com\",\n  \"billing_street_line1\": \"2 main street\",\n  \"billing_street_line2\": \"id in cillum\",\n  \"billing_postal_code\": \"sint\",\n  \"billing_city\": \"St-Quay\",\n  \"billing_country\": 250\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/users/:id/","protocol":"https","host":["themms","com"],"path":["users",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"1ae13575-925a-a32d-b152-79c5ae3d7d62\",\n  \"phone\": \"nulla Lorem\",\n  \"email\": \"user@email.com\",\n  \"name\": \"nisi sit ut\",\n  \"birthday\": \"magna ullamco sint deserunt est\",\n  \"billing_street_line1\": \"2 main street\",\n  \"billing_street_line2\": \"\",\n  \"billing_postal_code\": \"ut enim\",\n  \"billing_city\": \"St-Quay\",\n  \"billing_country\": 250,\n  \"last_update\": \"2019-05-18T15:17:00+00:00\"\n}"},{"id":"d8071ddc-1ad9-44e4-8a2e-13e048d31a88","name":"Unexpected error","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"email\": \"user@email.com\",\n  \"billing_street_line1\": \"2 main street\",\n  \"billing_street_line2\": \"id in cillum\",\n  \"billing_postal_code\": \"sint\",\n  \"billing_city\": \"St-Quay\",\n  \"billing_country\": 250\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/users/:id/","host":["https://themms.com"],"path":["users",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the user"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"d6176be4-c258-431c-a85f-28be79d831fe"}],"id":"827f8ec0-c416-4318-99b0-ab88612d781a","description":"<p>This endpoint allows us to list/retrive/update users information.</p>\n<p>It is used for several contexts:</p>\n<ul>\n<li>Full sync of all users of the marina to maintain sync between our data and yours</li>\n<li>Specific sync of a user at their first connection on the boater application (see get user by phone)</li>\n<li>Specific sync of a user at each connection on the boater application (see get user details)</li>\n</ul>\n<h2 id=\"important\">Important</h2>\n<p>If your database stores data from several marina, we need to be able to filter lists to only access users from a specific marina. This could be achieve by addind a query param (such as <code>?marina_id=123</code>) or directly in the URL (like <code>/marina/123/users/</code>).</p>\n<h2 id=\"required-data\">Required data</h2>\n<p>Some data are mandatory:</p>\n<ul>\n<li>ID (unique identifier in your database for later sync)</li>\n<li>First name</li>\n<li>Last name</li>\n<li>Phone (to be able to connect to the boater application)</li>\n<li>Related contracts</li>\n</ul>\n<p><strong>Note:</strong> \"Related contracts\" should either be only a list of IDs or the full serialization of contracts data as provided by the \"contracts\" endpoint. The full serialization is quite helpful to prevent several requests, at least for:</p>\n<ul>\n<li>list users by phone number</li>\n<li>get user details</li>\n</ul>\n<h2 id=\"optionnal-data\">Optionnal data</h2>\n<ul>\n<li>Email</li>\n<li>Birthdate</li>\n<li>Address (street, city, zipcode, country)</li>\n</ul>\n","_postman_id":"827f8ec0-c416-4318-99b0-ab88612d781a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/boats/","item":[{"name":"Get boat: Returns details about a particular boat","id":"66bf7166-b8ce-4b38-9cda-c287a68b67cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/boats/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["boats",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"86fa276c-7502-4fef-8a99-925718416f99","description":{"content":"<p>(Required) ID of the boat</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"8a16933b-7401-41a1-a490-e4e8ca71fd3e","name":"Response: Details about a boat by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/boats/:id/","protocol":"https","host":["themms","com"],"path":["boats",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the boat"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"23543f42-1804-d9f2-51d0-24a7d7734f62\",\n  \"name\": \"ea tempor adipisicing\",\n  \"length\": 46166554.72248523,\n  \"width\": 5819544.345050254,\n  \"draft\": 73172188.60829969,\n  \"brand\": \"mollit\",\n  \"model\": \"aliquip fugiat eiusmod\",\n  \"type\": \"mono-hull, sailboat\",\n  \"registration_number\": \"AW-834-XS\",\n  \"last_update\": \"2019-05-18T15:17:00+00:00\"\n}"},{"id":"8d9b54b5-985e-40ec-af6d-562eabef3f30","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/boats/:id/","host":["https://themms.com"],"path":["boats",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the boat"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"66bf7166-b8ce-4b38-9cda-c287a68b67cb"},{"name":"Update boat: Update details about a particular boat","id":"0badcc59-5487-4d31-b5e5-15d5031be006","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"ea tempor adipisicing\",\n    \"length\": 46166554.72248523,\n    \"width\": 5819544.345050254,\n    \"draft\": 73172188.60829969,\n    \"brand\": \"mollit\",\n    \"model\": \"aliquip fugiat eiusmod\",\n    \"type\": \"mono-hull, sailboat\",\n    \"registration_number\": \"AW-834-XS\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/boats/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["boats",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"75d13525-ca40-4806-ab8d-d79125f2ddb5","type":"any","value":null,"key":"id"}]}},"response":[{"id":"d366425f-7fcb-44b1-98a1-8160b87d21ce","name":"Response: Details about a boat by ID","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/boats/:id/","protocol":"https","host":["themms","com"],"path":["boats",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the boat"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"23543f42-1804-d9f2-51d0-24a7d7734f62\",\n  \"name\": \"ea tempor adipisicing\",\n  \"length\": 46166554.72248523,\n  \"width\": 5819544.345050254,\n  \"draft\": 73172188.60829969,\n  \"brand\": \"mollit\",\n  \"model\": \"aliquip fugiat eiusmod\",\n  \"type\": \"mono-hull, sailboat\",\n  \"registration_number\": \"AW-834-XS\",\n  \"last_update\": \"2019-05-18T15:17:00+00:00\"\n}"},{"id":"f5bab24f-cc74-40e4-9a2f-a162a57c073e","name":"Unexpected error","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/boats/:id/","host":["https://themms.com"],"path":["boats",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the boat"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"0badcc59-5487-4d31-b5e5-15d5031be006"}],"id":"d3f29be4-ba55-4753-8930-79bdeaecb8d4","description":"<p>This endpoint allows us to get fresh information about a boat and allows boater to update some information from the boater application.</p>\n<p>For the moment we don't need a list endpoint for boats as we will gather the information from the <code>/contracts/</code> endpoint. Still, if available, we will surely use the list endpoint to sync the boats before syncing contracts.</p>\n","_postman_id":"d3f29be4-ba55-4753-8930-79bdeaecb8d4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/contracts/","item":[{"name":"List contracts: Returns a list of contracts","id":"a95cd1de-c415-4030-b25c-5099d98220c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/contracts/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["contracts",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"541316f5-90a1-409d-a59d-7191a1ed3f34","name":"Response: List of contracts","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/contracts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"c66d9e50-2577-11ee-acaa-f381fd72e8c0\",\n        \"name\": \"Annual, ...\",\n        \"number\": \"contract_id\",\n        \"date_start\": \"2022-08-11\",\n        \"date_finish\": \"2023-08-10\",\n        \"user\": {\n            \"id\": \"user_id\",\n            \"last_name\": \"Doe\",\n            \"first_name\": \"John\",\n            \"email\": \"jdoe@example.com\",\n            \"landline_phone\": null,\n            \"mobile_phone\": \"+442083661177\",\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        },\n        \"boat\": {\n            \"id\": \"8188f8f2-2577-11ee-9c11-7b868285f82b\",\n            \"name\": \"Boat name\",\n            \"length\": 20.5,\n            \"width\": 4.8,\n            \"water_draft\": 12.546,\n            \"model\": \"Boat model\",\n            \"brand\": \"Boat brand\",\n            \"type\": \"mono-hull, sailboat, ...\",\n            \"registration_number\": \"124 XP 45\",\n            \"pictures\": [\n                \"https://picsum.photos/200\"\n            ],\n            \"passeport_escales_number\": null,\n            \"last_update\": \"2019-05-18T15:17:00+00:00\"\n        },\n        \"invoice_id\": \"be263afe-2577-11ee-bf34-b7d18ca7f320\",\n        \"id_port_external_mms\": \"port_id\",\n        \"status\": \"inactive, active, renew...\",\n        \"pdf_id\": \"f0acd280-2577-11ee-b9a3-b3daed8ee39f\",\n        \"spot\": \"Slip AB05\",\n        \"amount\": 1056.50,\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n    }\n]"},{"id":"a442cd85-9a2e-4819-bef9-f24b4c986a7f","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/contracts/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"a95cd1de-c415-4030-b25c-5099d98220c5"},{"name":"Get contract: Returns details about a particular contract","id":"6a93e4c0-143f-4ea3-b26b-b1e9aad1629b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/contracts/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["contracts",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"7edb0b60-0c9c-4958-b6f9-39058c77bb07","description":{"content":"<p>(Required) ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"5d063577-dcb9-456d-aae3-f64b44a502db","name":"Response: Details about a contract by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/contracts/:id/","protocol":"https","host":["themms","com"],"path":["contracts",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"c66d9e50-2577-11ee-acaa-f381fd72e8c0\",\n    \"name\": \"Annual, ...\",\n    \"number\": \"contract_id\",\n    \"date_start\": \"2022-08-11\",\n    \"date_finish\": \"2023-08-10\",\n    \"user\": {\n        \"id_external\": \"user_id\",\n        \"last_name\": \"Doe\",\n        \"first_name\": \"John\",\n        \"email\": \"jdoe@example.com\",\n        \"landline_phone\": null,\n        \"mobile_phone\": \"+442083661177\",\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n    },\n    \"boat\": {\n        \"id\": \"8188f8f2-2577-11ee-9c11-7b868285f82b\",\n        \"name\": \"Boat name\",\n        \"length\": 20.5,\n        \"width\": 4.8,\n        \"water_draft\": 12.546,\n        \"model\": \"Boat model\",\n        \"brand\": \"Boat brand\",\n        \"type\": \"mono-hull, sailboat, ...\",\n        \"registration_number\": \"124 XP 45\",\n        \"pictures\": [\n            \"https://picsum.photos/200\"\n        ],\n        \"passeport_escales_number\": null,\n        \"last_update\": \"2019-05-18T15:17:00+00:00\"\n    },\n    \"invoice_id\": \"be263afe-2577-11ee-bf34-b7d18ca7f320\",\n    \"id_port_external_mms\": \"port_id\",\n    \"status\": \"inactive, active, renew...\",\n    \"pdf_id\": \"f0acd280-2577-11ee-b9a3-b3daed8ee39f\",\n    \"spot\": \"Slip AB05\",\n    \"amount\": 1056.50,\n    \"last_update\": \"2019-05-18T15:17:00+00:00\"\n}"},{"id":"70bf7e0a-30d4-4b3a-bd12-9108226e8a31","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/contracts/:id/","host":["https://themms.com"],"path":["contracts",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"6a93e4c0-143f-4ea3-b26b-b1e9aad1629b"},{"name":"Renew contract: Accept a contract renewal","id":"d1356e7e-5b8f-47e4-8190-73fcd310102b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"payment\": \"x10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/contracts/:id/renew/accept/","description":"<p>This endpoint is only required for \"contract renewal\" feature.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["contracts",":id","renew","accept",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"0a069cab-fbf2-4b93-8cc9-d66ad60a018d","description":{"content":"<p>(Required) ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"ca561ad7-37b6-46f6-b620-2cc1dc544f66","name":"Response: Details about a contract by ID","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"Boat sold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/terminate/","protocol":"https","host":["themms","com"],"path":["contracts",":id","terminate",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"b7d56c77-7020-4f70-a343-c26459683a73","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"Boat sold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/terminate/","host":["https://themms.com"],"path":["contracts",":id","terminate",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"d1356e7e-5b8f-47e4-8190-73fcd310102b"},{"name":"Renew contract: Refuse a contract renewal","id":"f08f3925-208d-42cc-8010-ae67b05063f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"Boat sold\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/contracts/:id/renew/refuse/","description":"<p>This endpoint is only required for \"contract renewal\" feature.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["contracts",":id","renew","refuse",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"0a069cab-fbf2-4b93-8cc9-d66ad60a018d","description":{"content":"<p>(Required) ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"f34be464-f25b-48a2-be5c-2c0b633e5a17","name":"Response: Details about a contract by ID","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"Boat sold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/terminate/","protocol":"https","host":["themms","com"],"path":["contracts",":id","terminate",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"c0435e7b-970c-4b56-a0a9-3672c1804ce9","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"Boat sold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/terminate/","host":["https://themms.com"],"path":["contracts",":id","terminate",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"f08f3925-208d-42cc-8010-ae67b05063f1"},{"name":"Add Comment: Add a new comment on a particular contract","id":"18189f21-9a86-47ef-a117-09defac3aa2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"aute cillum adipisicing occaecat exercitation\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/contracts/:id/comments/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["contracts",":id","comments",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"02dd24ce-5c89-4bf2-9ad0-265070ec4ce3","description":{"content":"<p>(Required) ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"8700f8fe-d472-4ecb-9849-4fefb1b8fd18","name":"Response: Details about a contract by ID","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"aute cillum adipisicing occaecat exercitation\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/comments/","protocol":"https","host":["themms","com"],"path":["contracts",":id","comments",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"payload\": \"aute cillum adipisicing occaecat exercitation\"\n}"},{"id":"bc76b849-359b-4fa0-9eac-ea5a2898fa52","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"payload\": \"aute cillum adipisicing occaecat exercitation\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/contracts/:id/comments/","host":["https://themms.com"],"path":["contracts",":id","comments",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the contract"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"18189f21-9a86-47ef-a117-09defac3aa2f"}],"id":"69ac1b8d-209c-402b-89d5-e5e802d9d4c3","description":"<p>This allows to sync all the contracts information.</p>\n<p>Several scenarios here:</p>\n<ul>\n<li><p>Your MMS allows only one user per contract, the owner. Then this is straightforward, the user's data are provided through the <code>user</code> attribute, as the examples below.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">      \"user\": {\n        \"id\": \"1e5e7846-2613-11ee-9f64-3f194a27e761\",\n        ...\n      }\n\n</code></pre>\n</li>\n<li><p>Your MMS allows several user for a single contract, the you must use the <code>users</code> attribute (instead of <code>user</code>) to provide a list of users along with their role (<code>owner</code>, <code>co-owner</code>, <code>renter</code>, <code>family</code>).</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">      \"users\": [\n        {\n          \"id\": \"1e5e7846-2613-11ee-9f64-3f194a27e761\",\n          ...\n          \"role\": \"owner\",\n        },\n        {\n          \"id\": \"f46a60ae-2621-11ee-a2c6-0b58b129d948\",\n          ...\n          \"role\": \"co-owner\",\n        }\n      ]\n\n</code></pre>\n</li>\n</ul>\n<p>The provided URLs may also allow the boater to renew their contract during renewal campaign. But this topic should be addressed together to adapt to custom needs.</p>\n","_postman_id":"69ac1b8d-209c-402b-89d5-e5e802d9d4c3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/berths/","item":[{"name":"List berths: Returns the list of Berths","id":"dcdac345-26c2-43e8-87a0-76ef09dbca52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/berths/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["berths",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"eef4885d-224e-4494-9d05-b634d857f641","name":"Response: List of Berths and their associated data","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/berths/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": \"cbefe932-f512-f1ed-7132-4687a4afdcd8\",\n    \"name\": \"nulla cillum et dolor anim\",\n    \"length\": 58658737.00857715,\n    \"occupied\": false,\n    \"last_update\": \"1954-01-22\",\n    \"contracts\": [\n      {\n        \"id\": \"596ced87-59a9-eaf7-a160-477a5dae4f22\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"bfc09ea4-0714-bb8d-4601-a7d73c60f207\",\n        \"date_start\": \"1968-05-08\",\n        \"date_finish\": \"1994-10-06\",\n        \"price\": 70437204.54385035,\n        \"status\": \"inactive, active, renew...\",\n        \"departures\": [\n          {\n            \"id\": \"ebf8b29e-f898-00ab-7a65-3b363b43c0cc\",\n            \"date_start\": \"2024-05-08\",\n            \"date_finish\": \"2024-05-10\",\n            \"reason\": \"travel\"\n          }\n        ],\n        \"users\": [\n          {\n            \"id\": \"ebf8b29e-f898-00ab-7a65-3b363b43c0c4\",\n            \"phone\": \"+33686868686\",\n            \"email\": \"user@email.com\",\n            \"first_name\": \"firstname\",\n            \"last_name\": \"lastname\"\n          }\n        ]\n      },\n      {\n        \"id\": \"urn:uuid:32a99d0a-4dd1-9f41-2873-343f44af2acd\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"0283bcc8-a568-6719-49aa-67c6fd97477c\",\n        \"date_start\": \"1979-11-01\",\n        \"date_finish\": \"1974-01-11\",\n        \"price\": 95035889.65927167,\n        \"status\": \"inactive, active, renew...\",\n        \"departures\": [\n        ],\n        \"users\": [\n        ]\n      }\n    ]\n  },\n  {\n    \"id\": \"urn:uuid:408b92b0-d6ea-234d-2a2e-46fc61421b5a\",\n    \"name\": \"et\",\n    \"length\": 47491623.01893408,\n    \"occupied\": false,\n    \"last_update\": \"1979-10-25\",\n    \"contracts\": [\n      {\n        \"id\": \"urn:uuid:769422ff-8507-ec95-e562-1b509dee1c1f\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"b26e264b-fcf3-f0a0-7a66-3a022f6b1270\",\n        \"date_start\": \"1998-03-16\",\n        \"date_finish\": \"1987-12-22\",\n        \"price\": 71369073.01971874,\n        \"status\": \"inactive, active, renew...\",\n        \"departures\": [\n        ],\n        \"users\": [\n        ]\n      },\n      {\n        \"id\": \"a52f791b-db8a-45b5-389c-96680f5dad62\",\n        \"type\": \"annual, précaire\",\n        \"port_id\": \"urn:uuid:3bb5dcbe-9b4e-be7c-be9a-1408aa7ffecf\",\n        \"date_start\": \"1968-07-05\",\n        \"date_finish\": \"2022-05-01\",\n        \"price\": 63360663.133374564,\n        \"status\": \"inactive, active, renew...\",\n        \"departures\": [\n         \n        ],\n        \"users\": [\n         \n        ]\n      }\n    ]\n  }\n]"},{"id":"1a6b6109-3ed0-4ba5-b168-84eac081bf1e","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/berths/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"dcdac345-26c2-43e8-87a0-76ef09dbca52"},{"name":"Get berth: Returns details about a particular Berth","id":"c00e496c-bad6-42e3-9d61-c152a9d4c008","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/berths/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["berths",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"0dc70474-820a-40e6-bf85-ba19a1dc7009","description":{"content":"<p>(Required) ID of the berth</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"0af71e42-825e-4298-aec9-0214a44812ab","name":"Response: Details about a berth by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/berths/:id/","host":["https://themms.com"],"path":["berths",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the berth"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"303b3ad6-07cd-1e30-72a0-b0466af346c8\",\n  \"name\": \"adipisicing incididunt voluptate\",\n  \"length\": 85074119.75452219,\n  \"port_id\": \"88e6adf4-b6db-b723-1162-a8bfcd0edf23\"\n}"},{"id":"a15920e4-b0d2-4ffa-87c5-4e848b1f0640","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/berths/:id/","host":["https://themms.com"],"path":["berths",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the berth"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"c00e496c-bad6-42e3-9d61-c152a9d4c008"}],"id":"bcac2ddd-306c-436c-8d52-2f927e81ee80","description":"<p>This allows us to sync all the slips (also called berths) whether there is a contract on it or not.</p>\n<p>The payloads can be simplified compared to the example provided, as the contract information will be fetch from the <code>/contracts/</code> endpoint and the departures from the <code>/departures/</code> endpoint.</p>\n","_postman_id":"bcac2ddd-306c-436c-8d52-2f927e81ee80","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/departures/","item":[{"name":"List departures: Returns the list of departures","id":"0bae53b7-2978-497a-b109-2dee6747ec5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/departures/?contract_or_boat=e0306a41-77d8-44e8-bef3-5c320224f793","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["departures",""],"host":["https://themms.com"],"query":[{"description":{"content":"<p>The boat identifier (might e a contrac identifier)</p>\n","type":"text/plain"},"key":"contract_or_boat","value":"e0306a41-77d8-44e8-bef3-5c320224f793"}],"variable":[]}},"response":[{"id":"856a2efe-7e26-41a5-b1c1-37544ac61cc1","name":"Response: List of departures","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/departures/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": \"f46a60ae-2621-11ee-a2c6-0b58b129d948\",\n    \"boat\": \"boat_id_from_mms\",\n    \"start_date\": \"2023-07-19\",\n    \"end_date\": \"2023-07-29\",\n    \"motive\": \"cruising,temporary,other\"\n  },\n  {\n    \"id\": \"27bafe0a-2622-11ee-8dd8-cbbb9ff4d1dc\",\n    \"boat\": \"other_boat_id_from_mms\",\n    \"start_date\": \"2023-07-09\",\n    \"end_date\": \"2023-07-12\",\n    \"motive\": \"cruising,temporary,other\"\n  }\n]"},{"id":"633c8ff9-862d-4809-bd72-3063ca059aaa","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/departures/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"0bae53b7-2978-497a-b109-2dee6747ec5a"},{"name":"Get departure: Returns details about a particular departure","id":"70b2c885-f2fc-454e-8588-d13c0bff1ae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/departures/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["departures",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"b24f6a31-9882-428b-8d3d-8a3e55bd7e38","description":{"content":"<p>The departure identifier</p>\n","type":"text/plain"},"type":"any","value":"4e9bde97-56c7-4b69-97a4-d289c2d224d2","key":"id"}]}},"response":[{"id":"970fc08f-53b5-4744-9289-710bf9056e55","name":"Response: Details about a departure by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/departures/:id/","host":["https://themms.com"],"path":["departures",":id",""],"variable":[{"key":"id","value":"f46a60ae-2621-11ee-a2c6-0b58b129d948","description":"(Required) ID of the departure"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"f46a60ae-2621-11ee-a2c6-0b58b129d948\",\n    \"boat\": \"boat_id_from_mms\",\n    \"start_date\": \"2023-07-19\",\n    \"end_date\": \"2023-07-29\",\n    \"motive\": \"cruising,temporary,other\"\n}"},{"id":"68aacf9a-7288-46d3-90de-1bf7fa5fd29b","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/departures/:id/","host":["https://themms.com"],"path":["departures",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the berth"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"70b2c885-f2fc-454e-8588-d13c0bff1ae8"},{"name":"Update departure","id":"159b54aa-d94c-4182-8e96-be87fb02bb54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"start_date\": \"2023-07-19\",\n  \"end_date\": \"2023-07-29\",\n  \"motive\": \"cruising,temporary,other\"\n}"},"url":"https://themms.com/departures/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["departures",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"a4438ae9-d473-4792-918d-48a136024483","description":{"content":"<p>The departure identifier</p>\n","type":"text/plain"},"type":"any","value":"4e9bde97-56c7-4b69-97a4-d289c2d224d2","key":"id"}]}},"response":[{"id":"e77e0bf7-82d1-4825-9682-ce77fa8a03a6","name":"Response: Details about a departure by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"start_date\": \"2023-07-19\",\n  \"end_date\": \"2023-07-29\",\n  \"motive\": \"cruising,temporary,other\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/departures/:id/","host":["https://themms.com"],"path":["departures",":id",""],"variable":[{"key":"id","value":"f46a60ae-2621-11ee-a2c6-0b58b129d948","description":"(Required) ID of the departure"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"f46a60ae-2621-11ee-a2c6-0b58b129d948\",\n    \"boat\": \"boat_id_from_mms\",\n    \"start_date\": \"2023-07-19\",\n    \"end_date\": \"2023-07-29\",\n    \"motive\": \"cruising,temporary,other\"\n}"},{"id":"c8eb5ef1-a2af-400e-a85d-ba683e513c17","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/departures/:id/","host":["https://themms.com"],"path":["departures",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the berth"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"159b54aa-d94c-4182-8e96-be87fb02bb54"},{"name":"New departure: Create a new departure as requested by boater","id":"23c83a95-402b-4f22-a59c-01e61e5ba135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"boat\": \"boat_id_from_mms\",\n  \"start_date\": \"2023-07-19\",\n  \"end_date\": \"2023-07-29\",\n  \"motive\": \"cruising,temporary,other\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/departures/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["departures",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"3272d41f-5420-499d-911f-7e9c4a3a724b","name":"Response: List of Berths and their associated data Copy","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"boat\": \"boat_id_from_mms\",\n  \"start_date\": \"2023-07-19\",\n  \"end_date\": \"2023-07-29\",\n  \"motive\": \"cruising,temporary,other\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/berths/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"f46a60ae-2621-11ee-a2c6-0b58b129d948\",\n    \"boat\": \"boat_id_from_mms\",\n    \"start_date\": \"2023-07-19\",\n    \"end_date\": \"2023-07-29\",\n    \"motive\": \"cruising,temporary,other\"\n}"}],"_postman_id":"23c83a95-402b-4f22-a59c-01e61e5ba135"}],"id":"44f7c1d0-0411-459a-809d-1060d31694c6","description":"<p>This allows us to sync all the declared departures (ie when the boater declares to leave their slip for a certain amount of time).</p>\n<p>According to MMS the departure can be linked to a boat or a contract, we will need to define this together (as we can manage both, but <strong>the contract is more convenient</strong> as it also links the boat to a spot).</p>\n","_postman_id":"44f7c1d0-0411-459a-809d-1060d31694c6","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/fuel/","item":[{"name":"Get Fuel: Returns details about fuel prices","id":"1ebd6d22-bdb6-444f-8654-fbe5cc0c02e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/fuel/","description":"<p>Allow to retrieve the list of fuel prices to be able to display them to the boater.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["fuel",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"c29f6ba9-f1f0-432a-9bb3-930bdd6ce082","name":"Response: Returns details about fuel prices","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":"https://themms.com/fuel/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"3542da56-b189-4d0c-99b4-482549ca03a5\",\n        \"last_updated\": \"2019-05-18T15:17:00+00:00\",\n        \"name\": \"gazole\",\n        \"price\": 1200,\n        \"unit\": \"litre\"\n    },\n    {\n        \"id\": \"d2e2551f-0e0d-4624-9c11-afc65eecfb11\",\n        \"last_updated\": \"2019-05-18T15:17:00+00:00\",\n        \"name\": \"better gazole\",\n        \"price\": 1200,\n        \"unit\": \"barrel\"\n    }\n]"},{"id":"a2cac303-dff0-4744-8a3a-866a00ef4ba1","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/insurances/:boat_id/","host":["https://themms.com"],"path":["insurances",":boat_id",""],"variable":[{"key":"boat_id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the associated boat"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"1ebd6d22-bdb6-444f-8654-fbe5cc0c02e2"}],"id":"8dd8541b-7564-4c5b-bfac-e3868c907abd","description":"<p>Endpoints for fuel management</p>\n","_postman_id":"8dd8541b-7564-4c5b-bfac-e3868c907abd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/invoices/","item":[{"name":"Get invoice: Returns details about a particular invoice","id":"c2839dc4-378a-47d7-a660-e13655f84091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/invoices/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["invoices",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"765222b5-9ed6-4bfc-9f88-61628a5d3b16","description":{"content":"<p>(Required) ID of the invoice</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"181ad282-bca7-43ad-8825-d8987a57c301","name":"Response: Details about an invoice by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/invoices/:id/","protocol":"https","host":["themms","com"],"path":["invoices",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"pdf_link\": \"\",\n    \"amount\": 12200,\n    \"contract_id\": \"mms_id\"\n}"},{"id":"b1415a91-746c-4ef7-9353-dd05ebeb9f4f","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/invoices/:id/","host":["https://themms.com"],"path":["invoices",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the invoice"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"c2839dc4-378a-47d7-a660-e13655f84091"},{"name":"Get invoice's PDF: Returns the PDF file attached to an invoice","id":"5d146258-4a5c-401e-aa15-8c5a304dfc20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/invoices/:id/pdf/","description":"<p>This endpoint allows us to retrieve the invoice PDF file</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["invoices",":id","pdf",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"765222b5-9ed6-4bfc-9f88-61628a5d3b16","description":{"content":"<p>(Required) ID of the invoice</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"afd5c22c-7afa-480e-abf4-3af104d902ef","name":"Response: Invoice's PDF","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/invoices/:id/","host":["https://themms.com"],"path":["invoices",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"50d11821-e7ce-4c84-8d95-58826937d529","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/invoices/:id/","host":["https://themms.com"],"path":["invoices",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the invoice"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"5d146258-4a5c-401e-aa15-8c5a304dfc20"}],"id":"210f3880-6811-432d-aa5b-93c91e4a8ced","description":"<p>These endpoints allow invoices sync. While the contract's invoice is provided by the <code>/contracts/</code> endpoint, other invoices might be displayed on the boater application (not implemented yet).</p>\n","_postman_id":"210f3880-6811-432d-aa5b-93c91e4a8ced","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/insurances/","item":[{"name":"Get insurance: Returns details about a particular insurance","id":"e84fa686-7219-4852-9078-2abb950360a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/insurances/:boat_id/","description":"<p>This endpoint is only required for \"contract renewal\" feature.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["insurances",":boat_id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"eb491be9-131e-466a-8698-b1fa66868590","description":{"content":"<p>(Required) ID of the associated boat</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"boat_id"}]}},"response":[{"id":"0e08cc0f-0e0b-4fce-86fb-b9b6da267143","name":"Response: Details about an insurance by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/insurances/:boat_id/","host":["https://themms.com"],"path":["insurances",":boat_id",""],"variable":[{"key":"boat_id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the associated boat"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"insurance_company\": \"ALLIANZ\",\n  \"policy_number\": \"cupidatat\",\n  \"date_of_validity\": \"1961-12-24\",\n  \"insured_amount\": 90299000.60385844,\n  \"url\": \"https://wefalco.com/images/image-id.png\"\n}"},{"id":"c3697272-8919-446e-aa9d-af7b8407f4a7","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/insurances/:boat_id/","host":["https://themms.com"],"path":["insurances",":boat_id",""],"variable":[{"key":"boat_id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the associated boat"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"e84fa686-7219-4852-9078-2abb950360a4"},{"name":"Update insurance: Update an insurance by ID","id":"51ad89b0-95bb-4d81-9b3b-980f23cf3464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"insurance_company\": \"ALLIANZ\",\n  \"policy_number\": \"cupidatat\",\n  \"date_of_validity\": \"1961-12-24\",\n  \"insured_amount\": 90299000.60385844,\n  \"url\": \"https://wefalco.com/images/image-id.png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/insurances/:boat_id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["insurances",":boat_id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"a46f4ea1-44cf-4dcb-86d7-8c393bbf3b80","description":{"content":"<p>(Required) ID of the insurance</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"boat_id"}]}},"response":[{"id":"b1bfad40-1a45-47ad-a000-31247e2e2a0f","name":"Response: Details about an insurance by ID","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"insurance_company\": \"ALLIANZ\",\n  \"policy_number\": \"cupidatat\",\n  \"date_of_validity\": \"1961-12-24\",\n  \"insured_amount\": 90299000.60385844,\n  \"url\": \"https://wefalco.com/images/image-id.png\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/insurances/:boat_id/","host":["https://themms.com"],"path":["insurances",":boat_id",""],"variable":[{"key":"boat_id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the insurance"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"insurance_company\": \"ALLIANZ\",\n  \"policy_number\": \"cupidatat\",\n  \"date_of_validity\": \"1961-12-24\",\n  \"insured_amount\": 90299000.60385844,\n  \"url\": \"https://wefalco.com/images/image-id.png\"\n}"},{"id":"fba88e8a-13fb-4e65-b808-22beca8add60","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"insurance_company\": \"ALLIANZ\",\n  \"policy_number\": \"cupidatat\",\n  \"date_of_validity\": \"1961-12-24\",\n  \"insured_amount\": 90299000.60385844,\n  \"url\": \"https://wefalco.com/images/image-id.png\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/insurances/:boat_id/","host":["https://themms.com"],"path":["insurances",":boat_id",""],"variable":[{"key":"boat_id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the insurance"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"51ad89b0-95bb-4d81-9b3b-980f23cf3464"}],"id":"af1c3d05-6bb8-4e72-8e82-2fffc4b9e177","_postman_id":"af1c3d05-6bb8-4e72-8e82-2fffc4b9e177","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/files/","item":[{"name":"Get file: Returns details about a particular file","id":"3453de62-8ab6-425f-9f0a-1cddcc2759ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://themms.com/files/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["files",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"731838d4-7ecf-4c02-a3c0-3d1f516896e1","description":{"content":"<p>(Required) ID of the associated boat</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"b1e3c9e9-95b1-446a-b6a6-5be79e1def4d","name":"Response: Details about an file by ID","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/files/:id/","host":["https://themms.com"],"path":["files",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the associated boat"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"urn:uuid:dcb04290-8c25-3cfe-0561-591836dd5e70\",\n  \"url\": \"https://wefalco.com/images/image-id.png\",\n  \"name\": \"Boat Registration\",\n  \"type\": \"immatriculation, circulation, francisation, assurance\"\n}"},{"id":"8e5efe2a-c8c6-491b-a729-8266032e9bf5","name":"Unexpected error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"url":{"raw":"https://themms.com/files/:id/","host":["https://themms.com"],"path":["files",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the associated boat"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"3453de62-8ab6-425f-9f0a-1cddcc2759ac"},{"name":"Update file: Update a file by ID","id":"fd223080-e9a0-4c6c-ac07-a101c947de6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"url\": \"https://wefalco.com/images/image-id.png\",\n  \"name\": \"Boat Registration\",\n  \"type\": \"immatriculation, circulation, francisation, assurance\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/files/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["files",":id",""],"host":["https://themms.com"],"query":[],"variable":[{"id":"9be65f9c-b567-40c9-bf60-ad8c4140c345","description":{"content":"<p>(Required) ID of the file</p>\n","type":"text/plain"},"type":"any","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","key":"id"}]}},"response":[{"id":"8ba2def7-73e4-4381-b4d9-4822b7009a68","name":"Response: Details about a file by ID","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"url\": \"https://wefalco.com/images/image-id.png\",\n  \"name\": \"Boat Registration\",\n  \"type\": \"immatriculation, circulation, francisation, assurance\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/files/:id/","host":["https://themms.com"],"path":["files",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the file"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"urn:uuid:dcb04290-8c25-3cfe-0561-591836dd5e70\",\n  \"url\": \"https://wefalco.com/images/image-id.png\",\n  \"name\": \"Boat Registration\",\n  \"type\": \"immatriculation, circulation, francisation, assurance\"\n}"},{"id":"4a54d641-d63c-467e-be71-9d5a2288b68b","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"<API Key>"}],"body":{"mode":"raw","raw":"{\n  \"url\": \"https://wefalco.com/images/image-id.png\",\n  \"name\": \"Boat Registration\",\n  \"type\": \"immatriculation, circulation, francisation, assurance\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://themms.com/files/:id/","host":["https://themms.com"],"path":["files",":id",""],"variable":[{"key":"id","value":"15fb54d0-bff6-728c-1250-ef72fbae1e33","description":"(Required) ID of the file"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"message\": \"Lorem ipsum dolor sit amet\"\n}"}],"_postman_id":"fd223080-e9a0-4c6c-ac07-a101c947de6c"}],"id":"39f54239-4b64-4292-8933-583782156c86","_postman_id":"39f54239-4b64-4292-8933-583782156c86","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/electricity/","item":[{"name":"List plugs","id":"3e957ec3-4535-464f-a35b-9b932b9920c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://themms.com/electricity/plugs/","description":"<p>This endpoint allows to sync plug list from the MMS. This is not required.</p>\n<p>The provided information are:</p>\n<ul>\n<li>The plug name</li>\n<li>The pedestal name</li>\n<li>The \"associated\" berth (slip) which will be used as a default value to link consumption to the contract.</li>\n</ul>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["electricity","plugs",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"064af30e-5025-47fa-8da8-e7fe60b57bec","name":"Response: List plugs","originalRequest":{"method":"GET","header":[],"url":"https://themms.com/electricity/plugs/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"fea69b5a-262b-11ee-99f2-a36eb74d223d\",\n        \"pedestal\": \"C01\",\n        \"berth\": \"C22\",\n        \"name\": \"C01-22\"\n    }\n    {\n        \"id\": \"de6b196e-262c-11ee-9158-e3f42562efc7\",\n        \"pedestal\": \"C01\",\n        \"berth\": \"C23\",\n        \"name\": \"C01-22\"\n    },\n    {\n        \"id\": \"df48cc64-262c-11ee-9b8c-b3b2ee0a8b97\",\n        \"pedestal\": \"C02\",\n        \"berth\": \"C24\",\n        \"name\": \"C02-24\"\n    }\n]"}],"_postman_id":"3e957ec3-4535-464f-a35b-9b932b9920c3"},{"name":"Send plug consumption (basic)","id":"4e119307-a3e1-4045-9e99-0c486be67339","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"plug\": \"fea69b5a-262b-11ee-99f2-a36eb74d223d\",\n    \"from\": \"2022-05-18T11:40:22.519222\",\n    \"to\": \"2022-05-18T11:40:22.519222\",\n    \"kwh\": 12.43\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/electricity/plugs/consumption/","description":"<p>This endpoint allows to send simple consumption on a plug/socket. This is the MMS role to attribute it a contract.</p>\n<p>The time period should not overlap with a previous one except if the <code>from</code> attribute is exactly the same, then the purpose is to update a previoulsy sent consumption.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["electricity","plugs","consumption",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e119307-a3e1-4045-9e99-0c486be67339"},{"name":"Send plug consumption (contract)","id":"a2d42664-5bf9-4e16-9336-70d848c4e972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"plug\": \"fea69b5a-262b-11ee-99f2-a36eb74d223d\",\n    \"contract\": \"a2674eb4-262d-11ee-b0c3-fb0582737cf7\",\n    \"from\": \"2022-05-18T11:40:22.519222\",\n    \"to\": \"2022-05-18T11:40:22.519222\",\n    \"kwh\": 43.987\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/electricity/plugs/consumption/","description":"<p>This endpoint allows to send simple consumption on a plug/socket but aleady link to the proper contract according to the information we have.</p>\n<p>The time period should not overlap with a previous one except if the <code>from</code> attribute is exactly the same, then the purpose is to update a previoulsy sent consumption.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["electricity","plugs","consumption",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2d42664-5bf9-4e16-9336-70d848c4e972"}],"id":"dfd032ba-c335-45cd-bc39-1fb4e29425db","description":"<p>The electricty endpoints allows to share data between Falco and the MMS.</p>\n<p>This descript is not implemented on our side yet, and will probably need improvements to match true MMS needs.</p>\n","_postman_id":"dfd032ba-c335-45cd-bc39-1fb4e29425db","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}},{"name":"/hooks/","item":[{"name":"Berth - New berth available","id":"e558da3e-b057-4867-a198-dd489c947048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"marina_id\": \"The MMS marina identifier\",\n    \"berth_id\": \"The MMS berth identifier\",\n    \"contract_id\": \"The MMS contract identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/hooks/new-berth-available/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["hooks","new-berth-available",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"e2e45e2e-390f-4b12-a899-310baf5c0d8c","name":"Berth - New berth available","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"marina_id\": \"QA\",\n    \"berth_id\": \"BERTH3492\",\n    \"contract_id\": \"CONT4366\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/hooks/new-berth-available/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"e558da3e-b057-4867-a198-dd489c947048"},{"name":"Berth - Update state","id":"cc7579b3-565a-4a0f-9f07-c500ed9a0147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"marina_id\": \"The MMS marina identifier\",\n    \"berth_id\": \"The MMS berth identifier\",\n    \"status\": \"mooring-idle,mooring-to-confirm,available,unavailable,availability-to-confirm,error,...\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/hooks/berth-state/","description":"<p>This endpoint allows Falco to provide consolidated data to the MMS. Falco uses the contract data on a berth along with the IoT presence sensor to determine whether the berth requires attention or not.</p>\n<p>We can discuss whether Falco should send only the IoT sensor data (boat-detected or no-boat-detected) or if it should send the already aggregated data (contract-no-boat, no-contract-boat, …)</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}},"urlObject":{"path":["hooks","berth-state",""],"host":["https://themms.com"],"query":[],"variable":[]}},"response":[{"id":"c047b51b-5503-4d60-b670-72c2d14b0379","name":"Berth - Update state","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"marina_id\": \"QA\",\n    \"berth_id\": \"BERTH3492\",\n    \"status\": \"mooring-to-confirm\"\n}","options":{"raw":{"language":"json"}}},"url":"https://themms.com/hooks/berth-state/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"cc7579b3-565a-4a0f-9f07-c500ed9a0147"}],"id":"f7bb3274-4c7e-476c-9a06-139d60f3236b","description":"<p>This section describes the endpoint the MMS should provide for information update from Falco to the MMS.</p>\n<p>The \"hook\" name and URLs can obviously be changed to something that more matches the MMS architecture.</p>\n","_postman_id":"f7bb3274-4c7e-476c-9a06-139d60f3236b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","id":"1fa962a1-0618-4c7b-a1d1-2e747b6b5b29","name":"MMS API Base v0.3","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{apiKey}}"}]}},"variable":[{"id":"bd98a257-deb5-4b23-a77a-977d856dbd65","key":"baseUrl","value":"https://themms.com","type":"string"}]}