NAV
ruby shell

API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://www.levantineceramics.org/

Introduction

The Levantine Ceramics Project (LCP) is an open, interactive website focused on ceramics produced in the Levant from the Neolithic era (c. 5500 B.C.E.) through the Ottoman period (c. 1920 C.E.). Here you can submit and find information—whether long published or newly discovered—about ceramic wares, shapes, specific vessels, scientific analyses, kiln sites, and chronology. The LCP makes it simple to access, share, use, and refine data, to link scholars and to foster collaborative research. Watch a brief video about the LCP here.

Authentication

The Levantine Ceramics Project expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer <token>

Pagination

Listing resource endpoints support pagination via query params

Name Type Required Description
page number false Page number, default: 1
per_page number false Number of records per page, default: 100

Code samples

curl "localhost:3000/api/v1/periods?page=1&per_page=1" \
  -H "Authorization: Bearer <token>"

Wares

List all wares

GET /api/v1/wares

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/wares',
  params: {
  }

p JSON.parse(result)

Code samples

curl "localhost:3000/api/v1/wares?page=1&per_page=5" \
  -H "Authorization: Bearer <token>"

Responses

Status Meaning Description Schema
200 OK Return all wares None

Get a ware

GET /api/v1/wares/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/wares/{id}',
  params: {
  }

p JSON.parse(result)


curl "localhost:3000/api/v1/wares/:id" \
  -H "Authorization: Bearer <token>"

Parameters

Name In Type Required Description
id path string true ID of the ware

Responses

Status Meaning Description Schema
200 OK Return a ware None

Create a ware

POST /api/v1/wares

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/wares',
  params: {
  }, headers: headers

p JSON.parse(result)


curl -X POST "localhost:3000/api/v1/wares" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "A mistery ware", "alternative_name": "Alternative name", "definition": "Magical", "desc": "Name", "chron_range": "Once upon a time", "period": "", "privacy_status": 1,"acknowledgement": "Found by X", "save_version": false }'

Body parameter

name: string
alternative_name: string
definition: string
desc: string
chron_range: string
period: string
privacy_status: string
acknowledgement: string
save_version: boolean

Parameters

Name In Type Required Description
name body string true Name of the ware
alternative_name body string false Alternative name of the ware
definition body string false Definition of the ware
desc body string false Desc of the ware
chron_range body string false Chron range of the ware
period body string false Period of the ware
privacy_status body string false Privacy status of the ware
acknowledgement body string false Acknowledgement of the ware
save_version body boolean false Save version of the ware

Responses

Status Meaning Description Schema
201 Created Create a ware None

Update a ware

PATCH /api/v1/wares/{id}

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.patch 'https://www.levantineceramics.org/api/v1/wares/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)


curl -X PATCH "localhost:3000/api/v1/wares/:id" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "New name", "alternative_name": "New Alternative name", "definition": "Magical", "desc": "Name", "chron_range": "Once upon a time", "period": "", "privacy_status": 1,"acknowledgement": "Found by X", "save_version": false }'

Body parameter

name: string
alternative_name: string
definition: string
desc: string
chron_range: string
period: string
privacy_status: string
acknowledgement: string
save_version: string

Parameters

Name In Type Required Description
id path integer(int32) true none
name body string false Name of the ware
alternative_name body string false Alternative name of the ware
definition body string false Definition of the ware
desc body string false Desc of the ware
chron_range body string false Chron range of the ware
period body string false Period of the ware
privacy_status body string false Privacy status of the ware
acknowledgement body string false Acknowledgement of the ware
save_version body boolean false Save version of the ware

Responses

Status Meaning Description Schema
200 OK Update a ware None

Vessels

List all Vessels

GET /api/v1/vessels

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/vessels',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all vessels None

Get a Vessel

GET /api/v1/vessels/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/vessels/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path string true ID of the vessel

Responses

Status Meaning Description Schema
200 OK Return a vessel None

Create a Vessel

POST /api/v1/vessels

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/vessels',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

inventory_number: string
ware_id: string
petrofabric_id: string
petrofab_name: string
petrofab_visual_desc: string
chron: string
period: string
manu_tech:
  - string
region_tokens: string
site_type: string
arch_context: string
shape_name: string
shape_rtype: string
site_id: string
shape_sub_group: string
functional_category_id: string
height: string
preserved_height: string
true_height: string
max_diameter: string
estimated_max_diameter: string
true_max_diameter: string
diameter_rim: string
estimated_diameter_rim: string
true_diameter_rim: string
diameter_base: string
estimated_diameter_base: string
true_diameter_base: string
thickness: string
color: string
firing: string
surface_treatment: string
contributor_tokens: string
privacy_status: string
privacy_tokens: string
acknowledgement: string
shape_id: string

Parameters

Name In Type Required Description
inventory_number body string true Inventory number of the vessel
ware_id body string false Ware of the vessel
petrofabric_id body string false Petrofabric of the vessel
petrofab_name body string false Petrofab name of the vessel
petrofab_visual_desc body string false Petrofab visual desc of the vessel
chron body string false Chron of the vessel
period body string false Period of the vessel
manu_tech body [string] false Manu tech of the vessel
region_tokens body string false Region tokens of the vessel
site_type body string false Site type of the vessel
arch_context body string false Arch context of the vessel
shape_name body string false Shape name of the vessel
shape_rtype body string false Shape rtype of the vessel
site_id body string false Site of the vessel
shape_sub_group body string false Shape sub group of the vessel
functional_category_id body string false Functional category of the vessel
height body string false Height of the vessel
preserved_height body string false Preserved height of the vessel
true_height body string false True height of the vessel
max_diameter body string false Max diameter of the vessel
estimated_max_diameter body string false Estimated max diameter of the vessel
true_max_diameter body string false True max diameter of the vessel
diameter_rim body string false Diameter rim of the vessel
estimated_diameter_rim body string false Estimated diameter rim of the vessel
true_diameter_rim body string false True diameter rim of the vessel
diameter_base body string false Diameter base of the vessel
estimated_diameter_base body string false Estimated diameter base of the vessel
true_diameter_base body string false True diameter base of the vessel
thickness body string false Thickness of the vessel
color body string false Color of the vessel
firing body string false Firing of the vessel
surface_treatment body string false Surface treatment of the vessel
contributor_tokens body string false Contributor tokens of the vessel
privacy_status body string false Privacy status of the vessel
privacy_tokens body string false Privacy tokens of the vessel
acknowledgement body string false Acknowledgement of the vessel
shape_id body string false Shape of the vessel

Responses

Status Meaning Description Schema
201 Created Create a vessel None

Update a vessel

PATCH /api/v1/vessels/{id}

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.patch 'https://www.levantineceramics.org/api/v1/vessels/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

ware_id: string
petrofabric_id: string
petrofab_name: string
petrofab_visual_desc: string
chron: string
period: string
manu_tech:
  - string
inventory_number: string
region_tokens: string
site_type: string
arch_context: string
shape_name: string
shape_rtype: string
site_id: string
shape_sub_group: string
functional_category_id: string
height: string
preserved_height: string
true_height: string
max_diameter: string
estimated_max_diameter: string
true_max_diameter: string
diameter_rim: string
estimated_diameter_rim: string
true_diameter_rim: string
diameter_base: string
estimated_diameter_base: string
true_diameter_base: string
thickness: string
color: string
firing: string
surface_treatment: string
contributor_tokens: string
privacy_status: string
privacy_tokens: string
acknowledgement: string
shape_id: string

Parameters

Name In Type Required Description
id path integer(int32) true none
ware_id body string false Ware of the vessel
petrofabric_id body string false Petrofabric of the vessel
petrofab_name body string false Petrofab name of the vessel
petrofab_visual_desc body string false Petrofab visual desc of the vessel
chron body string false Chron of the vessel
period body string false Period of the vessel
manu_tech body [string] false Manu tech of the vessel
inventory_number body string false Inventory number of the vessel
region_tokens body string false Region tokens of the vessel
site_type body string false Site type of the vessel
arch_context body string false Arch context of the vessel
shape_name body string false Shape name of the vessel
shape_rtype body string false Shape rtype of the vessel
site_id body string false Site of the vessel
shape_sub_group body string false Shape sub group of the vessel
functional_category_id body string false Functional category of the vessel
height body string false Height of the vessel
preserved_height body string false Preserved height of the vessel
true_height body string false True height of the vessel
max_diameter body string false Max diameter of the vessel
estimated_max_diameter body string false Estimated max diameter of the vessel
true_max_diameter body string false True max diameter of the vessel
diameter_rim body string false Diameter rim of the vessel
estimated_diameter_rim body string false Estimated diameter rim of the vessel
true_diameter_rim body string false True diameter rim of the vessel
diameter_base body string false Diameter base of the vessel
estimated_diameter_base body string false Estimated diameter base of the vessel
true_diameter_base body string false True diameter base of the vessel
thickness body string false Thickness of the vessel
color body string false Color of the vessel
firing body string false Firing of the vessel
surface_treatment body string false Surface treatment of the vessel
contributor_tokens body string false Contributor tokens of the vessel
privacy_status body string false Privacy status of the vessel
privacy_tokens body string false Privacy tokens of the vessel
acknowledgement body string false Acknowledgement of the vessel
shape_id body string false Shape of the vessel

Responses

Status Meaning Description Schema
200 OK Update a vessel None

Bulk import vessels

POST /api/v1/vessels/bulk_insert

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/vessels/bulk_insert',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

"vessels[inventory_number]":
  - string
"vessels[ware_id]":
  - string
"vessels[petrofabric_id]":
  - string
"vessels[petrofab_name]":
  - string
"vessels[petrofab_visual_desc]":
  - string
"vessels[chron]":
  - string
"vessels[period]":
  - string
"vessels[manu_tech]":
  - string
"vessels[region_tokens]":
  - string
"vessels[site_type]":
  - string
"vessels[arch_context]":
  - string
"vessels[shape_name]":
  - string
"vessels[shape_rtype]":
  - string
"vessels[site_id]":
  - string
"vessels[shape_sub_group]":
  - string
"vessels[functional_category_id]":
  - string
"vessels[height]":
  - string
"vessels[preserved_height]":
  - string
"vessels[true_height]":
  - string
"vessels[max_diameter]":
  - string
"vessels[estimated_max_diameter]":
  - string
"vessels[true_max_diameter]":
  - string
"vessels[diameter_rim]":
  - string
"vessels[estimated_diameter_rim]":
  - string
"vessels[true_diameter_rim]":
  - string
"vessels[diameter_base]":
  - string
"vessels[estimated_diameter_base]":
  - string
"vessels[true_diameter_base]":
  - string
"vessels[thickness]":
  - string
"vessels[color]":
  - string
"vessels[firing]":
  - string
"vessels[surface_treatment]":
  - string
"vessels[contributor_tokens]":
  - string
"vessels[privacy_status]":
  - string
"vessels[privacy_tokens]":
  - string
"vessels[acknowledgement]":
  - string
"vessels[shape_id]":
  - string

Parameters

Name In Type Required Description
vessels[inventory_number] body [string] true Inventory number of the vessel
vessels[ware_id] body [string] false Ware of the vessel
vessels[petrofabric_id] body [string] false Petrofabric of the vessel
vessels[petrofab_name] body [string] false Petrofab name of the vessel
vessels[petrofab_visual_desc] body [string] false Petrofab visual desc of the vessel
vessels[chron] body [string] false Chron of the vessel
vessels[period] body [string] false Period of the vessel
vessels[manu_tech] body [string] false Manu tech of the vessel
vessels[region_tokens] body [string] false Region tokens of the vessel
vessels[site_type] body [string] false Site type of the vessel
vessels[arch_context] body [string] false Arch context of the vessel
vessels[shape_name] body [string] false Shape name of the vessel
vessels[shape_rtype] body [string] false Shape rtype of the vessel
vessels[site_id] body [string] false Site of the vessel
vessels[shape_sub_group] body [string] false Shape sub group of the vessel
vessels[functional_category_id] body [string] false Functional category of the vessel
vessels[height] body [string] false Height of the vessel
vessels[preserved_height] body [string] false Preserved height of the vessel
vessels[true_height] body [string] false True height of the vessel
vessels[max_diameter] body [string] false Max diameter of the vessel
vessels[estimated_max_diameter] body [string] false Estimated max diameter of the vessel
vessels[true_max_diameter] body [string] false True max diameter of the vessel
vessels[diameter_rim] body [string] false Diameter rim of the vessel
vessels[estimated_diameter_rim] body [string] false Estimated diameter rim of the vessel
vessels[true_diameter_rim] body [string] false True diameter rim of the vessel
vessels[diameter_base] body [string] false Diameter base of the vessel
vessels[estimated_diameter_base] body [string] false Estimated diameter base of the vessel
vessels[true_diameter_base] body [string] false True diameter base of the vessel
vessels[thickness] body [string] false Thickness of the vessel
vessels[color] body [string] false Color of the vessel
vessels[firing] body [string] false Firing of the vessel
vessels[surface_treatment] body [string] false Surface treatment of the vessel
vessels[contributor_tokens] body [string] false Contributor tokens of the vessel
vessels[privacy_status] body [string] false Privacy status of the vessel
vessels[privacy_tokens] body [string] false Privacy tokens of the vessel
vessels[acknowledgement] body [string] false Acknowledgement of the vessel
vessels[shape_id] body [string] false Shape of the vessel

Responses

Status Meaning Description Schema
201 Created Bulk insert vessels None

Petrographics

List all Petrographics

GET /api/v1/petrographics

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/petrographics',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all petrographics None

Get a Petrographics

GET /api/v1/petrographics/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/petrographics/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path string true ID of the petrographic

Responses

Status Meaning Description Schema
200 OK Return a petrographic None

Create a Petrographics

POST /api/v1/petrographics

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/petrographics',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

item_id: string
thin_section_number: string
geological_features: string
soil_type: string
desc: string
matrix_type: string
matrix_amt: string
inclusion_type: string
inclusion_amt: string
voids_shape: string
voids_amt: string
ware_id: string
privacy_status: string
petrofabric_id: string
ware_visual_desc: string
petrofab_visual_desc: string
local_petrographic_group: string
vessel_id: string
vessel_site_id: string
vessel_chron: string
vessel_period: string
vessel_shape_name: string
vessel_functional_category_id: string
skip_callbacks: string
vessel_ware_id: string
vessel_petrofabric_id: string
acknowledgement: string

Parameters

Name In Type Required Description
item_id body string true Item of the petrographic
thin_section_number body string true Thin section number of the petrographic
geological_features body string false Geological features of the petrographic
soil_type body string false Soil type of the petrographic
desc body string false Desc of the petrographic
matrix_type body string false Matrix type of the petrographic
matrix_amt body string false Matrix amt of the petrographic
inclusion_type body string false Inclusion type of the petrographic
inclusion_amt body string false Inclusion amt of the petrographic
voids_shape body string false Voids shape of the petrographic
voids_amt body string false Voids amt of the petrographic
ware_id body string false Ware of the petrographic
privacy_status body string false Privacy status of the petrographic
petrofabric_id body string false Petrofabric of the petrographic
ware_visual_desc body string false Ware visual desc of the petrographic
petrofab_visual_desc body string false Petrofab visual desc of the petrographic
local_petrographic_group body string false Local petrographic group of the petrographic
vessel_id body string false Vessel of the petrographic
vessel_site_id body string false Vessel site of the petrographic
vessel_chron body string false Vessel chron of the petrographic
vessel_period body string false Vessel period of the petrographic
vessel_shape_name body string false Vessel shape name of the petrographic
vessel_functional_category_id body string false Vessel functional category of the petrographic
skip_callbacks body string false Skip callbacks of the petrographic
vessel_ware_id body string false Vessel ware of the petrographic
vessel_petrofabric_id body string false Vessel petrofabric of the petrographic
acknowledgement body string false Acknowledgement of the petrographic

Responses

Status Meaning Description Schema
201 Created Create a petrographic None

Update a Petrographic

PATCH /api/v1/petrographics/{id}

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.patch 'https://www.levantineceramics.org/api/v1/petrographics/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

geological_features: string
soil_type: string
desc: string
matrix_type: string
matrix_amt: string
inclusion_type: string
inclusion_amt: string
voids_shape: string
voids_amt: string
item_id: string
ware_id: string
privacy_status: string
thin_section_number: string
petrofabric_id: string
ware_visual_desc: string
petrofab_visual_desc: string
local_petrographic_group: string
vessel_id: string
vessel_site_id: string
vessel_chron: string
vessel_period: string
vessel_shape_name: string
vessel_functional_category_id: string
skip_callbacks: string
vessel_ware_id: string
vessel_petrofabric_id: string
acknowledgement: string

Parameters

Name In Type Required Description
id path integer(int32) true none
body body object false none
geological_features body string false Geological features of the petrographic
soil_type body string false Soil type of the petrographic
desc body string false Desc of the petrographic
matrix_type body string false Matrix type of the petrographic
matrix_amt body string false Matrix amt of the petrographic
inclusion_type body string false Inclusion type of the petrographic
inclusion_amt body string false Inclusion amt of the petrographic
voids_shape body string false Voids shape of the petrographic
voids_amt body string false Voids amt of the petrographic
item_id body string false Item of the petrographic
ware_id body string false Ware of the petrographic
privacy_status body string false Privacy status of the petrographic
thin_section_number body string false Thin section number of the petrographic
petrofabric_id body string false Petrofabric of the petrographic
ware_visual_desc body string false Ware visual desc of the petrographic
petrofab_visual_desc body string false Petrofab visual desc of the petrographic
local_petrographic_group body string false Local petrographic group of the petrographic
vessel_id body string false Vessel of the petrographic
vessel_site_id body string false Vessel site of the petrographic
vessel_chron body string false Vessel chron of the petrographic
vessel_period body string false Vessel period of the petrographic
vessel_shape_name body string false Vessel shape name of the petrographic
vessel_functional_category_id body string false Vessel functional category of the petrographic
skip_callbacks body string false Skip callbacks of the petrographic
vessel_ware_id body string false Vessel ware of the petrographic
vessel_petrofabric_id body string false Vessel petrofabric of the petrographic
acknowledgement body string false Acknowledgement of the petrographic

Responses

Status Meaning Description Schema
200 OK Update a petrographic None

Bulk import petrographics

POST /api/v1/petrographics/bulk_insert

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/petrographics/bulk_insert',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

"petrographics[item_id]":
  - string
"petrographics[thin_section_number]":
  - string
"petrographics[geological_features]":
  - string
"petrographics[soil_type]":
  - string
"petrographics[desc]":
  - string
"petrographics[matrix_type]":
  - string
"petrographics[matrix_amt]":
  - string
"petrographics[inclusion_type]":
  - string
"petrographics[inclusion_amt]":
  - string
"petrographics[voids_shape]":
  - string
"petrographics[voids_amt]":
  - string
"petrographics[ware_id]":
  - string
"petrographics[privacy_status]":
  - string
"petrographics[petrofabric_id]":
  - string
"petrographics[ware_visual_desc]":
  - string
"petrographics[petrofab_visual_desc]":
  - string
"petrographics[local_petrographic_group]":
  - string
"petrographics[vessel_id]":
  - string
"petrographics[vessel_site_id]":
  - string
"petrographics[vessel_chron]":
  - string
"petrographics[vessel_period]":
  - string
"petrographics[vessel_shape_name]":
  - string
"petrographics[vessel_functional_category_id]":
  - string
"petrographics[skip_callbacks]":
  - string
"petrographics[vessel_ware_id]":
  - string
"petrographics[vessel_petrofabric_id]":
  - string
"petrographics[acknowledgement]":
  - string

Parameters

Name In Type Required Description
petrographics[item_id] body [string] true Item of the petrographic
petrographics[thin_section_number] body [string] true Thin section number of the petrographic
petrographics[geological_features] body [string] false Geological features of the petrographic
petrographics[soil_type] body [string] false Soil type of the petrographic
petrographics[desc] body [string] false Desc of the petrographic
petrographics[matrix_type] body [string] false Matrix type of the petrographic
petrographics[matrix_amt] body [string] false Matrix amt of the petrographic
petrographics[inclusion_type] body [string] false Inclusion type of the petrographic
petrographics[inclusion_amt] body [string] false Inclusion amt of the petrographic
petrographics[voids_shape] body [string] false Voids shape of the petrographic
petrographics[voids_amt] body [string] false Voids amt of the petrographic
petrographics[ware_id] body [string] false Ware of the petrographic
petrographics[privacy_status] body [string] false Privacy status of the petrographic
petrographics[petrofabric_id] body [string] false Petrofabric of the petrographic
petrographics[ware_visual_desc] body [string] false Ware visual desc of the petrographic
petrographics[petrofab_visual_desc] body [string] false Petrofab visual desc of the petrographic
petrographics[local_petrographic_group] body [string] false Local petrographic group of the petrographic
petrographics[vessel_id] body [string] false Vessel of the petrographic
petrographics[vessel_site_id] body [string] false Vessel site of the petrographic
petrographics[vessel_chron] body [string] false Vessel chron of the petrographic
petrographics[vessel_period] body [string] false Vessel period of the petrographic
petrographics[vessel_shape_name] body [string] false Vessel shape name of the petrographic
petrographics[vessel_functional_category_id] body [string] false Vessel functional category of the petrographic
petrographics[skip_callbacks] body [string] false Skip callbacks of the petrographic
petrographics[vessel_ware_id] body [string] false Vessel ware of the petrographic
petrographics[vessel_petrofabric_id] body [string] false Vessel petrofabric of the petrographic
petrographics[acknowledgement] body [string] false Acknowledgement of the petrographic

Responses

Status Meaning Description Schema
201 Created Bulk insert petrographics None

Kilns (Workshops)

List all Kilns

GET /api/v1/kilns

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/kilns',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all kilns None

Get a Kiln

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/kilns/{id}',
  params: {
  }

p JSON.parse(result)

GET /api/v1/kilns/{id}

Return a kiln

Parameters

Name In Type Required Description
id path string true ID of the kiln

Responses

Status Meaning Description Schema
200 OK Return a kiln None

Create a Kiln

POST /api/v1/kilns

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.post 'https://www.levantineceramics.org/api/v1/kilns',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

name: string
location: string
chron: string
site_id: string
old_region_id: string
privacy_status: string
misc_box: string
period: string
start_year: string
end_year: string
workshop_location: string
acknowledgement: string
contributor_tokens: string
privacy_tokens: string
region_tokens: string
ware_tokens: string
save_version: string

Parameters

Name In Type Required Description
name body string true Name of the kiln
location body string false Location of the kiln
chron body string false Chron of the kiln
site_id body string false Site of the kiln
old_region_id body string false Old region of the kiln
privacy_status body string false Privacy status of the kiln
misc_box body string false Misc box of the kiln
period body string false Period of the kiln
start_year body string false Start year of the kiln
end_year body string false End year of the kiln
workshop_location body string false Workshop location of the kiln
acknowledgement body string false Acknowledgement of the kiln
contributor_tokens body string false Contributor tokens of the kiln
privacy_tokens body string false Privacy tokens of the kiln
region_tokens body string false Region tokens of the kiln
ware_tokens body string false Ware tokens of the kiln
save_version body string false Save version of the kiln

Responses

Status Meaning Description Schema
201 Created Create a kiln None

Update a Kiln

PATCH /api/v1/kilns/{id}

Code samples

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded'
}

result = RestClient.patch 'https://www.levantineceramics.org/api/v1/kilns/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Body parameter

location: string
chron: string
site_id: string
old_region_id: string
name: string
privacy_status: string
misc_box: string
period: string
start_year: string
end_year: string
workshop_location: string
acknowledgement: string
contributor_tokens: string
privacy_tokens: string
region_tokens: string
ware_tokens: string
save_version: string

Parameters

Name In Type Required Description
id path integer(int32) true none
body body object false none
location body string false Location of the kiln
chron body string false Chron of the kiln
site_id body string false Site of the kiln
old_region_id body string false Old region of the kiln
name body string false Name of the kiln
privacy_status body string false Privacy status of the kiln
misc_box body string false Misc box of the kiln
period body string false Period of the kiln
start_year body string false Start year of the kiln
end_year body string false End year of the kiln
workshop_location body string false Workshop location of the kiln
acknowledgement body string false Acknowledgement of the kiln
contributor_tokens body string false Contributor tokens of the kiln
privacy_tokens body string false Privacy tokens of the kiln
region_tokens body string false Region tokens of the kiln
ware_tokens body string false Ware tokens of the kiln
save_version body string false Save version of the kiln

Responses

Status Meaning Description Schema
200 OK Update a kiln None

Shapes

List all Shapes

GET /api/v1/shapes

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/shapes',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all shapes None

Get a Shape

GET /api/v1/shapes/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/shapes/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a shape None

Sites

List all Sites

GET /api/v1/sites

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/sites',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all sites None

Get a Site

GET /api/v1/sites/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/sites/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a site None

References

List all References

GET /api/v1/references

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/references',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all references None

Get a Reference

GET /api/v1/references/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/references/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a reference None

Periods

Get all Periods

GET /api/v1/periods

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/periods',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all periods None

Get a Period

GET /api/v1/periods/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/periods/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a period None

Period Categories

Get all Period Categories

GET /api/v1/period_categories

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/period_categories',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all Period categories None

Get a Period Category

GET /api/v1/period_categories/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/period_categories/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a Period category None

Images

Get all Images

GET /api/v1/images

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/images',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all Images None

Get an Image

GET /api/v1/images/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/images/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a Image None

Functional Categories

Get all Functional Categories

GET /api/v1/functional_categories

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/functional_categories',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all Functional categories None

Get a Functional Category

GET /api/v1/functional_categories/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/functional_categories/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a Functional category None

Contributors

Get a Contributor

GET /api/v1/contributors/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/contributors/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a Contributor None

Get all Contributors

GET /api/v1/contributors

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/contributors',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all Contributors None

Citations

Get all Citations

GET /api/v1/citations

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/citations',
  params: {
  }

p JSON.parse(result)

Responses

Status Meaning Description Schema
200 OK Return all Citations None

Get a Citation

GET /api/v1/citations/{id}

Code samples

require 'rest-client'
require 'json'

result = RestClient.get 'https://www.levantineceramics.org/api/v1/citations/{id}',
  params: {
  }

p JSON.parse(result)

Parameters

Name In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
200 OK Return a Citation None
ruby shell