Backend operations for the L.A. County Public Defender's modernized database project.
1. Service Request
| METHOD | ENDPOINT | DESCRIPTION |
|---|---|---|
| GET | service_requests | Gets all the service requests in the database |
| GET | service_requests/{requestNumber} | Get a specific service request based on requestNumber |
| POST | service_requests | Add a service request |
| PATCH | service_requests/{requestNumber} | Update a service request |
| DELETE | service_requests/{requestNumber} | Delete a service request |
2. Request Status
| METHOD | ENDPOINT | DESCRIPTION |
|---|---|---|
| GET | request_statuses/{id} | Get the service request's request status |
3. Admin
| METHOD | ENDPOINT | DESCRIPTION |
|---|---|---|
| GET | admin/service_requests | Gets all the service requests (condensed to 4 fields) in the database |
| GET | admin/service_requests/{requestNumber} | Get a specific service request based on requestNumber |
| PATCH | admin/service_requests/{requestNumber} | Make completely unrestricted updates to any service request fields |
| PATCH | admin/reset_password | Update password with new-password header |
| GET | div_chief_managers | Get all Div Chief Managers |
| GET | div_chief_managers/{id} | Get a Div Chief Manager based on id |
| POST | div_chief_managers | Add a new Div Chief Manager |
| PATCH | div_chief_managers/{id} | Update a Div Chief Manager |
| DELETE | div_chief_managers/{id} | Delete a Div Chief Manager |
| GET | dept_info_security_officers | Get all Dept Info Security Officers |
| GET | dept_info_security_officers/{id} | Get a Dept Info Security Officer based on id |
| POST | dept_info_security_officers | Add a new Dept Info Security Officer |
| PATCH | dept_info_security_officers/{id} | Update a Dept Info Security Officer |
| DELETE | dept_info_security_officers/{id} | Delete a Dept Info Security Officer |
| GET | department_heads | Get all Department Heads |
| GET | department_heads/{id} | Get a Department Head based on id |
| POST | department_heads | Add a new Department Head |
| PATCH | department_heads/{id} | Update a Department Head |
| DELETE | department_heads/{id} | Delete a Department Head |
| GET | application_coordinators | Get all Application Coordinators |
| GET | application_coordinators/{id} | Get an Application Coordinator based on id |
| POST | application_coordinators | Add an new Application Coordinator |
| PATCH | application_coordinators/{id} | Update an Application Coordinator |
| DELETE | application_coordinators/{id} | Delete an Application Coordinator |
Admin Password: pass123
- Download repository to your PC
- Import to Eclipse (or IDE of choice) as Maven project
- Import values into your SQL server from src/main/resources/backend.sql
- Update application.properties to reflect your SQL database as noted:
- spring.datasource.url=jdbc:mysql://{hostname}:{port}/{database}
- spring.datasource.username={username}
- spring.datasource.password={password}
- Run DemoApplication.java
- Test the 4 endpoints by opening them in your browser. All but service_requests should be populated at this point:
- http://{hostname}:{port}/fields
- http://{hostname}:{port}/forms
- http://{hostname}:{port}/mappings
- http://{hostname}:{port}/service_requests
Your backend is now running! Feel free to test the service_requests endpoint by entering the following POST request into Postman Desktop:
{
"newRegistration":true,
"deletePriorRegistration":false,
"updatePriorRegistration":false,
"replaceLostToken":false,
"addLogonId":true,
"changeLogonId":false,
"deleteLogonId":false,
"lastName":"Doe",
"firstName":"John",
"middleInitial":"F",
"employeeNumber":"15",
"departmentName":"Example Department",
"departmentNumber":"512",
"companyName":"Jim's Burgers",
"companyEmailAddress":"jgarc659@calstatela.edu",
"countyEmailAddress":"example@lacounty.gov",
"employeeEmailAddress":"employee@publicdefender.gov",
"businessStreetAddress":"500 Example Ave.",
"businessCity":"Los Angeles",
"businessState":"CA",
"businessZip":"90032",
"businessPhoneNumber":"555-263-8342",
"workMailingAddress":"100 3rd St, Los Angeles, CA, 90032",
"companyStreetAddress":"123 Apple St.",
"companyCity":"Los Angeles",
"companyState":"CA",
"companyZip":"90032",
"companyPhoneNumber":"232-626-1673",
"countyPhoneNumber":"612-626-7832",
"contractWorkOrderNumber":"C2672721",
"contractExpirationDate":"06/01/2021",
"ibmLogOnId":"23626",
"majorGroupCode":"272727",
"lsoGroupCode":"2352762",
"securityAuthorization":"Authorization",
"tsoAccess":true,
"tsoGroupCode":"Group Code",
"binNumber":"Bin Number",
"subGroup1":"Test Subgroup",
"subGroup2":"Test Subgroup",
"subGroup3":"Test Subgroup",
"onlineAccess":true,
"systemApplication":"System Application",
"groupName":"Test Group",
"oldGroup":"Old Group",
"unixAddLogonId":true,
"unixChangeLogonId":false,
"unixDeleteLogonId":false,
"unixLogOnId":"261361",
"unixApplication":"Unix Application",
"unixAccessGroup":"Unix Access Group",
"unixAccountNumber":"Unix Account Number",
"billingAccountNumber":"844362",
"securIdVpn":false,
"adaptiveAuthenticationVpn":false,
"internetApplication":true,
"exchangeEmail":false,
"emailEncryption":false,
"laCountyGovAccess":true,
"tokenlessAuthentication":false,
"lacMobileWifiAccess":true,
"cherwellSms":false,
"windowsRightsMgmt":false,
"gmailAccess":true,
"yahooMailAccess":false,
"otherEmailAccess":false,
"businessJustification":"Access required to these technologies.",
"defaultCountyWidePolicy":false,
"departmentPolicyRule0":false,
"departmentPolicyRule1":true,
"departmentPolicyRule2":false,
"departmentPolicyRule3":false,
"departmentPolicyRule4":false,
"socialNetworkingFacebook":true,
"socialNetworkingTwitter":false,
"socialNetworkingLinkedIn":false,
"complete":false,
"employee":false
}
More detailed instructions in src/main/resources/HowToRunBackend.pdf
Common Request Statuses
| STATUS ORIGIN | CODE | DESCRIPTION |
|---|---|---|
| Backend App | DRAFT | The Service Request is saved but not yet submitted by the user. |
| Backend App | SUBMITTED_FOR_REVIEW | The Service Request is submitted by the user for Admin review. |
| Adobe Sign API | CREATED | Agreement has been created and signing initiated. |
| Adobe Sign API | ACTION_REQUESTED | Email sent to current recipient to sign Agreement. |
| Adobe Sign API | EMAIL_VIEWED | Current recipient has seen Adobe Sign email. |
| Adobe Sign API | ACTION_COMPLETED | Recipient has signed/approved the Agreement. This would also be the status code for a fully-signed Agreement. |
| Adobe Sign API | RECALLED | Adobe Sign user has cancelled Agreement. |
Full List of Adobe Sign API Request Status Codes:
['ACCESS_CODE_GENERATED' or 'ACCESS_CODE_CONSUMED' or 'AUTO_CANCELLED_CONVERSION_PROBLEM' or 'ACTION_AUTO_DELEGATED' or 'ACTION_COMPLETED' or 'ACTION_COMPLETED_HOSTED' or 'ACTION_COMPLETED_OFFLINE' or 'ACTION_COMPLETED_OFFLINE_HOSTED' or 'ACTION_COMPLETED_WIDGET_VERIFIED' or 'ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN' or 'ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED' or 'ACTION_DELEGATED' or 'ACTION_REPLACED_SIGNER' or 'ACTION_REQUESTED' or 'CREATED' or 'CREATED_FROM_WIDGET' or 'CREATED_OFFLINE' or 'CREATED_VIA_UPLOAD' or 'CREATED_VIA_ACROBAT' or 'CREATED_VIA_READER' or 'ACTIVATED' or 'DIGITAL_SIGN_UIDAI_SIGNER_CONSENT' or 'DIGSIGNED' or 'DEACTIVATED' or 'DOCUMENTS_DELETED' or 'DOWNLOADED' or 'EMAIL_BOUNCED' or 'EMAIL_VIEWED' or 'EXPIRED' or 'EXPIRED_AUTOMATICALLY' or 'FAXED_BY_SENDER' or 'FAXIN_RECEIVED' or 'KBA_AUTHENTICATED' or 'MODIFIED' or 'OFFLINE_SYNC' or 'OTHER' or 'PAID' or 'PRESIGNED' or 'RECALLED' or 'RECALLED_MAX_SIGNING_KBA_ATTEMPTS' or 'RECALLED_MAX_SIGNING_PASSWORD_ATTEMPTS' or 'RECALLED_MAX_SIGNING_PHONE_ATTEMPTS' or 'REJECTED' or 'SENDER_CREATED_NEW_REVISION' or 'SHARED' or 'SIGNED' or 'SIGNING_URL_REQUESTED' or 'UPLOADED_BY_SENDER' or 'USER_ACK_AGREEMENT_MODIFIED' or 'READY_TO_VAULT' or 'VAULTED' or 'WEB_IDENTITY_AUTHENTICATED' or 'WEB_IDENTITY_SPECIFIED' or 'WRITTEN_DOWNLOAD' or 'WRITTEN_SIGNED']