Obituaries Api

Parameters

desc

adsfasdf
string optional
Headers
Authorization
string required
Applied to all methods

The api uses oauth2 for authentication and authorization.

Example:
Bearer sdjfiejifjsiefjsiefinefonefinifnef
Documentation
Api Methods
Obituaries

Create, Update, View and Delete Obituaries.

GET /obituaries
GET /obituaries/{id}
POST /obituaries
PATCH /obituaries/{id}
DELETE /obituaries/{id}
POST /obituaries/{id}/portrait
POST /obituaries/{id}/image
POST /obituaries/{id}/service
List Obituaries
GET /obituaries

Responses

200 OK
Body
Object
data
Object
type
string

obituaries

id
string

id of the obituary

attributes

Data properties of the obituary.

View Obituary
GET /obituaries/{id}

Path variables

id
string required

The id of the obituary.

Responses

200 OK
Body
Object
data
Object
type
string

obituaries

id
string

the id of the obituary.

attributes
404 Not Found

The requested resource was not found.

Create Obituary
POST /obituaries

Create a single obituary.

Request body

Object
data
Object
type
string
id
string
attributes

Responses

201 Created
Body
Object
id
string

The id of the created obituary.

400 Errors
Update Obituary
PATCH /obituaries/{id}

Update a single obituary.

Path variables

id
integer required

The id of the obituary.

Request body

Object
data
Object
type
string

obituaries

attributes

Responses

200 Ok

The update was accepted.

400 Errors
404 Not Found

The requested resource was not found.

Delete Obituary
DELETE /obituaries/{id}

Path variables

id
string required
obituaries/{id}/portrait
POST /obituaries/{id}/portrait

Path variables

id
integer required

The id of the obituary.

Request body

application/x-www-form-urlencoded
Object
portrait
string

The obituary portrait image.

Responses

201 Created
Body
Object
id
string

The id of the obituary portrait image.

400 Errors
404 Not Found

The requested resource was not found.

obituaries/{id}/image
POST /obituaries/{id}/image

Add an obituary image to the obituary's gallery.

Path variables

id
integer required

The id of the obituary.

Request body

application/x-www-form-urlencoded
Object
image
string

The obituary image.

caption
string

The image caption.

title
string

The image title.

Responses

201 Created
Body
Object
id
string

The id of the obituary image.

400 Errors
404 Not Found

The requested resource was not found.

obituaries/{id}/service
POST /obituaries/{id}/service

Create a new service associated to the obituary.

Path variables

id
string required

The id of the obituary.

Request parameters

date
string required

The date of the service in ISO 8610 format: YYYY-MM-DD

start_time
string required

The start time of the service in ISO 8610 format: HH:MM:SS

end_time
string required

The end time of the service in ISO 8610 format: HH:MM:SS

location_id
integer required

The id of the associated location.

text
string optional

Responses

201 Created
400 Errors
404 Not Found

The requested resource was not found.

Locations

Service Locations

GET /locations
GET /locations/{id}
POST /locations
PATCH /locations/{id}
DELETE /locations/{id}
List Locations
GET /locations

A listing of all the service locations.

Responses

200 OK
Body
Object
data
View Location
GET /locations/{id}

Path variables

id
string required

Responses

200 OK
Body
Object
type
string

locations

id
string

the id of the location

attributes
Create Location
POST /locations

Request body

Object
data
Object
type
string

locations

attributes
Update Location
PATCH /locations/{id}

Path variables

id
string required

Request body

Object
data
Object
type
string

locations

attributes
Delete Location
DELETE /locations/{id}

Path variables

id
string required
Comments
GET /comments
GET /comment/{id}
POST /comments
PATCH /comments/{id}
DELETE /comments/{id}
List Comments
GET /comments

Responses

200 OK
Body
Object
data
Array
Object
type
string

comments

id
string

the id of the comment

attributes
View Comment
GET /comment/{id}

Path variables

id
string required

Responses

200 OK
Body
Object
data
Object
type
string

comments

id
string

the id of the comment

attributes
Create Comment
POST /comments

Request body

Object
data
Object
type
string

comments

attributes

Responses

201 Created
Headers
Location
string optional

The uri of the created resource.

Body
Object
data
Object
type
string

comments

id
string

the id of the comment

attributes
Update Comment
PATCH /comments/{id}

Path variables

id
string required

Request body

Object
data
Object
type
string

comments

attributes

Responses

200 OK
Body
Object
data
Object
type
string

comments

id
string

the id of comment.

attributes
Delete Comment
DELETE /comments/{id}

Path variables

id
string required
Images
GET /images
GET /images/{id}
POST /images
PATCH /images/{id}
DELETE /images/{id}
List Images
GET /images
View Image
GET /images/{id}

Path variables

id
string required
Create Image
POST /images
Update Image
PATCH /images/{id}

Path variables

id
string required
Delete Image
DELETE /images/{id}

Path variables

id
string required
Life Events
GET /lifeevents
GET /lifeevent/{id}
POST /lifeevents
PATCH /lifeevent/{id}
DELETE /lifeevent/{id}
List Life Events
GET /lifeevents
View Life Event
GET /lifeevent/{id}

Path variables

id
string required
Create Life Event
POST /lifeevents
Update Life Event
PATCH /lifeevent/{id}

Path variables

id
string required
Delete Life Event
DELETE /lifeevent/{id}

Path variables

id
string required
Services
GET /services
GET /services/{id}
POST /services
PATCH /services/{id}
DELETE /services/{id}
List Services
GET /services
View Service
GET /services/{id}

Path variables

id
string required
Create Service
POST /services
Update Service
PATCH /services/{id}

Path variables

id
string required
Delete Service
DELETE /services/{id}

Path variables

id
string required
400 Errors
Body
Object
errors
Object
{property_name}
string

The errors with property name.

404 Not Found

The requested resource was not found.

Data Reference
Obituary object

Obituary Object

Properties

name

The name object of the deceased.

birth_date
string

The date of birth for the deceased in ISO 8601 YYYY-MM-DD format.

death_date
string

The date of death for the deceased in ISO 8601 YYYY-MM-DD format.

preset_image
string

A default image that is displayed if an obituary has no portrait image. Defaults to 0.

tribute_video
string

A url or embed code of the tribute video.

Enumeration:
0

candles

1

flowers

2

mountians

3

nature

4

ocean

5

sky

6

sunset

7

veteran

8

waterfall

tribute_video_type
string
Enumeration:
0

url

1

embed

Name object

Name Object

Properties

title
string
suffix
string
first
string
last
string
middle
string
nickname
string
Types: Obituary
Service Location object

The service location object.

Properties

id
string
name
string
address
string
city
string
state
string
zip
string
Comment object

Properties

foo
string
bar
string
baz
string
Life Event object
Image object