@@ -24,12 +24,13 @@ Requests should be of the form:
...
@@ -24,12 +24,13 @@ Requests should be of the form:
*`command` : the request command, such as `search`. A full list of available options is available [here]()
*`command` : the request command, such as `search`. A full list of available options is available [here]()
*`constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here]().
*`constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here]().
* Example: to request a constellation, the client may use the portions of the constellation that are known (`id` or `ark_id`)
* Example: to request a constellation, the client may use the portions of the constellation that are known (`id` or `ark_id`)
```json
```json
{
{
"command":"get",
"command":"get",
"constellation":{"id":12345}
"constellation":{"id":12345}
}
}
```
```
##ServerResponses
##ServerResponses
...
@@ -45,7 +46,7 @@ The Server response API has the following form:
...
@@ -45,7 +46,7 @@ The Server response API has the following form:
"message" : "Error message"
"message" : "Error message"
},
},
"constellation" : {
"constellation" : {
"..."
"...":"..."
}
}
}
}
```
```
...
@@ -58,12 +59,12 @@ The Server response API has the following form:
...
@@ -58,12 +59,12 @@ The Server response API has the following form:
* `type` : the type of the error. A full list of error types are defined [here](http://shannonvm.village.virginia.edu:83).
* `type` : the type of the error. A full list of error types are defined [here](http://shannonvm.village.virginia.edu:83).
* `message` : a detailed error message (in English prose) stating the exact nature of the problem
* `message` : a detailed error message (in English prose) stating the exact nature of the problem
* `constellation` : The matching constellation for the client's query. All portions of the constellation known to the server will be returned to the client. If there are multiple constellations, this will return a list:
* `constellation` : The matching constellation for the client's query. All portions of the constellation known to the server will be returned to the client. If there are multiple constellations, this will return a list: