...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
To export the FraudReportSubmit operation, or a variation of that template, as described in the schema in the Apollo sandbox, click the three dots in the Operation section to see display the context menu for options. |
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Update Your College Adaptor for the Fraud Data API - Please see the Fraud Data API Implementation Process page for integration details. |
...
Querying Fraud Report Data
Colleges that have not yet integrated with the SuperGlue College Adaptor may query fraud data information for an authorized MIS code directly using the Fraud Data API. The schema specifies this operation as the FraudReportQuery type query, which is an interface for retrieving a FraudReport object consisting of a 10-field payload response for an individual student and/or application.
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.
Querying Fraud Report Data
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 ten field payload response for an individual student and/or application.
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.
...
appId
cccId
recipientMisCode
reportedByMisCode
submitTiimestamp
fraudType
ccpgAid
federalAid
localAid
otherAid
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Learn more information about the FraudReport fields and query objects in the SuperGlue API: Terminology & Data Element Dictionary. |
...
The FraudReportQuery Operation
The schema describes the FraudReportQuery as a Query type object that requires at least one of three different inputObject variations as part of the API calloperation. Each variation has a specific input argument (variable) that can be customized to return all or some of the ten different FraudReport data fields in the payload responsethe payload response. The input variations can be used alone or in combination with each other as part of the operation. The payload response returned is the FraudReport.
The three query variations are:
...
To better understand the syntax for these variable definitions, it's useful to learn the GraphQL schema language, explained in detail on the Schema page.
The FraudReport object currently contains ten fields:
appId
cccId
recipientMisCode
reportedByMisCode
submitTiimestamp
fraudType
ccpgAid
federalAid
localAid
otherAid
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Learn more information about the FraudReport fields and query objects in the SuperGlue API: Terminology & Data Element Dictionary. |
The majority of multi-college districts will find the “withRecipientMisCode” query to be the most useful and commonly used variation for retrieving information on fraudulent applications submitted to one or more colleges in their district mis code.
...
Below is an example of the FraudReportQuery:withRecipientMisCode operation configured in the Apollo sandbox.
...
Copying & Exporting Query Operation
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
To export the FraudReportQuery operation, or a configuration of the template, as defined in the schema in the Apollo sandbox, click the three dots in |
...
...
...
the Operation section to display the context menu for options. |
...
Using Postman for Making API Queries
...
customizing the desired input fields and variables for the FraudReportQuery:withCCCID in Apollo, exporting the operation and copying it into Postman, where it can be saved as a separate query operation file and added to your Postman Fraud Report collection.
Select the values you are interested in receiving:
appId
cccId
fraudType
reportedByMisCode
submitTimestamp
recipientMisCode
The argument is the “withCccId”
Transfer these components over to Postman
In the Operation section, click on the “three dots” menu and select “Copy operation” from the menu.
...
Documentation & Supporting Resources
...