# com.tituslegaldesign.immigration.sourceSnapshot

> Published by [287g-data.tituslegaldesign.com](https://lexicon.garden/identity/did:plc:2wxsvrr5qgqwxy53ebo4kqet)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2wxsvrr5qgqwxy53ebo4kqet/com.tituslegaldesign.immigration.sourceSnapshot)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2wxsvrr5qgqwxy53ebo4kqet/com.tituslegaldesign.immigration.sourceSnapshot/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2wxsvrr5qgqwxy53ebo4kqet/com.tituslegaldesign.immigration.sourceSnapshot/examples)

## Definitions

### `com.tituslegaldesign.immigration.sourceSnapshot`

**Type**: `record`

A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes | When this snapshot record was written. |
| `file` | `blob` | No | The captured artifact itself. Its CID pins the exact bytes. Omit only when the artifact cannot be redistributed. |
| `foiaRequestNumber` | `string` | No | Agency-assigned FOIA tracking number, when publisher is 'foia'. |
| `note` | `string` | No | Context: retrieval anomalies, known upstream errors, processing caveats. |
| `publishedDate` | `string` | No | The edition date the upstream publisher assigned, YYYY-MM-DD, where stated on the artifact itself. |
| `publisher` | `string` | Yes | Who published the captured artifact. 'publisher' means this dataset's own maintainer produced it (e.g. a derived spreadsheet). |
| `retrievedAt` | `string` (datetime) | Yes | When the artifact was retrieved and archived. |
| `rowCount` | `integer` | No | Number of agreement rows the artifact contained, where countable. Lets consumers detect silent upstream shrinkage. |
| `sourceUrl` | `string` (uri) | No | Where the artifact was retrieved from, when it was published at a URL. |
| `title` | `string` | No | Human-readable description, e.g. 'ICE participating agencies workbook, 14 Aug 2026 edition'. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.",
      "key": "tid",
      "record": {
        "properties": {
          "createdAt": {
            "description": "When this snapshot record was written.",
            "format": "datetime",
            "type": "string"
          },
          "file": {
            "accept": [
              "application/pdf",
              "text/csv",
              "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
              "application/vnd.ms-excel"
            ],
            "description": "The captured artifact itself. Its CID pins the exact bytes. Omit only when the artifact cannot be redistributed.",
            "maxSize": 50000000,
            "type": "blob"
          },
          "foiaRequestNumber": {
            "description": "Agency-assigned FOIA tracking number, when publisher is 'foia'.",
            "maxLength": 100,
            "type": "string"
          },
          "note": {
            "description": "Context: retrieval anomalies, known upstream errors, processing caveats.",
            "maxLength": 3000,
            "type": "string"
          },
          "publishedDate": {
            "description": "The edition date the upstream publisher assigned, YYYY-MM-DD, where stated on the artifact itself.",
            "maxLength": 10,
            "type": "string"
          },
          "publisher": {
            "description": "Who published the captured artifact. 'publisher' means this dataset's own maintainer produced it (e.g. a derived spreadsheet).",
            "knownValues": [
              "ice",
              "foia",
              "publisher",
              "other"
            ],
            "type": "string"
          },
          "retrievedAt": {
            "description": "When the artifact was retrieved and archived.",
            "format": "datetime",
            "type": "string"
          },
          "rowCount": {
            "description": "Number of agreement rows the artifact contained, where countable. Lets consumers detect silent upstream shrinkage.",
            "minimum": 0,
            "type": "integer"
          },
          "sourceUrl": {
            "description": "Where the artifact was retrieved from, when it was published at a URL.",
            "format": "uri",
            "type": "string"
          },
          "title": {
            "description": "Human-readable description, e.g. 'ICE participating agencies workbook, 14 Aug 2026 edition'.",
            "maxLength": 300,
            "type": "string"
          }
        },
        "required": [
          "publisher",
          "retrievedAt",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "com.tituslegaldesign.immigration.sourceSnapshot",
  "lexicon": 1
}
```