Skip to content

Sample List

Jump to bottom Edit New page
Sibel Adali edited this page Sep 26, 2018 · 2 revisions

Overview

  • Basic navigation of different rock samples
  • GET requests return JSON objects with relevant samples and data

Available Fields

Specify which attributes of samples are to be displayed in the returned JSON object. Use format /api/samples/?fields={...}. Multiple fields may be specified. If no fields are specified, all attributes will be displayed. The options are the following:

  • ID
  • Minerals
  • Owner
  • Subsample_IDs
  • Chemical
  • Analysis_IDs
  • Version
  • Public_Data
  • Number
  • Aliases
  • Collection_Date
  • Description
  • Location_Name
  • Location_Coords
  • Location_Error
  • Date_Precision
  • Country Regions
  • Collector_Name
  • Sesar_Number
  • Rock_Type
  • Collector_ID
  • Metamorphic_Regions
  • Metamorphic_Grades
  • References

Available Queries

Specify specific values of certain attributes to filter which samples are to be displayed. Possible keys, values, and calls are shown below.

Key Value Example (/api/samples{..})
polygon_coords a closed polygon coordinates /?&polygon_coords=[[40,-70],[35,-70],[35,-72],[40,-70]]
Minerals “name” attribute of mineral(s) /?&Minerals=Biotite
Countries “country” attribute of sample /?&Countries=Canada
References “name” attribute of reference(s) /?&References=1999-063486
Regions “regions” attribute of each sample /?&Regions=Almonte
ID “ID” attribute of sample /?&id=0012b1fa-e3c0-4920-81c2-59bb07278ce1
Collectors “collector_name” attribute of sample /?&collectors=Baxter et al.
Numbers “number” attribute of sample /?&numbers=126:1999-063486
Metamorphic_Grades “name” of sample’s “metamorphic_grade” /?&metamorphic_grade=Blueschist facies
Metamorphic_Regions “name” of sample’s “metamorphic_region” /?&metamorphic_regions=Olympic Mountains
Owners “name” of sample’s “owner” attribute /?&owners=Frank Spear
Emails “email” of sample’s “owner” attribute /?&emails=spearf@rpi.edu
Rock_types “name” attribute of sample’s “rock_type” /?&rock_types=Metaigneous

Example Calls

GET /api/samples/?&ids=0025a138-afac-4505-869b-10502825bfd2:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "0025a138-afac-4505-869b-10502825bfd2",
            "minerals": [
                {
                    "id": "9fa30d88-f28d-4684-8de7-6649fdadfad5",
                    "name": "Mica",
                    "amount": "x",
                    "real_mineral_id": "9fa30d88-f28d-4684-8de7-6649fdadfad5"
                },
                {
                    "id": "2d6e92f0-5d1e-4862-aaa4-72b2c741008a",
                    "name": "White Mica",
                    "amount": "x",
                    "real_mineral_id": "2d6e92f0-5d1e-4862-aaa4-72b2c741008a"
                },
                {
                    "id": "19abdd4a-418d-4b7c-b921-fb1218955f37",
                    "name": "Stilpnomelane",
                    "amount": "x",
                    "real_mineral_id": "19abdd4a-418d-4b7c-b921-fb1218955f37"
                }
            ],
            "owner": {
                "id": "20092950-5ea9-4761-b436-99e7ef2454fb",
                "name": "PUBLICATION",
                "email": "PUBLICATION",
                "address": "",
                "city": "",
                "province": "",
                "country": "",
                "postal_code": "",
                "institution": "",
                "professional_url": null,
                "research_interests": null
            },
            "subsample_ids": [
                "a119d68c-548e-4743-89d3-e0aec2c2fb98"
            ],
            "chemical_analyses_ids": [
                "e12903ba-309f-44b3-aa93-789e565b1ced",
                "2acdb62f-eaff-4551-b12f-c9747a8b578c"
            ],
            "version": 1,
            "public_data": true,
            "number": "V94CS77:1999-037286",
            "aliases": [],
            "collection_date": null,
            "description": "V94CS77\nor Metavolcaniclastic\nbarroisite",
            "location_name": null,
            "location_coords": "SRID=4326;POINT (-67.1834869384766051 10.0003404617309997)",
            "location_error": 150.0,
            "date_precision": null,
            "country": "Venezuela",
            "regions": [
                "Villa de Cura blueschist belt"
            ],
            "collector_name": null,
            "sesar_number": null,
            "rock_type": {
                "id": "b52f78f0-b702-42db-b760-dd74df03bd4e",
                "name": "Metavolcanic"
            },
            "collector_id": null,
            "metamorphic_regions": [
                {
                    "id": "73206d69-e0f7-4a77-a40b-7ab6406ea90f",
                    "name": "Northern Andes",
                    "shape": "SRID=4326;POLYGON ((-71.2281774437893063 5.7002433280917204, -66.6597080292185069 7.7926441919365699, -60.0361631149409973 9.0797452116925008, -60.4683908821518017 11.4088688949456998, -70.1032234368129963 12.7611195873911001, -71.7545151707818007 12.5191697483578004, -75.8214822246752931 10.8250481856864003, -77.6898862962920020 8.0694493512861794, -77.8159899430296065 3.4953567537300700, -80.0070992378378065 0.7828543326659529, -81.2084918545140937 -2.2290813848668400, -79.6194581115675959 -3.2891466237637199, -78.6120161436033982 -5.3135004291170498, -77.0532604215576953 -1.2081159042861600, -73.7388048727343062 3.6205325852865400, -71.2281774437893063 5.7002433280917204))",
                    "description": "Colombia, Ecuador, Peru, Venezuela, Trinidad, Tobago, Aruba, Curacao\n\nSierra Nevada de Santa Marta\nGuajira Serranias\nLoja-Amotape\nTahami\nChibcha\nMerida-Caparo\nCaucagua-Tinaco\nBaudo Range\nWestern, Central, Eastern Cordillera\nGarzon Massif\nSantander Massif\nMerida Massif\nSanta Mart Massif",
                    "label_location": null
                }
            ],
            "metamorphic_grades": [
                {
                    "id": "f9faabc7-ab24-4288-b652-d837378ced45",
                    "name": "Blueschist facies"
                }
            ],
            "references": [
                {
                    "id": "ef5ea82a-671f-482b-9b01-c93ec50a62ba",
                    "name": "1999-037286",
                    "title": null,
                    "first_author": null,
                    "second_authors": null,
                    "journal_name": null,
                    "full_text": null,
                    "journal_name_2": null,
                    "doi": null,
                    "publication_year": null
                }
            ]
        }
    ]
}

GET /api/samples/?fields=id,country&countries=Canada:

{
    "count": 619,
    "next": "http://159.65.245.182/api/samples/?countries=Canada&fields=id%2Ccountry&page=2",
    "previous": null,
    "results": [
        {
            "id": "0012b1fa-e3c0-4920-81c2-59bb07278ce1",
            "country": "Canada"
        },
        {
            "id": "0049cc8c-c758-451c-8902-018abca70547",
            "country": "Canada"
        },
        {
            "id": "008df841-5a7b-449b-a2ea-88a97e795735",
            "country": "Canada"
        },
        {
            "id": "01221042-f0cd-4278-8e09-576dbf503a14",
            "country": "Canada"
        },
        {
            "id": "013de22c-2ebd-45bb-aa06-32fc3ad9d979",
            "country": "Canada"
        },
        {
            "id": "0158a8db-062f-4e15-a5f9-14f5874b2b6d",
            "country": "Canada"
        },
        {
            "id": "017adc7e-e042-4612-8537-a3374ce86c7b",
            "country": "Canada"
        },
        {
            "id": "018d65a1-765e-49df-83a5-1ad26b896d7c",
            "country": "Canada"
        },
        {
            "id": "019d241c-e973-4c84-bc29-2b03335b1549",
            "country": "Canada"
        },
        {
            "id": "02bc5227-584f-4510-b67f-9ba6b7af13d7",
            "country": "Canada"
        },
        {
            "id": "02ded1f1-40b9-4164-a306-32fc36744efb",
            "country": "Canada"
        },
        {
            "id": "0346194a-ccc5-44b7-b8e7-22bc730399ba",
            "country": "Canada"
        },
        {
            "id": "03bdc45a-6319-479c-88f5-912bb42595b3",
            "country": "Canada"
        },
        {
            "id": "03e327b9-07ac-440b-a381-7de958245549",
            "country": "Canada"
        },
        {
            "id": "041f70dc-112a-4483-8472-48ad2a1d0445",
            "country": "Canada"
        },
        {
            "id": "048f9d91-80c4-4da8-ae73-01699a2ab75b",
            "country": "Canada"
        },
        {
            "id": "04d508aa-1a20-4af9-b22b-d2ed095cc595",
            "country": "Canada"
        },
        {
            "id": "0514e43a-d05a-42fc-bb25-b244948112da",
            "country": "Canada"
        },
        {
            "id": "0583a550-04bf-4548-8b0b-08a55f38f702",
            "country": "Canada"
        },
        {
            "id": "061e81b0-9562-48e6-9a9d-ebe9cf4a0a37",
            "country": "Canada"
        }
    ]
}
Add a custom footer
Add a custom sidebar

Clone this wiki locally