delete_settings_organizations_organizationName

v1.0.0

Delete an organization (and the associated receivers and senders)

Input

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

Output

{
  "type": "object",
  "description": "An organization connected to data hub",
  "required": [
    "description",
    "jurisdiction",
    "name"
  ],
  "properties": {
    "countyName": {
      "type": "string",
      "description": "the county name (must match FIPS name)"
    },
    "description": {
      "type": "string",
      "description": "the displayable description of the organization"
    },
    "jurisdiction": {
      "type": "string",
      "enum": [
        "National",
        "State",
        "County"
      ]
    },
    "meta": {
      "type": "object",
      "description": "The metadata associated with an setting",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "time-date",
          "description": "the time that the particular revision was created"
        },
        "createdBy": {
          "type": "string",
          "description": "the user who created the particular revision"
        },
        "version": {
          "type": "number",
          "description": "the version number of the object"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "the unique id for the organization"
    },
    "stateCode": {
      "type": "string",
      "description": "the two letter code for the organization"
    }
  }
}