Common models

The following is an example of a Worksite:

{
  "worksiteId": 126,
  "name": "Early Learning Center",
  "isPreferred": true,
  "address": {
    "addressLine1": "257 Mountain Ave",
    "unitNo": null,
    "city": "Malden",
    "stateOrProvince": "MA",
    "zipOrPostalCode": "02148"
  },
  "employer": {
    "employerId": 99,
    "name": "Malden Public Schools"
  },
  "workAreas": [
    {
      "workAreaId": 567,
      "name": "Teacher"
    },
    {
      "workAreaId": 568,
      "name": "Food Service"
    }
  ]

Worksite

Each Worksite has the following properties:

Property

Type

Description

worksiteId

int

Read-only; unique identifier for the Worksite

name

string

Name for the Worksite; optional if address is specified

isPreferred

bool

Required; whether a Worksite is designated as preferred; each Employer must have one and only one preferred Worksite

address

object

Address of the Worksite; optional if name is specified

employer

object

Employer associated with the Worksite

workAreas

array

Address

Each Address has the following properties:

Property

Type

Description

addressLine1

string

Required; street address of the Worksite

city

string

Optional; city or town for the Worksite

unitNo

string

Optional; unit or suite number of the Worksite

stateOrProvince

string

Optional; the two-character state code for the Worksite

zipOrPostalCode

string

Optional; the 5-digit ZIP code for the Worksite

Employer

Each Employer has the following properties:

Property

Type

Description

employerId

int

Read-only; unique identifier for the Employer

name

string

Read-only; name for the employer

Work Area

Each Work Area has the following properties:

Property

Type

Description

workAreaId

int

Read-only; unique identifier for the Work Area

name

string

Required; name for the Work Area