Schema Dictionary

The following list shows the supported fields in the SSN schema and their corresponding description

Interactive Schema

We use Graphql for our API design, as such you can view our live schema docs directly from Apollo playground. Just open the playground and add the SSN staging url (https://ssn-for-orgs-staging.herokuapp.com/graphql).

Service

Services contain information about service provided by an organization. A user can interact with, apply for, save to favorites and share services.

• name: String!

• status: String

• alternateName: String

• description: String!

• url: String

• email: String!

• interpretationServices: String

• applicationProcess: String

• waitTime: String

• fees: String

• accreditations: String

• licenses: String

• category: Comma separated list of free texts

• subcategory: String!

• programs: Comma separated list of free texts

• organizations: Comma separated list of free texts

• requiredDocuments: Comma separated list of free texts

• paymentsAccepted: Comma separated list of free texts

• eligibilities:Comma separated list of free texts

• locations: Comma separated list of free texts

• fundings: Comma separated list of free texts

• contacts: Comma separated list of free texts

• serviceAreas: Comma separated list of free texts

• languages:Comma separated list of free texts

• phones:Comma separated list of free texts

• schedules: Comma separated list of free texts

Organization

The organization record is used to provide basic description and details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services. To create an organization I have the following fields:

• id string: UNIQ; Each organization must have a unique identifier.

• name string The official or public name of the organization. (Required)

• tagline string A tag line for the organization.

• alternate_name string. Alternative or commonly used name for the organization.

• description string; A brief summary about the organization. It can contain markup such as plain text, HTML or Markdown.(Required)

• email string The contact e-mail address for the organization.(Required)

• url string The URL (website address) of the organization.(Required)

• locations: Comma separated list of free texts with distance to user property inclusive

The following properties or organization should be grouped under Organization tax details

• ein number (Employer Identification Number): A unique number assigned by the Internal Revenue Service to every employer in the United States for the purposes of identification. Similar in purpose to the Social Security Number assigned to individuals.

• deductibility String

• subsection String

• assetAmount Number

• nteeType String The sub classification of the ntee parent. See full list of codes

• incomeAmount Number

• nteeSuffix String

• filingRequirement String

• classification String

• latest990 String

• rulingDate String

• nteeCode String

• groupName String

• deductibilityCode String

• foundationStatus: String

• nteeClassification: String The NTEE (National Taxonomy of Exempt Entities) Classification System was developed by The National Center for Charitable Statistics as part of its keyword searching criteria. This will help an organization be more easily found by users searching the database. See supported list here
• accountingPeriod String

• exemptOrgStatus String

• deductibilityDetail String

• exemptOrgStatusCode String

• nteeLetter: String

• affiliation string Free text describing who the organization is affiliated to. e.g: Independent - the organization is an independent organization or an independent auxiliary (i.e., not affiliated with a National, Regional, or Geographic grouping of organizations).

An example of a organization object:

{
  id: '37fc087e-bdf8-48c9-a9bb-b8dd9adb23e4',
  description: "The Alliance to Protect Nantucket Sound is dedicated to the long-term preservation of Nantucket Sound, the historic body of water that lies between Cape Cod and the islands of Martha's
 Vineyard and Nantucket. The Alliance was formed in 2002 in response to Cape Wind's proposal to build a 25-square-mile wind energy project in the Sound. We support responsibly sited renewable energy d
evelopment and the use of coastal marine planning to identify appropriate sites for development. The Alliance and its 20,000+ supporters oppose Cape Wind due to the conflicts inherent in a project who
se site selection has entirely ignored the public interest and the public process. Our supporters include environmentalists, chambers of commerce, fishermen, Native American tribes, ferry operators, a
irport commissions, business trade groups, municipalities, homeowners, and others.",
  name: 'Alliance to Protect Nantucket Sound',
  tagline: 'Dedicated to the long-term preservation of Nantucket Sound',
  alternateName: '',
  email: '[e-mail]',
  url: 'http://saveoursound.org/',
  ein: '100008105',
  deductibility: 'Contributions are deductible',
  subsection: '501(c)(3)',
  assetAmount: 1048217,
  nteeType: 'Environmental Quality, Protection and Beautification ',
  incomeAmount: 1300949,
  nteeSuffix: null,
  filingRequirement: '990 (all other) or 990EZ return',
  classification: 'Charitable Organization',
  latest990: 'December, 2019',
  rulingDate: 'August, 2002',
  nteeCode: 'C99',
  groupName: '',
  deductibilityCode: '1',
  affiliation: 'Independent - the organization is an independent organization or an independent auxiliary (i.e., not affiliated with a National, Regional, or Geographic grouping of organizations).',
  foundationStatus: 'Organization which receives a substantial part of its support from a governmental unit or the general public   170(b)(1)(A)(vi)',
  nteeClassification: 'Environmental Quality, Protection, and Beautification N.E.C.',
  accountingPeriod: 'December',
  exemptOrgStatus: 'Unconditional Exemption',
  deductibilityDetail: null,
  exemptOrgStatusCode: '01',
  nteeLetter: 'C'
}

User

The user can register and apply/refer for services. All the fields below are required.

• firstName: String

• lastName: String

• country: String

• email: String

• gender: Dropdown list ==> Male | Female | Other

• employmentStatus: Dropdown list ==> employed | unemployed

• disability: Comma separated list of free texts

• dob: Date

• housingStatus: Dropdown list ==> homeless | near homeless not homeless

• incomeLevel: Dropdown list ==> low income | high income | average

• insurance: Dropdown list ==> insured | under insured | not insured

• household: Dropdown list ==> individual | small family | large family

• phone: Number

• ext: Number