...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
A primary function of the API is to facilitate the process of automating the submission of submitting suspected or identified fraudulent admission applications to the CCCTC for use in combatting systemwide fraud. |
Submitting a Fraud Report Via API
The schema defines the process for reporting submitting fraud information to the CCCTC via the API is known the CCCTC as the FraudReportSubmit operation. The full schema is Specifications for this GraphQL-based operation are documented in the Apollo sandbox.
In general terms, the components of the GraphQL this operation are quite basic. The root of the FraudReportSubmit query is a mutation type object that requires an has a required Input argument (FraudReportSubmitInput!) where at least one input variable input field must be provided , and a structured custom payload response is defined (FraudReportSubmitPayload). For the majority of fraud report submissions, only the input of the application Id (AppID) is truly needed; however , although additional input fields may also be added to the operation.
...
In the Operation section, the root mutation, FraudReportSubmit, has been selected with the default FraudReportSubmitPayload fields displayed. In the Documentation column, the Input argument - FraudReportSubmitInput - is selected and expanded showing the fields that can be used for the required input. In the Variables table, the “appId” field as been added as the only input variable for this basic operation (currently displaying a null value in the adjacent screenshot).
|
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The Documentation tab (in the sandbox) enables you to step into the Fraud Data API schema, beginning at one of its entry points. Click the ⊕ button next to any field in the Documentation tab to add that field to the operation editor, at your current path. By default, the Explorer automatically generates variables for that field's arguments |
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Reminder: The user’s API account is configured with their default authorized MIS code(s), which is identified in the access token that becomes part of the request heading. The “appId” value entered must be a legitimate application corresponding to the authorized MIS code or the request will return an error. |
...