Page Comparison

...

Service Operation: Get EPPN

Name

/eppn/eppn-mappings/{EPPN}

Description

Lookup the mapping for a single EPPN

HTTP Method

GET

Preconditions

Caller must have have a valid OpenID token

Caller clientId must match the domain of the requested EPPN. (ie. If the eppn is jdoe@santarosa.edu, the clientId for the caller must be "santarosa.edu")

Post-conditions

Message Exchange Pattern

Request is received

EPPN mapping is looked up

Mapping is returned

Input

Parameters
EPPN	Description	The College EPPN to lookup
	Type	Path Parameter
	Required	Yes
	Default	N/A

Output

Description

EPPN Mapping JSON

Data Type

Code Block

language	js

{
  "authSource": "string",
  "cccId": "string",
  "createTime": "2017-03-24T22:47:08.089Z",
  "downloaded": boolean,
  "eppn": "string"
}

Faults

Faults
Unauthorized	Description	Calling service has not been authenticated
	Http Status Code	401
	Additional Information
Forbidden	Description	Calling service has been authenticated, but does not have permissions to make this request
	HTTP Status Code	403
	Additional Information

...

Service Operation: Get Mappings Created Since

Name

/eppn/eppn-mappings/since/{DATE}

Description

Lookup all mappings that have an authsource matching the clientId of the caller that have been entered since DATE.

HTTP Method

GET

Preconditions

Caller must have have a valid OpenID token

DATE Must be in YYYY-MM-DD format

Post-conditions

Message Exchange Pattern

Request is received

EPPN mappings are looked up

List of mappings is returned

Input

Parameters
DATE	Description	Lookup all EPPN mappings for the given college since DATE (inclusive). Date must be in YYYY-MM-DD format.
	Type	Path Parameter
	Required	Yes
	Default	N/A
pageSize	Description	Maximum number of mappings to return per request
	Type	Query Parameter
	Required	No
	Default	1000
pageNumber	Description	0 based index of the page of records to retrieve
	Type	Query Parameter
	Required	No
	Default	0

Output

Description

A page of EPPN mappings

Data Type

Code Block

language	js

{
  "data": [
    {
      "authSource": "string",
      "cccId": "string",
      "createTime": "2017-03-24T22:58:08.904Z",
      "downloaded": boolean,
      "eppn": "string"
    }
  ],
  "pageNumber": integer,
  "pageSize": integer,
  "totalElements": integer
}

Faults

Faults
Unauthorized	Description	Calling service has not been authenticated
	Http Status Code	401
	Additional Information
Forbidden	Description	Calling service has been authenticated, but does not have permissions to make this request
	HTTP Status Code	403
	Additional Information

...

Service Operation: Get New Mappings

Name

/eppn/eppn-mappings/new-mappings

Description

Lookup all mappings that have an authsource matching the clientId of the caller that have not previously been marked as downloaded (See: Service Operation: Mark downloaded)

HTTP Method

GET

Preconditions

Caller must have have a valid OpenID token

Post-conditions

Message Exchange Pattern

Request is received

EPPN mappings are looked up

List of mappings is returned

Input

Parameters
pageSize	Description	Maximum number of mappings to return per request
	Type	Query Parameter
	Required	No
	Default	1000
pageNumber	Description	0 based index of the page of records to retrieve
	Type	Query Parameter
	Required	No
	Default	0

Output

Description

A page of EPPN mappings

Data Type

Code Block

language	js

{
  "data": [
    {
      "authSource": "string",
      "cccId": "string",
      "createTime": "2017-03-24T22:58:08.904Z",
      "downloaded": boolean,
      "eppn": "string"
    }
  ],
  "pageNumber": integer,
  "pageSize": integer,
  "totalElements": integer
}

Faults

Faults
Unauthorized	Description	Calling service has not been authenticated
	Http Status Code	401
	Additional Information
Forbidden	Description	Calling service has been authenticated, but does not have permissions to make this request
	HTTP Status Code	403
	Additional Information

...

Service Operation: Mark Downloaded

Name

/eppn/eppn-mappings/batch/downloaded

Description

Mark a set of EPPN mappings as downloaded. This operation affects the data returned from the /eppn/eppn-mappings/new-mappings request.

HTTP Method

POST

Preconditions

Caller must have have a valid OpenID token

Post-conditions

Message Exchange Pattern

Request is received

EPPN mappings are looked up

List of mappings is returned

Input

Parameters
eppnVals	Description	An array of EPPN mappings to mark as having been downloaded.
	Type	Body Content
	Required	Yes
	Default	N/A
	Example	["jdoe1@santarosa.edu", "jdoe2@santarosa.com"]

Output

Description

An array of status objects. The array will consist of a single record for each EPPN listed in the request. The "status" field be set to either "Updated" or "Error"

Data Type

Code Block
[ { "entityId": "string" // eppn value "status": "string" // will be either "Updated" or "Error" } ]

Faults

Faults
Unauthorized	Description	Calling service has not been authenticated
	Http Status Code	401
	Additional Information
Forbidden	Description	Calling service has been authenticated, but does not have permissions to make this request
	HTTP Status Code	403
	Additional Information

...

Versions Compared

Old Version 5

New Version 6

Key