Skip to content
Permalink
Browse files

Updated with latest schema and missing objects.

  • Loading branch information...
ericisaiah committed Aug 2, 2019
1 parent d14e722 commit a0422775f3252273e425016ca9cc6c57e6ce8b7a
@@ -0,0 +1,21 @@
## Resources

# Access Instructions on Opportunities

### Attributes

Field | Type | Note | Description
----------------|--------------|------------|------------------------------------
`access_type` | `string` | | The type of access this is. Options are `link`, `location`, `phone`, `other`, `email`, `file`
`instructions` | `string` | | The instructions for what to do to access this opportunity.
`access_value` | `boolean` | | The contact information (phone, URL, etc.) to use for this instruction. Emails and locations are added as child objects (see `locations` and `emails`).
`meta_data` | `string` | | String in JSON format that may contain additional data about this access instruction.
`enable_direct_access` | `boolean` | Defaults to `false` | Denotes if this organization accepts the sending of prospective client information directly to them via the contact information in this access instruction.
`locations` | Array | Of `location` objects | The email addresses that can be contacted for this access instruction.
`emails` | Array | Of `email` objects | The email addresses that can be contacted for this access instruction.

### Endpoints on Opportunities

#### `GET /v1/organizations/:organization_id/opportunities/:id/access_instructions`

Returns all access instructions on an opportunity.
@@ -0,0 +1,21 @@
## Resources

# Emails

### Attributes

Field | Type | Note | Description
----------------|--------------|------------|------------------------------------
`id` | `integer` | read-only | The unique ID of the phone number.
`email` | `string` | required | The email address.
`first_name` | `string` | | The first name whose email this is.
`last_name` | `string` | | The last name whose email this is.
`title` | `string` | | The job title of the person whose email this is.
`is_primary` | `boolean` | | Whether or not this is the opportunity's primary email. Defaults to `false`, unless this is the only email address.
`show_on_organization` | `boolean` | Defaults to `false` | Whether or not this email can also be given for the opportunity's parent organization (or is it specific to the opportunity).

### Endpoints on Opportunities

#### `GET /v1/organizations/:organization_id/opportunities/:id/emails`

Returns all email addresses for an opportunity.
@@ -35,101 +35,178 @@ Returns the list of opportunities on a organization with the following nested re
- [`locations`](locations.md)
- [`schedule`](schedule.md)
- [`phones`](phones.md)
- [`emails`](emails.md)
- [`schedule`](phones.md)
- `access_instructions`
- [`access_instructions`](access_instructions.md)
- [`organization`](organizations.md) (some top-level information)

An example request:

{
"id": 3,
"title": "Attend a workshop to learn more about the home purchase process",
"description": "This workshop teaches the basics of the home purchase process and helps attendees make informed decisions. Workshops are offered in Cantonese and Mandarin.",
"requirements": "Show up for the monthly workshop",
"slug": "attend-a-workshop-to-learn-more-about-the-home-purchase-process",
"id": 5460,
"title": "Get long-term shelter for women and children",
"description": "The Shepherd's Gate 12-18 month long program provides women with or without children with long-term housing. Participants receive case management, recovery, counseling, job skills training, and childcare. ",
"slug": "get-long-term-shelter-for-women-and-children",
"is_appointment": true,
"available_on": null,
"expires_on": null,
"region": null,
"organization": {
"id": 802,
"name": "Shepherd's Gate",
"slug": "shepherd-s-gate",
"opportunity_count": 5,
"resource_type": "Organization"
},
"resource_type": "Opportunity",
"tags": [
"affordable-housing",
"home-buying",
"housing"
"Transitional housing",
"Case management",
"Housing"
],
"schedule": {
"monday_start": "",
"monday_end": "",
"tuesday_start": "",
"tuesday_end": "",
"wednesday_start": "",
"wednesday_end": "",
"thursday_start": "",
"thursday_end": "",
"friday_start": "",
"friday_end": "",
"saturday_start": "",
"saturday_end": "",
"sunday_start": "",
"sunday_end": "",
"notes": ""
},
"categories": [
"Temporary housing",
"Family support services"
],
"areas": [
"Housing",
"Family & Household"
],
"schedule": {},
"properties": {
"lang-mandarin": "true",
"lang-cantonese": "true",
"lang-english": "true"
"community-children": "true",
"elig-gender": "Female",
"action-signup-url": "https://www.shepherdsgate.org/Program-Intake",
"community-mothers": "true",
"elig-homeless": "true",
"cost-free": "true",
"service-county-california-alameda": "true",
"service-county-california-contra-costa": "true",
"community-pregnant": "true",
"community-domestic-violence-victim-survivor": "true",
"community-post-incarceration": "true",
"community-immigrant": "true"
},
"locations": [
{
"id": 3,
"name": "Primary Location",
"address": "1167 Mission Street",
"unit": "4th Floor",
"city": "San Francisco",
"id": 3484,
"name": "Livermore Campus",
"address": "1660 Portola Ave",
"city": "Livermore",
"state": "CA",
"zip_code": "94551",
"lat": 37.6932,
"long": -121.779,
"is_primary": false,
"show_on_organization": true,
"phones": [
{
"id": 19203,
"digits": "888-216-4776",
"phone_type": "Office",
"is_primary": false
},
{
"id": 19204,
"digits": "925-449-3114",
"phone_type": "Fax",
"is_primary": false
}
],
"schedule": {
"monday_start": "09:30",
"monday_end": "16:30",
"tuesday_start": "09:30",
"tuesday_end": "16:30",
"wednesday_start": "09:30",
"wednesday_end": "16:30",
"thursday_start": "09:30",
"thursday_end": "16:30"
}
},
{
"id": 3485,
"name": "Brentwood Campus",
"address": "605 Sycamore Ave",
"city": "Brentwood",
"state": "CA",
"zip_code": "94103",
"lat": 37.7778,
"long": -122.412,
"is_primary": true,
"zip_code": "94513",
"lat": 37.9403,
"long": -121.685,
"is_primary": false,
"show_on_organization": true,
"phones": [
{
"id": 3,
"digits": "4159285910",
"id": 19205,
"digits": "888-216-4776",
"phone_type": "Office",
"is_primary": true
"is_primary": false
}
],
"schedule": {
"monday_start": "",
"monday_end": "",
"tuesday_start": "",
"tuesday_end": "",
"wednesday_start": "",
"wednesday_end": "",
"thursday_start": "",
"thursday_end": "",
"friday_start": "",
"friday_end": "",
"saturday_start": "",
"saturday_end": "",
"sunday_start": "",
"sunday_end": "",
"notes": ""
"monday_start": "09:30",
"monday_end": "16:30",
"tuesday_start": "09:30",
"tuesday_end": "16:30",
"wednesday_start": "09:30",
"wednesday_end": "16:30",
"thursday_start": "09:30",
"thursday_end": "16:30"
}
}
],
"phones": [
{
"id": 4,
"digits": "415-928-5910",
"phone_type": "Office",
"is_primary": true
"id": 6692,
"digits": "925-487-4147",
"phone_type": "Livermore Campus Intake",
"is_primary": false
},
{
"id": 6693,
"digits": "925-308-7507 x 307",
"phone_type": "Brentwood Campus Intake",
"is_primary": false
}
],
"emails": [
{
"id": 1157,
"email": "shepgate@shepherdsgate.org",
"title": "",
"first_name": "General information",
"last_name": "",
"is_primary": false,
"show_on_organization": true
}
],
"attachments": [],
"images": [],
"access_instructions": [
{
"id": 3901,
"access_value": "https://www.shepherdsgate.org/Program-Intake",
"access_type": "link",
"instructions": "Visit the link and select the preferred location to complete the intake form.",
"enable_direct_access": false,
"locations": [],
"emails": []
},
{
"id": 3902,
"access_value": "Call the preferred location to begin the intake process.",
"access_type": "other",
"instructions": "",
"enable_direct_access": false,
"locations": [],
"emails": []
}
],
"rating": 0,
"organization": {
"id": 3,
"name": "ASIAN, Inc.",
"slug": "asian-inc",
"opportunity_count": 4
}
}
"has_pending_submission": false,
"last_verified_at": "2019-07-30T22:58:52.000Z",
"updated_at": "2019-07-30T22:58:52.000Z"
}


#### `POST /v1/organizations/:organization_id/opportunities`

0 comments on commit a042277

Please sign in to comment.
You can’t perform that action at this time.