Obituaries Api

desc

adsfasdf

string optional

Authorization

string required

Applied to all operations

The api uses oauth2 for authentication and authorization.

Example:

Bearer sdjfiejifjsiefjsiefinefonefinifnef

Create, Update, View and Delete Obituaries.

List Obituaries

GET /obituaries

View Obituary

GET /obituaries/{id}

Create Obituary

POST /obituaries

Update Obituary

PATCH /obituaries/{id}

Delete Obituary

DELETE /obituaries/{id}

obituaries/{id}/portrait

POST /obituaries/{id}/portrait

obituaries/{id}/image

POST /obituaries/{id}/image

obituaries/{id}/service

POST /obituaries/{id}/service

GET /obituaries

Responses

200 OK

Body

Object

data

Object

type

string

obituaries

string

id of the obituary

attributes

Obituary

Data properties of the obituary.

GET /obituaries/{id}

Path variables

string required

The id of the obituary.

Responses

200 OK

Body

Object

data

Object

type

string

obituaries

string

the id of the obituary.

attributes

Obituary

404 Not Found

The requested resource was not found.

POST /obituaries

Create a single obituary.

Request body

Object

data

Object

type

string

attributes

Obituary

Responses

201 Created

Body

Object

string

The id of the created obituary.

400 Errors

PATCH /obituaries/{id}

Update a single obituary.

Path variables

integer required

The id of the obituary.

Request body

Object

data

Object

type

string

obituaries

attributes

Obituary

Responses

200 Ok

The update was accepted.

400 Errors

404 Not Found

The requested resource was not found.

DELETE /obituaries/{id}

Path variables

string required

POST /obituaries/{id}/portrait

Path variables

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

string

The id of the obituary portrait image.

400 Errors

404 Not Found

The requested resource was not found.

POST /obituaries/{id}/image

Add an obituary image to the obituary’s gallery.

Path variables

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

string

The id of the obituary image.

400 Errors

404 Not Found

The requested resource was not found.

POST /obituaries/{id}/service

Create a new service associated to the obituary.

Path variables

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.

Service Locations

List Locations

GET /locations

View Location

GET /locations/{id}

Create Location

POST /locations

Update Location

PATCH /locations/{id}

Delete Location

DELETE /locations/{id}

GET /locations

A listing of all the service locations.

Responses

200 OK

Body

Object

data

Array of Service Location

GET /locations/{id}

Path variables

string required

Responses

200 OK

Body

Object

type

string

locations

string

the id of the location

attributes

Service Location

POST /locations

Request body

Object

data

Object

type

string

locations

attributes

Service Location

PATCH /locations/{id}

Path variables

string required

Request body

Object

data

Object

type

string

locations

attributes

Service Location

DELETE /locations/{id}

Path variables

string required

List Comments

GET /comments

View Comment

GET /comment/{id}

Create Comment

POST /comments

Update Comment

PATCH /comments/{id}

Delete Comment

DELETE /comments/{id}

GET /comments

Responses

200 OK

Body

Object

data

Array

Object

type

string

comments

string

the id of the comment

attributes

Comment

GET /comment/{id}

Path variables

string required

Responses

200 OK

Body

Object

data

Object

type

string

comments

string

the id of the comment

attributes

Comment

POST /comments

Request body

Object

data

Object

type

string

comments

attributes

Comment

Responses

201 Created

Headers

Location

string optional

The uri of the created resource.

Body

Object

data

Object

type

string

comments

string

the id of the comment

attributes

Comment

PATCH /comments/{id}

Path variables

string required

Request body

Object

data

Object

type

string

comments

attributes

Comment

Responses

200 OK

Body

Object

data

Object

type

string

comments

string

the id of comment.

attributes

Comment

DELETE /comments/{id}

Path variables

string required

List Images

GET /images

View Image

GET /images/{id}

Create Image

POST /images

Update Image

PATCH /images/{id}

Delete Image

DELETE /images/{id}

GET /images

GET /images/{id}

Path variables

string required

POST /images

PATCH /images/{id}

Path variables

string required

DELETE /images/{id}

Path variables

string required

List Life Events

GET /lifeevents

View Life Event

GET /lifeevent/{id}

Create Life Event

POST /lifeevents

Update Life Event

PATCH /lifeevent/{id}

Delete Life Event

DELETE /lifeevent/{id}

GET /lifeevents

GET /lifeevent/{id}

Path variables

string required

POST /lifeevents

PATCH /lifeevent/{id}

Path variables

string required

DELETE /lifeevent/{id}

Path variables

string required

List Services

GET /services

View Service

GET /services/{id}

Create Service

POST /services

Update Service

PATCH /services/{id}

Delete Service

DELETE /services/{id}

GET /services

GET /services/{id}

Path variables

string required

POST /services

PATCH /services/{id}

Path variables

string required

DELETE /services/{id}

Path variables

string required

400 Errors

Body

Object

errors

Object

{property_name}

string

The errors with property name.

Operations: Create Obituary obituaries/{id}/image obituaries/{id}/portrait obituaries/{id}/service Update Obituary

404 Not Found

The requested resource was not found.

Operations: obituaries/{id}/image obituaries/{id}/portrait obituaries/{id}/service Update Obituary View Obituary

Obituary Object

Object

name

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:

candles

flowers

mountians

nature

ocean

sky

sunset

veteran

waterfall

tribute_video_type

string

Enumeration:

url

embed

Methods: Create Obituary List Obituaries Update Obituary View Obituary

Name Object

Object

title

string

suffix

string

first

string

last

string

middle

string

nickname

string

Types: Obituary

The service location object.

Object

string

name

string

address

string

city

string

state

string

zip

string

Methods: Create Location List Locations Update Location View Location

Object

foo

string

bar

string

baz

string

Methods: Create Comment List Comments Update Comment View Comment

Object