{"openapi":"3.0.1","info":{"title":"Aansluitingen API","description":"A mock aansluitingen API for use with the linked data PoC.","version":"0.1"},"servers":[{"url":"http://localhost:4001"}],"paths":{"/aansluitingen":{"post":{"description":"Creates a new aansluitingen record with specified body.","parameters":[{"name":"role","in":"header","schema":{"type":"string"},"example":"netbeheerder"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"aansluiting":{"type":"object","properties":{"aansluitingEANBeginDatum":{"type":"string"},"verbruikssegment":{"type":"string"},"profielcategorie":{"type":"string"},"fysiekeCapaciteit":{"type":"string"},"woonplaats":{"type":"string"},"aansluitingEAN":{"type":"string"},"bemetingsWijze":{"type":"string"},"soortAansluiting":{"type":"string"},"allocatiemethode":{"type":"string"},"administratieveStatusBeginDatum":{"type":"string"},"productsoort":{"type":"string"},"leveringsrichting":{"type":"string"},"landcode":{"type":"string"}}}}},"examples":{"0":{"value":"{\n      \"aansluiting\": {\n        \"aansluitingEAN\": \"550000123001142280\",\n        \"aansluitingEANBeginDatum\": \"2018-02-03\",\n        \"woonplaats\": \"HOOGWOUD\",\n        \"productsoort\": \"ELK\",\n        \"verbruikssegment\": \"GVB\",\n        \"leveringsrichting\": \"LVR\",\n        \"bemetingsWijze\": \"JRL\",\n        \"soortAansluiting\": \"GWN\",\n        \"fysiekeCapaciteit\": \"OBK\",\n        \"profielcategorie\": \"E3A\",\n        \"allocatiemethode\": \"PRF\",\n        \"landcode\": \"NL\",\n        \"administratieveStatusBeginDatum\": \"2015-02-03T00:00:00.000Z\"\n      }\n}"}}}}},"responses":{"201":{"description":"Responds with a 201 if creation was succesful","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}},"servers":[{"url":"http://localhost:4001"}]},"servers":[{"url":"http://localhost:4001"}]},"/aansluitingen/{aansluitingEAN}":{"get":{"description":"Fetches a single aansluiting with optionally embedded data from (three) other API's.","parameters":[{"name":"aansluitingEAN","in":"path","schema":{"type":"string"},"required":true,"example":550000000001142280},{"name":"embed[]","in":"query","schema":{"type":"string","enum":["marktpartijen","contracten","meetdata"]},"example":"marktpartijen"},{"name":"role","in":"header","schema":{"type":"string","enum":["netbeheerder","meetverantwoordelijke","leverancier"]},"example":"netbeheerder"}],"responses":{"200":{"description":"Succesful response with all data.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}},"401":{"description":"The provided role is not authorized to request the PRIMARY resource.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}},"400":{"description":"This implies an error related to request formatting. Note that an unauthorized response from any one of the linked API's will also return a 400. More concise errorhandling has not yet been implemented.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}},"404":{"description":"The client was authorized, but no record with provided aansluitingEAN could be found.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}}},"delete":{"description":"Deletes a single aansluiting with specified aansluitingEAN","parameters":[{"name":"aansluitingEAN","in":"path","schema":{"type":"string"},"required":true,"example":550000000001142280},{"name":"role","in":"header","schema":{"type":"string"},"example":"netbeheerder"}],"responses":{"200":{"description":"Returns a 200 if aansluiting was succesfully deleted.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}},"404":{"description":"Returns a 404 if no aansluiting with specified aansluitingEAN was found.","content":{"application/json; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}},"servers":[{"url":"http://localhost:4001"}]},"servers":[{"url":"http://localhost:4001"}]}}}