atlas-api.json

# API key
# Any API key will be required to access the API in production, use the request header
# X-API-KEY: <API Key>
#
# Your API key will be assigned to you from the ATLAS instance

# Filtering data
# You can filter on any field listed under each of the resources
GET /users?filter[lastname]=Smith HTTP/1.1

# Pagination
# You can add your own pagination parameters to your request. Pagination defaults to
# 10 records per page.
GET /users?page[number]=3&page[size]=1 HTTP/1.1

# Sorting data
# You can sort on any field listed under each of the resources
GET /users?sort=firstname HTTP/1.1

# Appointments
# Create an alert/notification for the admin requested
#
# fields:
# user_id <Int, Required>
# location_id <Int, Required>
# service_type_id <Int, Required>
# office <TinyInt, length: 1, default: 0> Notes whether the appointment will be in office (1) or not (0)

POST /appointments/request HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "appointments",
    "attributes": {...}
  }
}

# Job Seeker Queue
# fields:
# id <Int>
# user_id <Int>
# location_id <Int>
# assigned_to_id <Int>
# assigned_to_type <String>
# other <String>
# status <Tinyint, length: 1>
# last_activity_admin_id <Int>
# created <Datetime>
# modified <Datetime>
# closed <Datetime>

GET /job_seeker_queues HTTP/1.1
Content-Type: application/vnd.api+json

GET /job_seeker_queues/<job_seeker_queue_id> HTTP/1.1
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "job_seeker_queues",
    "attributes": {...}
  }
}

# Locations
# fields:
# id <Int>
# name <String>
# public_name <String>
# address_1 <String>
# address_2 <String>
# city <String>
# state <String>
# zip <String>
# country <String>
# telephone <String>
# fax <String>
# hidden <TinyInt, length: 1>
# hours <String>

GET /locations HTTP/1.1
Content-Type: application/vnd.api+json

POST /locations HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "locations",
    "attributes": {...}
  }
}

# Service Types
# fields:
# id <Int>
# name <String>
# created <Datetime>
# modified <Datetime>

GET /service_types HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "service_types",
    "attributes": {...}
  }
}

# Users
# fields:
# id <Int>
# firstname <String>
# lastname <String>
# middle_initial <String, length: 3>
# ssn <String>
# username <String>
# address_1 <String>
# city <String>
# county <String>
# state <String, length: 2>
# zip <String, length: 5>
# phone <String>
# gender <String, length: 5>
# dob <Date>
# email <String>
# language <String>
# ethnicity <String>
# race <String>
# veteran <Tinyint/Boolean>

GET /users HTTP/1.1
Content-Type: application/vnd.api+json

GET /users/<user_id> HTTP/1.1
Content-Type: application/vnd.api+json

POST /users HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "users",
    "attributes": {...}
  }
}

# User Transactions (aka Job Seeker Transactions)
# fields: 
# id <Int>
# user_id <Int>
# location <Int>
# module <String>
# details <Text>
# notes <String>
# due_date <Datetime>
# assigned_to <Int>
# status <String>
# created <Datetime>

GET /user_transactions HTTP/# .1
Content-Type: application/vnd.api+json

GET /user_transactions/<user_transaction_id> HTTP/1.1
Content-Type: application/vnd.api+json

POST /user_transactions HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "user_transactions",
    "attributes": {...}
  }
}