Psion Software Index API v1.0.0

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://software.psion.info

Default

Groups

GET /api/v1/groups

This is a description of the endpoint.

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "icon": {
      "path": "string",
      "width": 640,
      "height": 480,
      "bpp": 0
    },
    "platforms": [
      "epoc16"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List of program groups	Inline

Response Schema

Status Code 200

Program Groups

Name	Type	Required	Restrictions	Description
Program Groups	[object]	false	none	Top-level grouping for individual programs.
» id	string	true	none	none
» name	string	true	none	none
» icon	object	false	none	none
»» path	string	true	none	none
»» width	number	true	none	none
»» height	number	true	none	none
»» bpp	number	true	none	none
» platforms	[any]	true	none	none

Programs

GET /api/v1/programs

Example responses

200 Response

[
  {
    "id": "string",
    "uid": "string",
    "name": "string",
    "versions": [
      {
        "version": "string",
        "variants": [
          {
            "identifier": "string",
            "items": [
              {
                "filename": "string",
                "size": 0,
                "reference": [
                  {
                    "name": "string",
                    "url": "string"
                  }
                ],
                "kind": "installer",
                "sha256": "string",
                "id": "string",
                "uid": "string",
                "name": "string",
                "tags": [
                  "string"
                ],
                "version": "string",
                "icon": {
                  "path": "string",
                  "width": 0,
                  "height": 0
                },
                "icons": [
                  {
                    "path": "string",
                    "width": 0,
                    "height": 0,
                    "bpp": 0,
                    "filename": "string",
                    "sha256": "string"
                  }
                ],
                "fingerprint": "string",
                "platform": "epoc16"
              }
            ]
          }
        ]
      }
    ],
    "tags": [
      "string"
    ],
    "kinds": [
      "installer"
    ],
    "platforms": [
      "epoc16"
    ],
    "icon": {
      "path": "string",
      "width": 0,
      "height": 0
    },
    "screenshots": [
      {
        "width": 0,
        "height": 0,
        "path": "string"
      }
    ],
    "subtitle": "string",
    "category": "connectivity/web",
    "authors": [
      "string"
    ],
    "publishers": [
      "string"
    ],
    "description": "string",
    "links": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List of program groups	Inline

Response Schema

Status Code 200

Programs

Name	Type	Required	Restrictions	Description
Programs	[object]	false	none	Hierarchical grouped listing of all programs, versions, and variants.
» id	string	true	none	none
» uid	string	true	none	none
» name	string	true	none	none
» versions	[object]	false	none	none
»» version	string	true	none	none
»» variants	[object]	true	none	none
»»» identifier	string	true	none	none
»»» items	[object]	true	none	none
»»»» filename	string	true	none	none
»»»» size	integer	true	none	none
»»»» reference	[object]	true	none	none
»»»»» name	string	true	none	none
»»»»» url	string,null	true	none	none
»»»» kind	any	true	none	none
»»»» sha256	string	true	none	none
»»»» id	string	true	none	none
»»»» uid	string	true	none	none
»»»» name	string	true	none	none
»»»» tags	[string]	true	none	none
»»»» version	string	true	none	none
»»»» icon	object	false	none	none
»»»»» path	string	true	none	none
»»»»» width	number	true	none	none
»»»»» height	number	true	none	none
»»»» icons	[object]	false	none	none
»»»»» path	string	false	none	none
»»»»» width	number	true	none	none
»»»»» height	number	true	none	none
»»»»» bpp	integer	true	none	none
»»»»» filename	string	true	none	none
»»»»» sha256	string	true	none	none
»»»» fingerprint	string	false	none	none
»»»» platform	any	true	none	none
» tags	[string]	true	none	none
» kinds	[any]	true	none	none
» platforms	[any]	true	none	none
» icon	object	false	none	none
»» path	string	true	none	none
»» width	number	true	none	none
»» height	number	true	none	none
» screenshots	[object]	false	none	none
»» width	integer	true	none	none
»» height	integer	true	none	none
»» path	string	true	none	none
» subtitle	string	false	none	none
» category	any	false	none	none
» authors	[string]	false	none	none
» publishers	[string]	false	none	none
» description	string	false	none	none
» links	[string]	false	none	none

Enumerated Values

Property	Value
kind	installer
kind	standalone
platform	epoc16
platform	epoc32
category	connectivity/web
category	connectivity/other
category	games/action
category	games/adventure
category	games/arcade
category	games/board
category	games/puzzle
category	games/racing
category	games/rpg
category	games/shooter
category	games/simulation
category	games/sports
category	games/strategy
category	games/other
category	multimedia/ebooks
category	multimedia/music
category	multimedia/photo
category	multimedia/video
category	multimedia/other
category	productivity/calculators
category	productivity/date-and-time
category	productivity/graphics
category	productivity/office
category	productivity/organizers
category	productivity/scientific
category	productivity/other
category	system/addons
category	system/file-management
category	system/input
category	system/utilities
category	system/other
category	desktop/other

Summary

GET /api/v1/summary

Example responses

200 Response

{
  "programs": {
    "epoc16": 0,
    "epoc32": 0
  },
  "releases": {
    "total": {
      "epoc16": 0,
      "epoc32": 0
    },
    "unique": {
      "epoc16": 0,
      "epoc32": 0
    }
  },
  "size": {
    "total": {
      "epoc16": 0,
      "epoc32": 0
    },
    "unique": {
      "epoc16": 0,
      "epoc32": 0
    }
  },
  "sources": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Summary statistics about the index.	Summary

Sources

GET /api/v1/sources

Lists all sources used to generate the software index.

Example responses

200 Response

[
  [
    {
      "kind": "internet-archive",
      "name": "Psion 3-Lib Shareware Library June 2005",
      "description": "CD of the Psion 3-Lib Shareware library for Psion PDA's ",
      "url": "https://archive.org/download/3-libjune-05/3LIBJUNE05.iso",
      "html_url": "https://archive.org/details/3-libjune-05"
    }
  ]
]

Responses

Status	Meaning	Description	Schema
200	OK	JSON object containing summary statistics about the index.	Sources

Schemas

Sources

[
  [
    {
      "kind": "internet-archive",
      "name": "Psion 3-Lib Shareware Library June 2005",
      "description": "CD of the Psion 3-Lib Shareware library for Psion PDA's ",
      "url": "https://archive.org/download/3-libjune-05/3LIBJUNE05.iso",
      "html_url": "https://archive.org/details/3-libjune-05"
    }
  ]
]

Sources

Properties

Name	Type	Required	Restrictions	Description
Sources	[object]	false	none	Array of sources used to generate the index.
kind	any	true	none	String enumeration giving the type of the source (e.g., Internet Archive item, or website snapshot).
name	string	true	none	Display name for the source. This corresponds with the item title for Internet Archive sources.
description	string	false	none	HTML description of the source. In the case of the Internet Archive sources, this corresponds with the top-level item description.
url	string	false	none	Direct download link to the asset used to generate the index. Corresponds with the specific file in an Internet Archive item.
html_url	string	true	none	URL of an HTML page associated with the index. In the case of website snapshots, this is the root of the website; for Internet Archive sources, it represents the item details page.

Enumerated Values

Property	Value
kind	snapshot
kind	internet-archive

Summary

{
  "programs": {
    "epoc16": 0,
    "epoc32": 0
  },
  "releases": {
    "total": {
      "epoc16": 0,
      "epoc32": 0
    },
    "unique": {
      "epoc16": 0,
      "epoc32": 0
    }
  },
  "size": {
    "total": {
      "epoc16": 0,
      "epoc32": 0
    },
    "unique": {
      "epoc16": 0,
      "epoc32": 0
    }
  },
  "sources": 0
}

Index Summary

Properties

Name	Type	Required	Restrictions	Description
programs	object	true	none	none
» epoc16	integer	true	none	none
» epoc32	integer	true	none	none
releases	object	true	none	none
» total	object	true	none	none
»» epoc16	integer	true	none	none
»» epoc32	integer	true	none	none
» unique	object	true	none	none
»» epoc16	integer	true	none	none
»» epoc32	integer	true	none	none
size	object	true	none	none
» total	object	true	none	none
»» epoc16	integer	true	none	none
»» epoc32	integer	true	none	none
» unique	object	true	none	none
»» epoc16	integer	true	none	none
»» epoc32	integer	true	none	none
sources	integer	true	none	none