...
Through simple calls the client of the API can retrieve all registered accounts and account details, including: permitted products, eligible brokers, and position limits & utilization. Clients can also update existing account information via the API.
AMS API is a RESTful JSON service with HATEOAS (hypermedia as the engine of application state). HATEOAS allows for hypermedia links to be returned within the payload from the API so the client can dynamically navigate to the next appropriate resource.
...
Expected results for query / post success or failure.
| Action | Successful | Bad Requests like a bad JSON format Request body | Invalid data in Request Body |
|---|---|---|---|
| GET, POST | GET - Result set returned POST - Updated data is returned When using the delete attribute, the resulting data set is returned after the delete. | Sample Error Message { | Sample Error Message
|
HATEOAS Description
HATEOAS (hypermedia as the engine of application state) – The client of the API can interact with the application as it provides information dynamically through hypermedia. In this case, the client doesn’t need to know about how to interact with the API beyond using the hypermedia provided in the payload returned from the API. The client will initially start by requesting _/myFirms at which point every subsequent potential call will be known through the hypermedia provided.
...
POST calls to CME Account Manager Management Service API allow specific information to be copied, updated or deleted.
...