API docs by Redocly

Discrepancy Reports Service (1.0)

Download OpenAPI specification:Download

SubmitReport

Submits a new Discrepancy Report

Request Body schema: application/json
required

Discrepancy Report data

resolutionUri
required
string <uri>
reportType
required
string
discrepancyReportSubmitTimeStamp
required
string <date-time>
discrepancyReportId
required
string
reportingAgencyName
required
string
reportingAgentId
string
reportingContactJcard
required
string
problemService
string
problemSeverity
required
string
problemComments
string
policyType
string
policyQueueName
string
policyId
string
policyAgencyName
required
string
problem
required
string
Enum: "PolicyInvalid" "PolicyAltered" "SignatureVerificationFailure" "PolicyMissing" "OtherPolicyStore"
retrievePolicyResponse
required
string

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "resolutionUri": "https://agencyX.com/DiscrepancyReports/resolutions",
  • "reportType": "PolicyStoreDiscrepancyReport",
  • "discrepancyReportSubmitTimeStamp": "2020-03-10T10:00:00-05:00",
  • "discrepancyReportId": "string",
  • "reportingAgencyName": "string",
  • "reportingAgentId": "string",
  • "reportingContactJcard": "string",
  • "problemService": "string",
  • "problemSeverity": "string",
  • "problemComments": "string",
  • "policyType": "string",
  • "policyQueueName": "string",
  • "policyId": "string",
  • "policyAgencyName": "string",
  • "problem": "PolicyInvalid",
  • "retrievePolicyResponse": "string"
}

Response samples

Content type
application/json
{
  • "respondingAgencyName": "string",
  • "respondingContactJcard": "string",
  • "respondingAgentId": "string",
  • "responseEstimatedReturnTime": "2020-03-10T10:00:00-05:00",
  • "responseComments": "string"
}

Callback payload samples

Callback
POST: {#/components/schemas/DiscrepancyReport/resolutionUri}
Content type
application/json
{
  • "respondingAgencyName": "string",
  • "respondingContactJcard": "string",
  • "respondingAgentId": "string",
  • "discrepancyReportId": "string",
  • "reportingAgencyName": "string",
  • "problemService": "string",
  • "responseTime": "2020-03-10T10:00:00-05:00",
  • "reportingAgentId": "string",
  • "responseComments": "string",
  • "resolution": "DiscrepancyCorrected"
}

SubmitResolution

Submits a new Discrepancy Resolution

Request Body schema: application/json
required

Discrepancy Resolution data

respondingAgencyName
required
string
respondingContactJcard
required
string
respondingAgentId
string
discrepancyReportId
required
string
reportingAgencyName
required
string
problemService
required
string
responseTime
required
string <date-time>
reportingAgentId
string
responseComments
string
resolution
required
string
Enum: "DiscrepancyCorrected" "NoDiscrepancy" "OtherResponse" "PolicyAdded" "PolicyUpdated" "NoSuchPolicy" "InsufficientCredentials" "EntryAdded" "PerPolicy" "CallTakerAdvised" "TransferCorrect" "BadCertificateChain" "DataCorrected" "RecordsCorrected" "PermissionsCorrected" "DeviceConfigError" "PolicyCorrected" "NoError" "ProblemCorrected" "InvalidRecord" "Gis" "Acknowledged" "OtherResponse"

Responses

Request samples

Content type
application/json
{
  • "respondingAgencyName": "string",
  • "respondingContactJcard": "string",
  • "respondingAgentId": "string",
  • "discrepancyReportId": "string",
  • "reportingAgencyName": "string",
  • "problemService": "string",
  • "responseTime": "2020-03-10T10:00:00-05:00",
  • "reportingAgentId": "string",
  • "responseComments": "string",
  • "resolution": "DiscrepancyCorrected"
}

GetResolution

Retrieves a Discrepancy Report Resolution based on Agency Name and Discrepancy Report ID

query Parameters
agencyName
required
string

Reporting Agency Name

discrepancyReportId
required
string

ID of the Discrepancy Report

Responses

Response samples

Content type
application/json
{
  • "respondingAgencyName": "string",
  • "respondingContactJcard": "string",
  • "respondingAgentId": "string",
  • "discrepancyReportId": "string",
  • "reportingAgencyName": "string",
  • "problemService": "string",
  • "responseTime": "2020-03-10T10:00:00-05:00",
  • "reportingAgentId": "string",
  • "responseComments": "string",
  • "resolution": "DiscrepancyCorrected"
}

StatusUpdateRequest

Request a Status Update for a previously submitted Discrepancy Report

query Parameters
agencyName
required
string

Reporting Agency Name

discrepancyReportId
required
string

ID of the Discrepancy Report

Responses

Response samples

Content type
application/json
{
  • "respondingAgencyName": "string",
  • "respondingContactJcard": "string",
  • "respondingAgentId": "string",
  • "responseEstimatedReturnTime": "2020-03-10T10:00:00-05:00",
  • "statusComments": "string"
}

RetrieveVersions

Retrieves all supported versions, vendor parameter is optional.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "fingerprint": "string"
}