Versions Compared

Old Version 3

changes.mady.by.user Josh Helmer

Saved on

compared with

New Version 4

changes.mady.by.user Josh Helmer

Saved on

Key

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

...

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)

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
pageSizeDescriptionMaximum number of mappings to return per request
TypeQuery Parameter
RequiredNo
Default1000
pageNumberDescription0 based index of the page of records to retrieve
TypeQuery Parameter
RequiredNo
Default0


Output

DescriptionA page of EPPN mappings
Data Type


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


Faults


Faults
UnauthorizedDescriptionCalling service has not been authenticated
Http Status Code401
Additional Information
ForbiddenDescriptionCalling service has been authenticated, but does not have permissions to make this request
HTTP Status Code403
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.

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
eppnValsDescriptionAn array of EPPN mappings to mark as having been downloaded.
TypeBody Content
RequiredYes
DefaultN/A
Example["jdoe1@santarosa.edu", "jdoe2@santarosa.com"]


Output
DescriptionAn 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
UnauthorizedDescriptionCalling service has not been authenticated
Http Status Code401
Additional Information
ForbiddenDescriptionCalling service has been authenticated, but does not have permissions to make this request
HTTP Status Code403
Additional Information