# bio.cuanto.surveyProtocol

> Published by [cuanto.bio](https://lexicon.garden/identity/did:plc:dd7efi6wormdpmcyscnkjc6n)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dd7efi6wormdpmcyscnkjc6n/bio.cuanto.surveyProtocol)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dd7efi6wormdpmcyscnkjc6n/bio.cuanto.surveyProtocol/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dd7efi6wormdpmcyscnkjc6n/bio.cuanto.surveyProtocol/examples)

## Definitions

### `bio.cuanto.surveyProtocol`

**Type**: `record`

Defines the contents of a Survey, including what participants should look for and what fields they must fill out.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `title` | `string` | Yes | Name of the protocol (sensu DCMI dc:title). |
| `createdAt` | `string` (datetime) | Yes | Client-declared timestamp when this protocol was originally created. |
| `description` | `string` | Yes | Narrative description of the protocol (sensu DCMI dc:description). |
| `requiredFields` | `array` | No | List of fields required to complete the survey. |
| `locationOptions` | `array` | No | Controlled list of locations where surveys may occur. When present, surveyors must choose from this list rather than entering a free-form location name. |

## Raw Schema

```json
{
  "id": "bio.cuanto.surveyProtocol",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "title",
          "description",
          "createdAt"
        ],
        "properties": {
          "title": {
            "type": "string",
            "description": "Name of the protocol (sensu DCMI dc:title)."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Client-declared timestamp when this protocol was originally created."
          },
          "description": {
            "type": "string",
            "description": "Narrative description of the protocol (sensu DCMI dc:description)."
          },
          "requiredFields": {
            "type": "array",
            "items": {
              "type": "string",
              "knownValues": [
                "eventDate",
                "eventDuration",
                "surveyorCount"
              ]
            },
            "description": "List of fields required to complete the survey."
          },
          "locationOptions": {
            "type": "array",
            "items": {
              "ref": "org.atgeo.place",
              "type": "ref"
            },
            "description": "Controlled list of locations where surveys may occur. When present, surveyors must choose from this list rather than entering a free-form location name."
          }
        }
      },
      "description": "Defines the contents of a Survey, including what participants should look for and what fields they must fill out."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```