AssignmentResult Data Type

Models the results returned when listing available assignments.

Properties
name data type description
results array of AssignmentIdentifier The available assignments matching the query.
Properties inherited from PagedResult
count number The total number of results. If this number exceeds the limit used, make another query with offset to fetch the additional results.
offset number The offset used in the query
limit number The limit used in the query.

Example

{
  "results" : {
    "id" : 12345,
    "name" : "...",
    "type" : "blue_pirat"
  },
  "count" : 10,
  "offset" : 0,
  "limit" : 25
}