Skip to content

FreeSO API Data Definitions

Tony Bark edited this page May 1, 2024 · 1 revision

Table of Contents

  1. Overview
  2. Definitions
    1. Dates
    2. Jobs
    3. Lot Categories
    4. Skill Modes
    5. Admit Modes
    6. Bulletin Types

Overview

This document describes some of the obscure values the public API can return for certain fields. If a field's data description is missing from this document, feel free to add it.

If something about the data is confusing: try searching the repository to see any code related to it, open an issue to discuss it, or join our Discord.

Definitions

Dates

created_date: 1518961270

All dates returned by the public API are in Unix time. This is the number of seconds since 1970-01-01 .

Jobs

current_job: 5

0 - Unemployed

1 - Robot Factory

2 - Restaurant

3 - Unused

4 - Nightclub - DJ

5 - Nightclub - Dancer

Lot Categories

category: 5

0 - None

1 - Money

2 - Offbeat

3 - Romance

4 - Service

5 - Shopping

6 - Skills

7 - Welcome

8 - Games

9 - Entertainment

10 - Residence

11 - Community

Skill Modes

skill_mode: 0

0 - Skill Gameplay Enabled

1 - Visitor Skills Disabled

2 - Skill Gameplay Disabled

Admit Modes

admit_mode: 1

0 - Admit All

1 - Admit List

2 - Ban List

3 - Ban All

4 - (used for job lots)

5 - Community (all objects owned by nobody)

6 - Community (objects retain ownership)

Bulletin Types

type: 0

0 - Mayor post

1 - System message

2 - Community post