Skip to content

JudicialCouncilOfCalifornia/ota-servicebus-sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OTA Two-way Service Bus Sample

The ATP Two-Way CMS Interface Exchange will enable the court to subscribe and consume the ATP data, asynchronously, via a standard electronic interface/API.


Getting Started

Sample Projects

We have some sample projects to get you started in these formats:

Configuration Settings

You will need to replace configuration settings provided to you by the JCC Project Manager. If you connect to a Topic:

  • TenantId
  • ClientId
  • ClientSecret
  • ServiceBusNamespace
  • TopicName
  • SubscriptionName

If you connect to a Queue:

  • ServiceBusNamespace
  • QueueName
  • SharedAccessKey
  • SharedAccessKeyName

Case Action

Trigger Actions

The following actions in the ATP tool will trigger the Case Action message:

The schema for the ATP Case Action message (Topic)

The Case Action Message has fields of type String, DateTime, Number and Boolean. They can all contain null values.

Name Type Description
requestId String Unique identifier for the request
caseNumber String Case Number
citationNumber String Citation Number
county String County
triggerAction String Action that triggered the message.
Valid values are:
  • "Submitted"
  • "Approved"
  • "Rejected"
  • "Order Served"
  • "Vacated"
petitioner String Petitioner
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
petitionerPhoneNumber String Petitioner’s phone number
petitionerEmail String Petitioner’s email address
petitionSubmittedOn DatTime Date the petition was submitted on
isCommunityService Boolean Indicates whether Community Service option is selected by the defendant during petition submission
isMoreTimeToPay Boolean Indicates whether More Time To Pay option is selected by the defendant during petition submission
isPaymentPlan Boolean Indicates whether Payment Plan option is selected by the defendant during petition submission
isReductionOfPayment Boolean Indicates whether Reduction of Fines option is selected by the defendant during petition submission
petitionSubmission Based64 Defendant submission base64 file
judgment String Judgment
Valid values are:
  • "Approved"
  • "Rejected"
judgmentBy String Judgment By
judgmentByRole String Judgment By Role
Valid values are:
  • "Court Clerk"
  • "Judicial Officer"
judgmentDate DateTime Date the judgment was made on
denialReason String Reason for denying the petition
rejectionDate String Date the petition was rejected on
reducedAmountAccept Boolean Indicates whether Reduction of Fines is accepted
reducedAmountDeny Boolean Indicates whether Reduction of Fines is denied
finalReducedAmount Number Final Reduced Amount
amountOfReduction Double Amount of Reduction
expressFindingsComments String Express Findings made when the calculated/recommended amount in increased by the judicial officer
additionalComments String Additional Comments
paymentPlanAccept Boolean Indicates whether Payment Plan is accepted
paymentPlanDeny Boolean Indicates whether Payment Plan is denied
finalMonthlyPaymentAmount Number Final Monthly Payment Amount
monthlyPaymentDate DateTime Monthly Payment Date
moreTimeAccept Boolean Indicates whether More Time to Pay is accepted
moreTimeDeny Boolean Indicates whether More Time to Pay is denied
moreTimeToPayAmount Number More Time to Pay Amount
moreTimeToPayByDate DateTime More Time to Pay by Date
communityServiceAccept Boolean Indicates whether Community Service is accepted
communityServiceDeny Boolean Indicates whether Community Service is denied
judgeOrderedCommunityServiceHours Number Number of Community Service Hours Judge ordered
judgeOrderedCommunityServiceDueDate DateTime Due Date by which the defendant has to complete
the Community Service Hours
orderServedBy String Order Served By
orderServedStatus Boolean Indicates whether the Order was served or not
orderServedDate DateTime Date the Order was served
plea String Indicates what plea the Defendant took
Valid values are:
  • "Guilty"
  • "No Contest"
allRightsWaived Boolean Indicates whether the Defendant waived all the rights
totalDueAmount Number Total Amount Due by the Defendant
reducedAmountPayByDate DateTime Date by when the Defendant has to pay the reduced amount
recommendedReducedAmountPayByDate DateTime ATP Tool recommended Date by when the Defendant
has to pay the reduced amount
adjudicated Boolean Indicates whether the case was adjudicated or not
vacatedBy String Vacated By
vacatedDate DateTime Date the Order was vacated
vacatedReason String Reason for vacating the order
atpOrder String Base64 format of the final ATP Order

Messages

Petition is submitted by the Defendant

Name Type Description
requestId String Unique identifier for the request
caseNumber String Case Number
citationNumber String Citation Number
county String County
triggerAction String Action that triggered the message
Valid value is "Submitted"
petitioner String Petitioner
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
petitionerPhoneNumber String Petitioner’s phone number
petitionerEmail String Petitioner’s email address
petitionSubmittedOn DateTime Date the petition was submitted on
plea String Indicates what plea the Defendant took
Valid values are:
  • "Guilty"
  • "No Contest"
isCommunityService Boolean Indicates whether Community Service option is selected by the defendant during petition submission
isMoreTimeToPay Boolean Indicates whether More Time To Pay option is selected by the defendant during petition submission
isPaymentPlan Boolean Indicates whether Payment Plan option is selected by the defendant during petition submission
isReductionOfPayment Boolean Indicates whether Reduction of Fines option is selected by the defendant during petition submission
petitionSubmission Based64 Defendant submission base64 file

Sample Message:

{
    "requestId" : "614e7eff8d5502c2f0d6336e",
    "caseNumber": "INF-19-C19037936",
    "citationNumber": "C19037936",
    "county": "San Francisco",
    "triggerAction": "Submitted",
    "petitioner": "John Doe",
    "petitionerFirstName": "John",
    "petitionerLastName": "Doe",
    "petitionerPhoneNumber": "(213) 555-1212",
    "petitionerEmail": "john.doe@johndoe.com",
    "plea": null,
    "isCommunityService": false,
    "isMoreTimeToPay": false,
    "isPaymentPlan": false,
    "isReductionOfPayment": true,
    "petitionSubmittedOn": "2019-01-01T03:59:15.561Z",
    "petitionerSubmission": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Petition is approved by Judicial Officer

Name Type Description
requestId String Unique identifier for the request
caseNumber String Case Number
citationNumber String Citation Number
county String County
triggerAction String Action that triggered the message
Valid value is "Approved"
petitioner String Petitioner
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
petitionSubmittedOn DatTime Date the petition was submitted on
plea String Indicates what plea the Defendant took
Valid values are:
  • "Guilty"
  • "No Contest"
allRightsWaived Boolean Indicates whether the Defendant waived all the rights
adjudicated Boolean Indicates whether the case was adjudicated or not
judgment String Judgment
Valid values are:
  • "Approved"
  • "Rejected"
judgmentBy String Judgment By
judgmentByRole String Judgment By Role
Valid values are:
  • "Court Clerk"
  • "Judicial Officer"
judgmentDate DateTime Date the judgment was made on
reducedAmountAccept Boolean Indicates whether Reduction of Fines is accepted
reducedAmountDeny Boolean Indicates whether Reduction of Fines is denied
totalDueAmount Number Total Amount Due by the Defendant
finalReducedAmount Number Final Reduced Amount
amountOfReduction Double Amount of Reduction
recommendedReducedAmountPayByDate DateTime ATP Tool recommended Date by when the Defendant
has to pay the reduced amount
reducedAmountPayByDate DateTime Date by when the Defendant has to pay the reduced amount
expressFindingsComments String Express Findings made when the calculated/recommended amount in increased by the judicial officer
additionalComments String Additional Comments
paymentPlanAccept Boolean Indicates whether Payment Plan is accepted
paymentPlanDeny Boolean Indicates whether Payment Plan is denied
finalMonthlyPaymentAmount Number Final Monthly Payment Amount
monthlyPaymentDate DateTime Monthly Payment Date
moreTimeAccept Boolean Indicates whether More Time to Pay is accepted
moreTimeDeny Boolean Indicates whether More Time to Pay is denied
moreTimeToPayAmount Number More Time to Pay Amount
moreTimeToPayByDate DateTime More Time to Pay by Date
communityServiceAccept Boolean Indicates whether Community Service is accepted
communityServiceDeny Boolean Indicates whether Community Service is denied
judgeOrderedCommunityServiceHours Number Number of Community Service Hours Judge ordered
judgeOrderedCommunityServiceDueDate DateTime Due Date by which the defendant has to complete
the Community Service Hours

Sample Message:

{
    "requestId" : "614e7eff8d5502c2f0d6336e",
    "caseNumber": "INF-19-C19037936",
    "citationNumber": "C19037936",
    "county": "San Francisco",
    "triggerAction": "Approved",
    "petitioner": "John Doe",
    "petitionerFirstName": "John",
    "petitionerLastName": "Doe"
    "petitionSubmittedOn": "2019-01-01T03:59:15.561Z",
    "plea": "Guilty",
    "allRightsWaived": true,
    "adjudicated": false,
    "judgment": "Approved",
    "judgmentBy": "Chris Smith",
    "judgmentByRole": "Judicial Officer",
    "judgmentDate": "2019-01-01T03:59:15.561Z",
    "reducedAmountAccept": true,
    "reducedAmountDeny": null,
    "totalDueAmount": 234,
    "finalReducedAmount": 117,
    "amountOfReduction": 117,
    "recommendedReducedAmountPayByDate": "2019-05-31T03:59:15.561Z",
    "reducedAmountPayByDate": "2019-05-31T03:59:15.561Z",
    "expressFindingsComments": null,
    "additionalComments": null,
    "paymentPlanAccept": null,
    "paymentPlanDeny": null,
    "finalMonthlyPaymentAmount": null,
    "monthlyPaymentDate": null,
    "moreTimeAccept": null,
    "moreTimeDeny": null,
    "moreTimeToPayAmount": null,
    "moreTimeToPayByDate": null,
    "communityServiceAccept": null,
    "communityServiceDeny": null,
    "judgeOrderedCommunityServiceHours": null,
    "judgeOrderedCommunityServiceDueDate": null
}

Petition is denied by Judicial Officer

Name Type Description
requestId String Unique identifier for the request
caseNumber String Case Number
citationNumber String Citation Number
county String County
triggerAction String Action that triggered the message
Valid value is "Rejected"
petitioner String Petitioner
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
petitionSubmittedOn DateTime Date the petition was submitted on
judgment String Judgment
Valid value is "Rejected"
judgmentBy String Judgment By
judgmentByRole String Judgment By Role
Valid values are:
  • "Court Clerk"
  • "Judicial Officer"
judgmentDate DateTime Date the judgment was made on
denialReason String Reason for denying the petition
rejectionDate DateTime Date the petition was rejected on

Sample Message:

{
    "requestId" : "614e7eff8d5502c2f0d6336e",
    "caseNumber": "INF-19-C19037936",
    "citationNumber": "C19037936",
    "county": "San Francisco",
    "triggerAction": "Rejected",
    "petitioner": "John Doe",
    "petitionerFirstName": "John",
    "petitionerLastName": "Doe"
    "petitionSubmittedOn": "2019-01-01T03:59:15.561Z",
    "judgment": "Rejected",
    "judgmentBy": "Chris Smith",
    "judgmentByRole": "Judicial Officer",
    "judgmentDate": "2019-01-01T03:59:15.561Z",
    "denialReason": "Petition is denied by Judicial Officer",
    "rejectionDate": "2019-01-01T03:59:15.561Z"
}

Order is served by the Court Clerk

Name Type Description
caseNumber String Case Number
citationNumber String Citation Number
county String County
triggerAction String Action that triggered the message
Valid value is "Order Served"
petitioner String Petitioner
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
petitionSubmittedOn DateTime Date the petition was submitted on
orderServedBy String Order Served By
orderServedStatus Boolean Indicates whether the Order was served or not
orderServedDate DateTime Date the Order was served
atpOrder String Base64 format of the final ATP Order

Sample Message:

{
    "requestId" : "614e7eff8d5502c2f0d6336e",
    "caseNumber": "INF-19-C19037936",
    "citationNumber": "C19037936",
    "county": "San Francisco",
    "triggerAction": "Order Served",
    "petitioner": "John Doe",
    "petitionerFirstName": "John",
    "petitionerLastName": "Doe"
    "petitionSubmittedOn": "2019-01-01T03:59:15.561Z",
    "orderServedBy": "John Doe",
    "orderServedStatus": true,
    "orderServedDate": "2019-01-01T03:59:15.561Z",
    "atpOrder": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Order is vacated by the Court Administrator

Name Type Description
requestId String Unique identifier for the request
caseNumber String Case Number
citationNumber String Citation Number
county String County
petitionerFirstName String Petitioner firstname
petitionerLastName String Petitioner lastname
triggerAction String Action that triggered the message
Valid value is "Vacated"
petitioner String Petitioner
petitionSubmittedOn DateTime Date the petition was submitted on
vacatedBy String Vacated By
vacatedDate DateTime Date the Order was vacated
vacatedReason String Reason for vacating the order

Sample Message:

{
    "requestId" : "614e7eff8d5502c2f0d6336e",
    "caseNumber": "INF-19-C19037936",
    "citationNumber": "C19037936",
    "county": "San Francisco",
    "petitionerFirstName": "John",
    "petitionerLastName": "Doe"
    "triggerAction": "Vacated",
    "petitioner": "John Doe",
    "petitionSubmittedOn": "2019-01-01T03:59:15.561Z",
    "vacatedBy": "John Doe",
    "vacatedDate": "2019-01-01T03:59:15.561Z",
    "vacatedReason": "Correction in case needed"
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors