Page Comparison

...

The Fraud Data API is a SuperGlue-based solution (API) supporting that supports bi-directional communication and sharing of Application data identified as fraudulent by colleges in an effort to combat admissionsuspected admission application, enrollment, and or financial aid fraud activity across the California Community Colleges systemwith the CCC Technology Center, which in turn can suspend or block the individual’s profile, effectively protecting all other colleges automatically. Developed using GraphQL API technology, the first phase of this new service leverages will leverage the SuperGlue framework to amass a fraud data repository from college reports and then stream fraud notifications from the CCCTC out to other affected colleges.

...

The purpose of this guide is twofold: a) to introduce the new Fraud Data API project, with its processes and procedures, to college and district staff who will be participating in fraud reporting and data sharing processes - with a practical guide for performing the primary operations; and b) to provide more detailed, the technical information and API documentation to college and district IT staff and developers who have a higher understanding of the basic concepts and capabilities of GraphQL API technology, with including access to the API schema and the documentation required query templates used to execute the primary operations currently supported by this service.

...

GraphQL is a new API standard that provides a more efficient, powerful and flexible alternative to REST (Representational State Transfer)*. *Courtesy of GraphQL EdEx Course

While there are many excellent learning guides and tutorials on GraphQL online, including what it is and how to work with it, this document will primarily focus on learning and understanding the Fraud Data API - which is developed on GraphQL technology..

^{*Courtesy of GraphQL EdEx Course}

See the About GraphQL APIpage for an introduction to the basic concepts of GraphQL technology, the schema, and examples of the functional operations used in the Fraud Data API (query, mutation, subscription).

...

One of the benefits of a GraphQL API is its inherent ability to provide cohesive documentation for exposed be self-documenting. This means that when you use an interactive tool like GraphiQL, you’re able to explore what data is exposed by your GraphQL API, including the fields, types, schemas and operationsmore. Users are able to easily can also explore the data through the description field, and the schema Reference and Introspection (SDL) that which provides supplementary notes and supports strings and markdown. To about the endpoint.

In most cases this provides enough API reference documentation. However, to better understand and visualize the Fraud Data API, the complete schema documentation and the ability to explore, test, and validate the primary API calls is provided in via an Apollo sandbox tool and operation templates provided by the CCCTC (see links below).

The Apollo sandbox supports all GraphQL operation types (Query, Mutation, and Subscription) and allows you to explore the Fraud Data API schema documentation.

...

{
    "data": {
        "FraudReportQuery": {
            "withRecipientMisCode": [
                {
                    "submitTimestamp": "2022-10-07T21:15:37.000Z",
                    "cccId": "AAA0002",
                    "reportedByMisCode": "ZZ2",
                    "recipientMisCode": "ZZ1",
                    "appId": 4,
                    "fraudType": "APPLICATION",
                    "federalAid": null,
                    "ccpgAid": null,
                    "localAid": null,
                    "otherAid": null
                }
            ]
        }
    }
}

To learn more about the syntax for these variable definitions, it's useful to learn the GraphQL schema language. The schema language is explained in detail on the Schema page.

...

Documentation & Supporting Resources

...