Versions Compared

Key

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

...

The reporting of locally identified fraud data from an individual college or district to the CCC Technology Center (CCCTC) is managed via the Bi-Directional Fraud Data API. Everything needed to submit fraud reports is documented in the schema (see the API Documentation section below), as well as through custom Postman files configured specifically for the fraud data operations. More information and detailed examples of the FraudReportSubmit mutation are provided in the Submitting a Fraud Reportsection of this guide.

...

Note

Authorized access via the API is restricted by college- or district MIS code, which is set as the default attribute in the API account. Multi-college districts will have a default MIS code as well but may also be granted authorization for additional MIS codes for individual colleges in their district. API accounts are set up by the CCCTC and provided to the college during the implementation process.

Back to Top

...

The Bi-Directional Fraud Data APISchema

The schema is one of the most important concepts when working with GraphQL API. It specifies the capabilities of the API, the shape of the available data, and the specific queries and mutation functions that can be used to read, write, and make web requests of a GraphQL server.

The Bi-Directional Fraud Data API schema defines the query type operations currently available to execute. The FraudQuerySubmit typemutationprovidesthe operation and data structure for submitting a fraud report to the CCCTC for a CCCApply Application (AppId) or a student ID (CCCID). The FraudReportQuery operation provides the structure for retrieving fraud data via the API.

...

Explore the API in the Apollo Sandbox

Access to the Bi-Directional Fraud Data API schema is available in the Apollo Sandbox to college IT staff for exploration of theschema and metrics, API development, documentation, and testing of the Fraud Report operations.

...

(lightbulb) By providing districts direct access to the [Bi-Directional Fraud Data]API schema, the CCCTC has effectively empowered the colleges with the ability to create and generate a user interface of their own, for example, that could be used to implement a more automated process for dealing with fraud application data. Or they can simply use Postman and the files configured for the Fraud Data API that are provided, to educate themselves on the GraphQL API or visualize the data structure.

...

College Implementation Process

To get started with the Bi-Directional Fraud Data API, an authorized college or district IT engineer with a good understanding of API technology must contact with the CCCTC Enabling Services team to schedule a checklist meeting.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFFFF

More information is provided to the district during the Bi-Directional Fraud Data API Implementation Process overview meeting with CCCTC Enabling Services.

Back to Top

...

Bi-Directional Fraud Data API Operations


(blue star) Recommended: Non-technical college staff are encouraged to use Postman for running ad hoc fraud reporting and queries. See /wiki/spaces/GLUEPD/pages/2851438610.

Getting the API Access Token

...