< back

How To Identify Endpoints

When you look at an object, if there is an endpoint available to POST to, it will tell you in the response. For example, if you look at the Store Room door you will get the following:

Look at Store Room door:

GET: /api/bioweapon/Object?id=72eef5bd-2565-4ee4-8867-32d0222e563a

In the response shown above, there is a 'apiEndpoint' object. This defines the available endpoint URL (if there is one), and details the method(s) (GET, POST) that can be used. Against each method, it details the parameters required, and if necessary gives a hint to what type of value the parameter(s) should be.

In the above example, there are two ways of accessing the endpoint. One is using GET and supplying no payload. The other is using POST:

POST: /api/BioWeapon/Reception/StoreRoomDoor

You must supply a JSON object like this in the body:

{ "key" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }