...
The Fraud Data API schema defines this process as the FraudReportSubmit operation, which is a query mutation that requires a variable input of an Input argument (FraudReportSubmitInput!) where at least one field (FraudReportSubmitInput!) and also returns a responseinput field variable is required and a basic payload response is provided (FraudReportSubmitPayload).
In most the majority of cases, only the application ID (AppID) input field is truly needed; however additional input fields can also or should be added as input variables to the operation.
Panel | ||
---|---|---|
| ||
In GraphQL, the Mutation type is a special object type that is explicitly used to write or modify server-side data. Learn more about GraphQL mutations |
The In the screenshot below shows , an example of a basic fraud submit request being operation is built in the Apollo sandbox.
The | In the Operation section, a FraudReportSubmit mutation is complete in the Operation sectionbuilt showing 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 below the Operation, the “appId” field as been selected added as the only input variable for this basic operation (currently displaying a null value).Before submitting the
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Reminder: The user’s API account is configured with the |
...
authorized MIS code(s), which |
...
are 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. |
For |
...
multi-college |
...
district accounts, the operation |
...
should be modified to also include the “reportedByMisCode” field |
...
in the input argument to specify which college in the district the |
...
fraudulent application (appId) is being submitted for (see example shown in the Variables table). |
...
With a better understanding of the basic operation, a skilled API developer has everything they need to effectively format a proper web request using an application development tool such as Curl, Python, PowerShell, etc. The Operation becomes the query itself
The example below submits a fraud report for application id (AppID) 34110
.
...