Obtain metadata of SchoolDay for a user

New attributes can be added to JSON response. Client side implementation should not rely on the order of the attributes.

Endpoint

GET /portal/services/passport?access_token={valueOfAccessToken}

Description

The endpoint to retrieve metadata about content of user's SSO SchoolDay.

{
  "ownerId": 2282419,
  "children": [
	{
  	"assetId": 564838,
  	"ownerId": 2282416,
  	"type": "FOLDER",
  	"parentId":,
  	"name": "School Resources",
  	"children": [
    	{
      	"assetId": 564844,
      	"ownerId": 2282416,
      	"type": "SSOLINK",
      	"parentId": 564838,
      	"name": "Curriki",
      	"children":,
      	"sizex": 2,
      	"sizey": 2,
      	"position": 1,
      	"image": "curriki.png",
      	"applicationId": "Curriki"
    	},
    	{
      	"assetId": 590744,
      	"ownerId": 2282416,
      	"type": "BKM",
      	"parentId": 564838,
      	"name": "Google",
      	"children":,
      	"url": "https://www.google.com",
      	"sizex": 2,
      	"sizey": 2,
      	"position": 2,
      	"image": "upload/2282412/ahCKGAjAWGDX.png"
    	}
  	],
  	"sizex": 2,
  	"sizey": 2,
  	"position": 1
 	  }
  ],
  "resourcesStorage": {
	"baseUrl": "https://graphics.gg4l.com/p/content/images/"
  }
}

Field

Type

Description

assetId

BigInteger

A unique identifier of the asset

ownerId

BigInteger

A unique identifier of the owner of the assets in SSO Passport. Owner of the asset has administrative rights on the respective asset.

parentId

BigInteger

The unique identifier of the Asset that is a containers for the given resource

type

String

The type of the Asset:
FOLDER - folder (a container for other assets)
SSOLINK - an SSO enabled asset
BKM - a bookmark that does not requires authorization (SSO) through GG4L

url

String

The URL of the Asset (applies to asset with the type of “BKM”)

image

String

The URI of the image that represents an Asset in the Passport. Can be an absolute path or a value that needs to be concatenated with the value of “resourcesStorage”

position

Integer

Used order of assets in layout of SSO Passport

sizex

Integer

Horizontal size (relative units from 1 to 5)

sizey

Integer

Vertical size (relative units from 1 to 5)