Versions Compared

Key

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

...

In the screenshot below, an example of a basic fraud submit operation is built in the Apollo sandbox.

In the Operation section, a FraudReportSubmit mutation is built 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, the “appId” field as been added as the only input variable for this basic operation (currently displaying a null value).

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#FFFFFF

Before submitting the request, a value would be entered in the “appId” input field (as shown below).

Image RemovedImage Added
Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

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).

Image RemovedImage Added

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

...

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 Taking a closer look at the same operation in the Apollo sandbox, you can see that the

...

Variable table - where you can provide the information to submit (legitimate AppId for your MIScode).

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

...