Difference between revisions of "Property-SpatialUnit"

From OIP Wiki
Jump to: navigation, search
(axe extraInfo)
Line 57: Line 57:
 
</pre>
 
</pre>
  
  artifact.floAddress ... The FLO txid that published this artifact
+
  artifact.floAddress ... The FLO address that published this artifact
 
  artifact.timestamp ... UNIX timestamp
 
  artifact.timestamp ... UNIX timestamp
 
  artifact.type ... Always 'property' for property artifacts
 
  artifact.type ... Always 'property' for property artifacts

Revision as of 17:58, 9 April 2018

{
  "oip042": {
    "publish": {
      "artifact": {
        "floAddress": "string",
        "timestamp": 1234567890,
        "type": "property",
        "subtype": "spatialUnit",
        "info": {
          "title": "string",
          "description": "string",
          "year": 2018,
          "tags": "comma delimited list of search terms"
        },
        "details": {
          "geometry": {
            "type": "string",
            "data": {
              "comment": "custom data object based on geometry.type"
            }
          },
          "spatialType": "string",
          "spatialUnits": [
            "spatialUnit artifact ID",
            "spatialUnit artifact ID"
          ],
          "attrs": [
            {
              "key": "key name",
              "value": "the value"
            },
            {
              "key": "key name",
              "value": "the value"
            }
          ],
          "ns": "string"
        },
        "storage": {
          "network": "string",
          "location": "string",
          "files": [
            {
              "fName": "string",
              "fSize": 2048,
              "dName": "string",
              "fType": "Description of file's purpose, intent, or its context"
            }
          ]
        },
        "signature": "string"
      }
    }
  }
}
artifact.floAddress		... The FLO address that published this artifact
artifact.timestamp		... UNIX timestamp
artifact.type			... Always 'property' for property artifacts
artifact.subType		... 'spatialUnit' for spatialUnit artifacts
artifact.info.
	title			... Name of spatial unit
	description		... Optional descriptive text. This may be
					used for application formatted data. Set
					to empty string if no description is available.
	year			... 4 digit integer
	tags			... Optional comma delimited list of search terms.
artifact.details.              .... artifact.type domain specific details
	ns		        ... Namespace used for organization and project names.
				    This will allow a specific property application to
				    recognize known data structures.
	geometry	        ... Type and data that describes the geometry of this spatial unit
	spatialType	        ... Specific type of spatial unit such as "LegalSpaceUtilityNetwork"
				    and "LegalSpaceBuildingUnit" from LADM. A less formal type
				    would be a "parcel". Look to ns to determine the specific available
				    values for this property.
	spatialUnits	        ... Array of spatial unit artifact ID's
	attrs		        ... An array of JSON objects that represent attributes. Its schema is
				    understand by applications defined by ns, namespace. A simple
				    example would be an array of key/value pairs: [ {"key":"value"), ... ]
				    artifact.storage. To be clear, this property may be a list of objects
				    whose schema is defined by the application. The use of key/value
				    pairs is one example.
 artifact.storage.
	network			... Name of the storage network. Typically, IPFS.
	location		... IPFS directory location hash
	files			... Array of file descriptions. These files provide the sources for this
					artifact. These can be documents, audio, video, or other binary data
					that represent any supporting evidence for this artifact. Additionally,
					the files themselves can contain cryptographic proofs without the
					original content providing a mechanism for privacy where original
					documents are stored off-chain.
		fName		... Filename
		fSize		... File size in bytes
		dName		... Optional display name used by user interfaces
               fType              ...: Description of file's purpose, intent, or its context
artifact.signature		... Signature signed by publisher