Versions Compared

Key

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

...

An option for colleges that have not yet implemented the SuperGlue College Adaptor is to query fraud data information specific to their college directly using the Fraud Data API. The schema specifies this operation as FraudReportQuery type query, the interface for retrieving a FraudReport object comprised of a 10 ten field payload response for an individual student and/or application.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

An Object type is one of the most basic components of a GraphQL schema. It represents the kind of object you can fetch from your service and the fields it includes. Learn more

...

(blue star) GraphQL provides a complete and understandable description of the data in your API, allowing [colleges] the power to ask for exactly what they need, nothing more and nothing less. GraphQL queries always return predictable results. Apps using GraphQL are fast and stable because they control the data they get, not the server.


The FraudReport object currently contains the following 10 fields:

...


The FraudReportQuery Operation

CCCTC has created provided templates for three different variations of the FraudReportQuery operationthat can be used to query fraud data for one or more authorized MIS codes. Each variation is configured for with a specific input argument (variable) and that can be customized to retrieve return all or some of the ten different FraudReport data fields in the payload response.

The three FraudReportQuery query variations are:

Use the…this operation…

Which that requires the…

To…to…

FraudReportQuery.withRecipientMisCode

“RecipientMisCode” “RecipientMisCode!” field as the input variable

Return a list of FraudReport responses for a specified MIS code.

FraudReportQuery.withAPPID

“AppId” “AppId!” field as the input variable

Return a FraudReport response for a specific student Application.

FraudReportQuery.withCCCID

“CCCID” “CCCID!” field as the input variable

Return a FraudReport response for a specific student CCCID.

(blue star) 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 pageon the Schema page.

...

For most districts, the “withRecipientMisCode” query variation will likely be the most commonly used and appropriate, as the district or colleges will be retrieving information about the applications, or CCCIDs of the applicants, that have submitted applications to their institution’s mis code.

Below is an example of a basic FraudReportQuery request using the FraudReportQuery:withRecipientMisCode input.

Code Block
curl --location --request POST 'https://apollo-router.qa.ccctechcenter.org' \
  --header 'Authorization: Bearer eyJhb' \
  --header 'Content-Type: application/json' \
  --data-raw '{"query":"query FraudReportQuery {\n  FraudReportQuery {\n    withRecipientMisCode {\n      submitTimestamp\n      cccId\n      reportedByMisCode\n      recipientMisCode\n      appId\n      fraudType\n      federalAid\n      ccpgAid\n      localAid\n      otherAid\n    }\n  }\n}","variables":{}}'

with This is an example of the expected response:.

Code Block
{
    "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
                }
            ]
        }
    }
}
Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFFFFF

Reminder: Enter your The user’s access token code should be entered as the Bearer token required in the Authorization head for secured requests to the API.

...

.

Below is an example of the FraudReportQuery:withRecipientMisCode operation configured in the Apollo sandbox.

...

Image Added

Image Added

Image AddedImage Added

Image Added

Using Postman for Making API Queries

...