Get a Fleet

v1.0.0

Use this endpoint to generate a random group of clients. The feleet is generated in a deterministic way, on the basis of a fleet name given as a path parameter. In the case of identical fleet names, the endpoint will generate the same fleet object. The properties of the generated fleet object are randomly generated on the basis of the fleet name. In lack of a fleet name, all calls generate a different fleet object to the randomly generated fleet name.

Input

{
  "type": "object",
  "properties": {
    "fleetname": {
      "type": "string"
    }
  },
  "required": [
    "fleetname"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "sub"
  ],
  "properties": {
    "@id": {
      "type": "string",
      "description": "URL of the Fleet's JSON representation."
    },
    "logo": {
      "type": "string",
      "description": "The URL of the fleet logo, which can be customized by the gravatar associated with the email address in the `logo_email` property."
    },
    "logo_email": {
      "type": "string",
      "description": "The email address of the fleet, either generated or provided in the `sub` property. The fleet logo can be customized by the use of the gravater associated with this email address."
    },
    "members": {
      "type": "array",
      "description": "The client objects included in a fleet.",
      "items": {
        "type": "object"
      }
    },
    "name": {
      "type": "string",
      "description": "The displayed fleet name."
    },
    "profile": {
      "type": "string",
      "description": "The URL of the Fleet profile."
    },
    "sub": {
      "type": "string",
      "description": "The name or email address of a given fleet. The fleet properties and fleet members are generated from this name. If provide an email address, you can customize the fleet logo by the use of the gravatar associated with the email address."
    }
  }
}