...
In general terms, the components of the GraphQL operation are quite basic. The FraudReportSubmit query is a mutation type object that requires an Input argument (FraudReportSubmitInput!) where at least one variable input field must be provided, and a structured payload response is defined (FraudReportSubmitPayload). For the majority of fraud report submissions, only the input of the application Id (AppID) is truly needed; however additional input fields may also be added to the operation.
...
| bgColor | #F4F5F7 |
|---|
...
Explore the schema documentation for the FraudReportSubmit mutation and see the available Input fields.
The FraudReportSubmit 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
Reminder: The user’s API account is configured with the their default authorized MIS code(s), which are 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. |
...
In this operation, the mutation has a required input argument (FraudReportSubmitInput!) that specifies which data fields will be included in the submission.
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). |  |
...
The default MIS code for a single college district is passed automatically in the token, so it does not need to be included as a variable in the input argument. |  |
In the hands of a knowledgable API programmer, the schema provides everything they need to construct and execute the FraudReportSubmit operation, including the required input argument, Input fields, and the payload response using an API dev tool such as CURL, PowerShell, Python, Java, etc. Any of these development tools will provide the mechanism needed to make this API web request.
The example below submits a formatted web request for a fraud report for application id (AppID) 34110.
...
| Code Block |
|---|
{
"data": {
"FraudReportSubmit": {
"cccId": "AAA6198",
"appId": 34110,
"fraudType": "APPLICATION"
}
}
} |
In the hands of a knowledgable API programmer, the schema provides everything needed to construct and execute the FraudReportSubmit operation, including the required argument, Input fields, and the payload response using an API dev tool such as CURL, PowerShell, Python, Java, etc. Any of these development tools will provide the
In the hands of a GraphQL tool, such as CURL, the operation must be formatted as a web request (web request object) - have to have the skill set to know how to do that. We provide the schema and information to do that
...
A Mutation type is a special root type that is used to modify server-side data. Just like in queries, if the mutation field returns an object type, you can ask for nested fields. It can also contain multiple fields. However, unlike queries, mutation fields run in series, one after the other.
Learn more about GraphQL mutations
...
With a basic understanding of the operation and their API account with the appropriate credentials and configured attributes, a skilled API programmer has everything they need to effectively format a proper web request using an application development tool such as Curl, Python, PowerShell, etc.
Submit a Fraud Report Using Postman
...