WP4: Infrastructure
Space shortcuts
Page tree

Versions Compared

Old Version 24

changes.mady.by.user Marco Soldati

Saved on

compared with

New Version 25

changes.mady.by.user Marco Soldati

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Get list of observation types
QueryRequest
Replace
varrestBaseUrl
/resources		 
Result
Code Block
languagejs
titleapplication/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [{
        "type" : "resources", 
        "id" : "person",
        "title": "A person",
        "links": { 
            "self" : "https://api.flarecast.eu/v1/persons/"
        },
    }, {
        "type" : "resources", 
        "id" : "algorithm",
        "title": "Algorithm or other software artifact",
        "links": { 
            "self" : "https://api.flarecast.eu/v1/algorithms/"
        },
     }, {
        "type" : "resources", 
        "id" : "feature",
        "title": "Features accessible through this API",
        "links": { 
            "self" : "https://api.flarecast.eu/v1/features/"
        },
    }, {
        "type" : "resources", 
        "id" : "observationsobservation_types",
         "title": "ObservationsTypes of observations accessible through this API",
        "links": {
            "self" : "https://api.flarecast.eu/v1/observationsobservation_types/"
    },
   }, 
   }, 
	...
    ]
  }
Code Block
languagejs
titleHomegrown
HTTP/1.1 200 OK
Content-Type: application/flarecast+json

{    
  "people" : {
    "description": "Persons or groups responsible"
    "baseURL": "https://api.flarecast.eu/people/"
  },
  "algorithms" : {
    "description" : "Registered algorithms (read-only)",
    "baseURL" : "https://api.flarecast.eu/algorithms/"
  },
  "features" : {
    "description" : "Features accessible through this API",
    "baseURL" : "https://api.flarecast.eu/features/"
  },
  "observations_types" : {
    "description" : "ObservationsType of observations accessible through this API",
    "baseURL" : "https://api.flarecast.eu/observationsobservation_types/"
  },
  ...
}

Observations

The file archive is basically a directory structure from where the files can be loaded through the httphttps:// protocol.

Get list of available observation types
QueryRequest

Replace
varrestBaseUrl
/observationsobservation_types

Result
Code Block
titleapplication/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data" : [{
    "type" : "observation_types",
    "id" : "sdo_hmi_720",
    "description" : "SDO HMI",
    "links": {
	   "self" : "https://api.flarecast.eu/observations/sdo/hmi/fits/"
    },
    "filepattern": "${YYYY}/${MM}/${DD}/hmi.M_720s_nrt.${YYMMDD}_${nr}_TAI.fits",
    "timeBegin": "2015-01-01T00:00:00Z",
    "timeEnd": "2015-04-20T00:00:00Z"
  }, {
    "type" : "observation_types",
    "id" : "sdo_hmi_45",
    ...,
  }
}
Code Block
languagejs
titleHome grown
HTTP/1.1 200 OK
Content-Type: application/flarecast+json

{
	"sdo_hmi_720" : {
		"description" : "SDO HMI",
		"baseURL" : "https://api.flarecast.eu/observationsobservation_types/sdo/hmi/fits/",
		"filepattern": "${YYYY}/${MM}/${DD}/hmi.M_720s_nrt.${YYMMDD}_${nr}_TAI.fits",
		"timeBegin": "2015-01-01T00:00:00Z",
		"timeEnd": "2015-04-20T00:00:00Z"
    },
	"sdo_hmi_45" : { ... }
}

 

 

 

Search for files
QueryRequest 
Replace
varrestBaseUrl
/observations/sdo/hmi/list?timerange=20150101T000000.0-20150101T120000.0
Result
Code Block
languagejs
{
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_010000_TAI.fits",
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_020000_TAI.fits",
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_030000_TAI.fits",
	...
}

Feature Properties

 

Get list of features
QueryRequest
Replace
varrestBaseUrl
/features/list
Result
Code Block
languagejs
{
    "id": {
      "type": "long"
    },
    "timestamp": {
      "type": "datetime"
    },
    "area": {
      "type": "double",
      "unit": "m2",
      "version": 5
    },
    "contour": {
      "type": "int[]",
      "description": "chaincode, 0 is left, 1-7 is direction counter clockwise",
      "version": 1
    }
}
Query
Template
Get features in a timerange
Request
Replace
varrestBaseUrl
//features/query?time_begin=20150101T000000.0&time_end=20150101T000000.0&fields=id,timestamp,area,contour 
Result
Code Block
languagejs
{
    "id": {
      "type": "long"
    },
    "timestamp": {
      "type": "datetime"
    },
    "area": {
      "type": "double",
      "unit": "m2",
      "version": 5
    },
    "contour": {
      "type": "int[]",
      "description": "chaincode, 0 is left, 1-7 is direction counter clockwise",
      "version": 1
    },
    "data": [
      [
        1,
        "2015-01-01T10:20:00.0",
        12321,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ],
      [
        2,
        "2015-01-01T10:20:45.0",
        14412,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ],
      [
        3,
        "2015-01-01T10:21:30.0",
        14434,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ]
    ]
}

 



 

Template

Template
QueryRequest 
Result
Code Block
languagejs
 

...