Versions Compared

Key

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

...

To support users that may not have the necessary skillset to build and submit a web request from the schema, the report can be submitted via the Postman tool - operation can be using be API developers, In the body of the post, the data structure for the FraudReportSubmit mutation appears in the Query portion of the workspace, with ($input: FraudReportSubmitInput!) as the required argument. In GraphQL, an Input can be an argument against an object. In this case, FraudReportSubmit is an object type. The three fields below the object indicate the fields that we want values for in the response. The input variables appear in the GraphQL VARIABLES box

...

Image Removed

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#FFFFFF

Testing: While the purpose of this API is strictly for the reporting and sharing of information related to fraudulent applications and bad actors, any valid AppID or CCCID can be used for testing purposes. In addition to testing the API, these data will support the Tech Centers testing of the internal workflows to identify other applications that may be associated with the individual(s) reported to be fraudulent. 

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFFFF

Learn more information about the FraudReport fields and query objects in the SuperGlue API: Terminology & Data Element Dictionary.

From Root, select Query > FraudReportQuery

Configure the Query Operation

Selectfields for the expected response.

Below is an example of the three query inputObject variations.

Below shows the “withCCCID” inputObject query selected.

Fields can be selected individually from the FraudReport object.

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.

...

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFFFFF

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

Panel
panelIconId0b602188-3068-459a-af34-8f1e8dab2e4d
panelIcon:apollo-graphql-logo:
panelIconText:apollo-graphql-logo:
bgColor#F4F5F7

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

Image Modified

Copying & Exporting Query Operation

...

Documentation & Supporting Resources

See also:

...

Definitions of Terms

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

See more: SuperGlue API: Terminology & Data Element Descriptions

Item

Description

File / Link

Apollo API Sandbox

Fraud API Documentation

Pilot: https://apollo-router.pilot.ccctechcenter.org/

GraphQL API Documentation

Introduction to GraphQL Primer / Documentation

https://graphql.org/learn/

Postman Documentation

Introduction to Postman / Documentation

https://learning.postman.com/docs/getting-started/introduction/

Postman Collection Files

Fraud Report Collection:

  • Fraud Report OAuth

  • Fraud Report Submit

  • Fraud Report Query

GraphQL:Pilot Environment Collection

Table of Fraud API Data Fields

CCCTC Fraud API Data Element

Definition of Terms

CCCTC Fraud Report Project Definition of Terms