{ "opencollection": "1.0.0", "info": { "name": "Global System for Mobile Communications GSMA Camara Project Endpoint Discovery Application Traffic Influence API Write API", "version": "0.1.0-wip" }, "items": [ { "info": { "name": "Traffic Influence API Write", "type": "folder" }, "items": [ { "info": { "name": "Global System for Mobile Communications Creates a new TrafficInfluence resource", "type": "http" }, "http": { "method": "POST", "url": "{apiRoot}/{basePath}/traffic-influences", "headers": [ { "name": "x-correlator", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Takes as input an object containing the intents from the API Consumer and creates a TrafficInfluence resourse accordingly. The trafficInfluenceID parameter, that is part of the object, must not be valorized when creating a new resource. For this reason the trafficInfluenceID parameter must be avoided in the object, anyway it will be ignored by the API Producer. It is automatically generated by the system and returned in the response." }, { "info": { "name": "Global System for Mobile Communications updates a specific TrafficInfluence resource, identified by the trafficInfluenceID value.", "type": "http" }, "http": { "method": "PATCH", "url": "{apiRoot}/{basePath}/traffic-influences/:trafficInfluenceID", "headers": [ { "name": "x-correlator", "value": "" } ], "params": [ { "name": "trafficInfluenceID", "value": "", "type": "path", "description": "Identifier of the specific TrafficInfluence resource to be retrieved, modified or deleted. It is the value used to fill trafficInfluenceID parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The resource identified by the trafficInfluenceID value can be modified. Before the PATCH can be invoked the status (state) of the resource must be \"active\". If not an errore code 409 (DENIED_WAIT) is returned." }, { "info": { "name": "Global System for Mobile Communications Delete an existing TrafficInfluence resource", "type": "http" }, "http": { "method": "DELETE", "url": "{apiRoot}/{basePath}/traffic-influences/:trafficInfluenceID", "headers": [ { "name": "x-correlator", "value": "" } ], "params": [ { "name": "trafficInfluenceID", "value": "", "type": "path", "description": "Identifier of the specific TrafficInfluence resource to be retrieved, modified or deleted. It is the value used to fill trafficInfluenceID parameter." }, { "name": "callbackUrl", "value": "", "type": "query", "description": "the location where updated data will be sent. Must be network\naccessible\nby the source server\n" } ] }, "docs": "invoked by the API Consumer to stop influencing the traffic, deleting a TrafficInfluence resource previously created." } ] } ], "bundled": true }