Florida Safe Families...

Florida Safe Families Network

10/09/2019 Server Side Mobile CO Technical Topic Paper

of 252

Revision 2.0


Mobile Tools XML/Web Services Design Document

Prepared for State of Florida

Department of Children and Families

October 9, 2019



of 252

Revision 2.0

Table of Contents

1. Introduction .................................................................................................................................. 8

1.1. General Purpose of this Document .................................................................................................... 8

1.2. How to Invoke the Webservices ........................................................................................................ 8

1.3. Primer for Webservice Guides .......................................................................................................... 8 1.1.1. Functional Description ..................................................................................................................................................... 8 1.1.2. Input Schema .................................................................................................................................................................... 8 1.1.3. Input Variables ................................................................................................................................................................. 8 1.1.4. Example Input .................................................................................................................................................................. 9 1.1.5. Output Schema ............................................................................................................................................................... 11 1.1.6. Output Variables ............................................................................................................................................................. 11 1.1.7. Example Output .............................................................................................................................................................. 12 1.1.8. Error Guide ..................................................................................................................................................................... 13 1.1.9. Sort Sequence ................................................................................................................................................................. 13 1.1.10. XML Processing ............................................................................................................................................................. 13 1.1.11. CRUD Matrix ................................................................................................................................................................. 13

1.2. Security............................................................................................................................................ 13 1.2.1. Input Variables ............................................................................................................................................................... 13 1.2.2. Example Input ................................................................................................................................................................ 14 1.2.3. Error Guide ..................................................................................................................................................................... 14

2. Individual Web Services Technical Information ........................................................................ 14

2.1. Web Service: getOrgWorkerRoleList ............................................................................................. 14 2.1.1. Functional Description.................................................................................................................................................... 14 2.1.2. Input Schema .................................................................................................................................................................. 14 2.1.3. Input Variables ............................................................................................................................................................... 15 2.1.4. Example Input ................................................................................................................................................................ 15 2.1.5. Output Schema ............................................................................................................................................................... 17 2.1.6. Output Variables ............................................................................................................................................................. 17 2.1.7. Example Output .............................................................................................................................................................. 19 2.1.8. Error Guide ..................................................................................................................................................................... 20 2.1.9. Sort Sequence ................................................................................................................................................................. 20 2.1.10. XML Processing ............................................................................................................................................................. 20 2.1.11. CRUD Matrix ................................................................................................................................................................. 20

2.2. Web Service: getAssignedCaseList ................................................................................................. 20 2.2.1. Functional Description ................................................................................................................................................... 20 2.2.2. Input Schema .................................................................................................................................................................. 20 2.2.3. Input Variables ............................................................................................................................................................... 21 2.2.4. Example Input ................................................................................................................................................................ 21 2.2.5. Output Schema ............................................................................................................................................................... 22 2.2.6. Output Variables ............................................................................................................................................................. 22 2.2.7. Example output ............................................................................................................................................................... 24 2.2.8. Error Guide ..................................................................................................................................................................... 26 2.2.9. Sort Sequence ................................................................................................................................................................. 26 2.2.10. XML Processing ............................................................................................................................................................. 26 2.2.11. CRUD Matrix ................................................................................................................................................................. 26

2.3. Web Service: getCaseDetails ........................................................................................................... 26 2.3.1. Functional Description ................................................................................................................................................... 26 2.3.2. Input Schema .................................................................................................................................................................. 27 2.3.3. Input Variables ............................................................................................................................................................... 27 2.3.4. Example Input ................................................................................................................................................................ 29 2.3.5. Output Schema ............................................................................................................................................................... 30 2.3.6. Output Variables ............................................................................................................................................................. 45 2.3.7. Example Output .............................................................................................................................................................. 76 2.3.8. Error Guide ..................................................................................................................................................................... 91 2.3.9. Sort Sequence ................................................................................................................................................................. 91 2.3.10. XML Processing ............................................................................................................................................................. 91 2.3.11. CRUD Matrix ................................................................................................................................................................. 91

2.4. Web Service: getCodeDecodeList ................................................................................................... 92 2.4.1. Functional Description.................................................................................................................................................... 92



of 252

Revision 2.0

2.4.2. Input Schema .................................................................................................................................................................. 94 2.4.3. Input Variables ............................................................................................................................................................... 94 2.4.4. Example Input ................................................................................................................................................................ 95 2.4.5. Output Schema ............................................................................................................................................................... 95 2.4.6. Output Variables ............................................................................................................................................................. 96 2.4.7. Example Output .............................................................................................................................................................. 97 2.4.8. Error Guide ..................................................................................................................................................................... 98 2.4.9. Sort Sequence ................................................................................................................................................................. 99 2.4.10. XML Processing ............................................................................................................................................................. 99 2.4.11. CRUD Matrix ................................................................................................................................................................. 99

2.5. Web Service: getCaseDocumentList ............................................................................................... 99 2.5.1. Functional Description.................................................................................................................................................... 99 2.5.2. Input Schema .................................................................................................................................................................. 99 2.5.3. Input Variables ............................................................................................................................................................... 99 2.5.4. Example Input .............................................................................................................................................................. 100 2.5.5. Output Schema ............................................................................................................................................................. 100 2.5.6. Output Variables ........................................................................................................................................................... 101 2.5.7. Example Output ............................................................................................................................................................ 103 2.5.8. Error Guide ................................................................................................................................................................... 104 2.5.9. Sort Sequence ............................................................................................................................................................... 104 2.5.10. XML Processing ........................................................................................................................................................... 104 2.5.11. CRUD Matrix ............................................................................................................................................................... 104

2.6. Web Service: getCaseDocument ................................................................................................... 104 2.6.1. Functional Description.................................................................................................................................................. 104 2.6.2. Input Schema ................................................................................................................................................................ 105 2.6.3. Input Variables ............................................................................................................................................................. 105 2.6.4. Example Input .............................................................................................................................................................. 105 2.6.5. Output Schema ............................................................................................................................................................. 106 2.6.6. Output Variables ........................................................................................................................................................... 106 2.6.7. Example Output ............................................................................................................................................................ 107 2.6.8. Error Guide ................................................................................................................................................................... 107 2.6.9. Sort Sequence ............................................................................................................................................................... 107 2.6.10. XML Processing ........................................................................................................................................................... 107 2.6.11. CRUD Matrix ............................................................................................................................................................... 108

2.7. Web Service: getChildPhotoList ................................................................................................... 108 2.7.1. Functional Description.................................................................................................................................................. 108 2.7.2. Input Schema ................................................................................................................................................................ 108 2.7.3. Input Variables ............................................................................................................................................................. 108 2.7.4. Example Input .............................................................................................................................................................. 108 2.7.5. Output Schema ............................................................................................................................................................. 109 2.7.6. Output Variables ........................................................................................................................................................... 110 2.7.7. Example output ............................................................................................................................................................. 111 2.7.8. Error Guide ................................................................................................................................................................... 113 2.7.9. Sort Sequence ............................................................................................................................................................... 113 2.7.10. XML Processing ........................................................................................................................................................... 113 2.7.11. CRUD Matrix ............................................................................................................................................................... 113

2.8. Web Service: getChildPhoto ......................................................................................................... 113 2.8.1. Functional Description.................................................................................................................................................. 113 2.8.2. Input Schema ................................................................................................................................................................ 113 2.8.3. Input Variables ............................................................................................................................................................. 113 2.8.4. Example Input .............................................................................................................................................................. 114 2.8.5. Output Schema ............................................................................................................................................................. 115 2.8.6. Output Variables ........................................................................................................................................................... 115 2.8.7. Example Output ............................................................................................................................................................ 115 2.8.8. Error Guide ................................................................................................................................................................... 116 2.8.9. Sort Sequence ............................................................................................................................................................... 116 2.8.10. XML Processing ........................................................................................................................................................... 116 2.8.11. CRUD Matrix ............................................................................................................................................................... 116

2.9. Web Service: saveChildPhoto ....................................................................................................... 116 2.9.1. Functional Description.................................................................................................................................................. 116 2.9.2. Input Schema ................................................................................................................................................................ 117 2.9.3. Input Variables ............................................................................................................................................................. 117 2.9.4. Example Input .............................................................................................................................................................. 119 2.9.5. Output Schema ............................................................................................................................................................. 120 2.9.6. Output Variables ........................................................................................................................................................... 120



of 252

Revision 2.0

2.9.7. Example output ............................................................................................................................................................. 120 2.9.8. Error Guide ................................................................................................................................................................... 121 2.9.9. Sort Sequence ............................................................................................................................................................... 122 2.9.10. XML Processing ........................................................................................................................................................... 122 2.9.11. CRUD Matrix ............................................................................................................................................................... 122

2.10. Web Service: saveCaseDataXml ................................................................................................... 122 2.10.1. Functional Description.................................................................................................................................................. 122 2.10.2. Input Schema ................................................................................................................................................................ 123 2.10.3. Input Variables ............................................................................................................................................................. 127 2.10.4. Example Input .............................................................................................................................................................. 141 2.10.5. Output Schema ............................................................................................................................................................. 144 2.10.6. Output Variables ........................................................................................................................................................... 144 2.10.7. XML Example output ................................................................................................................................................... 145 2.10.8. Error Guide ................................................................................................................................................................... 146 2.10.9. Sort Sequence ............................................................................................................................................................... 148 2.10.10. XML Processing ........................................................................................................................................................... 148 2.10.11. CRUD Matrix ............................................................................................................................................................... 148

2.11. Web Service: getCaseDataXmlList ............................................................................................... 149 2.11.1. Functional Description.................................................................................................................................................. 149 2.11.2. Input Schema ................................................................................................................................................................ 149 2.11.3. Input Variables ............................................................................................................................................................. 149 2.11.4. Example Input .............................................................................................................................................................. 149 2.11.5. Output Schema ............................................................................................................................................................. 150 2.11.6. Output Variables ........................................................................................................................................................... 151 2.11.7. Example Output ............................................................................................................................................................ 151 2.11.8. Error Guide ................................................................................................................................................................... 152 2.11.9. Sort Sequence ............................................................................................................................................................... 152 2.11.10. XML Processing ........................................................................................................................................................... 152 2.11.11. CRUD Matrix ............................................................................................................................................................... 152

2.12. Web Service: getCaseDataXml ..................................................................................................... 152 2.12.1. Functional Description.................................................................................................................................................. 152 2.12.2. Input Schema ................................................................................................................................................................ 153 2.12.3. Input Variables ............................................................................................................................................................. 153 2.12.4. Example Input .............................................................................................................................................................. 153 2.12.5. Output Schema ............................................................................................................................................................. 154 2.12.6. Output Variables ........................................................................................................................................................... 155 2.12.7. Example Output ............................................................................................................................................................ 155 2.12.8. Error Guide ................................................................................................................................................................... 156 2.12.9. Sort Sequence ............................................................................................................................................................... 156 2.12.10. XML Processing ........................................................................................................................................................... 156 2.12.11. CRUD Matrix ............................................................................................................................................................... 156

2.13. Web Service: saveMobileCaseDocument ...................................................................................... 156 2.13.1. Functional Description.................................................................................................................................................. 157 2.13.2. Input Schema ................................................................................................................................................................ 157 2.13.3. Input Variables ............................................................................................................................................................. 157 2.13.4. Example Input .............................................................................................................................................................. 159 2.13.5. Output Schema ............................................................................................................................................................. 160 2.13.6. Output Variables ........................................................................................................................................................... 160 2.13.7. Example Output ............................................................................................................................................................ 160 2.13.8. Error Guide ................................................................................................................................................................... 161 2.13.9. Sort Sequence ............................................................................................................................................................... 161 2.13.10. XML Processing ........................................................................................................................................................... 161 2.13.11. CRUD Matrix ............................................................................................................................................................... 162

2.14. Web Service: getMobileCaseDocumentList .................................................................................. 163 2.14.1. Functional Description.................................................................................................................................................. 163 2.14.2. Input Schema ................................................................................................................................................................ 163 2.14.3. Input Variables ............................................................................................................................................................. 163 2.14.4. Example Input .............................................................................................................................................................. 164 2.14.5. Output Schema ............................................................................................................................................................. 164 2.14.6. Example Output ............................................................................................................................................................ 165 2.14.7. Output Variables ........................................................................................................................................................... 166 2.14.8. Error Guide ................................................................................................................................................................... 167 2.14.9. Sort Sequence ............................................................................................................................................................... 167 2.14.10. XML Processing ........................................................................................................................................................... 167 2.14.11. CRUD Matrix ............................................................................................................................................................... 167



of 252

Revision 2.0

2.15. Web Service: getMobileCaseDocument ........................................................................................ 167 2.15.1. Functional Description.................................................................................................................................................. 167 2.15.2. Input Schema ................................................................................................................................................................ 167 2.15.3. Input Variables ............................................................................................................................................................. 168 2.15.4. Example Input .............................................................................................................................................................. 168 2.15.5. Output Schema ............................................................................................................................................................. 169 2.15.6. Output Variables ........................................................................................................................................................... 169 2.15.7. Example Output ............................................................................................................................................................ 169 2.15.8. Error Guide ................................................................................................................................................................... 170 2.15.9. Sort Sequence ............................................................................................................................................................... 170 2.15.10. XML Processing ........................................................................................................................................................... 170 2.15.11. CRUD Matrix ............................................................................................................................................................... 170

2.16. Web Service: getReferenceData .................................................................................................... 170 2.16.1. Functional Description.................................................................................................................................................. 170 2.16.2. Input Schema ................................................................................................................................................................ 170 2.16.3. Input Variables ............................................................................................................................................................. 171 2.16.4. Example Input .............................................................................................................................................................. 171 2.16.5. Output Schema ............................................................................................................................................................. 172 2.16.6. Output Variables ........................................................................................................................................................... 172 2.16.7. Example Output ............................................................................................................................................................ 173 2.16.8. Error Guide ................................................................................................................................................................... 174 2.16.9. Sort Sequence ............................................................................................................................................................... 174 2.16.10. XML Processing ........................................................................................................................................................... 174 2.16.11. CRUD Matrix ............................................................................................................................................................... 174

2.17. Web Service: getAssignedCaseListLite ........................................................................................ 174 2.17.1. Functional Description ................................................................................................................................................. 174 2.17.2. Input Schema ................................................................................................................................................................ 174 2.17.3. Input Variables ............................................................................................................................................................. 174 2.17.4. Example Input .............................................................................................................................................................. 175 2.17.5. Output Schema ............................................................................................................................................................. 175 2.17.6. Output Variables ........................................................................................................................................................... 177 2.17.7. Example Output ............................................................................................................................................................ 179 2.17.8. Error Guide ................................................................................................................................................................... 181 2.17.9. Sort Sequence ............................................................................................................................................................... 181 2.17.10. XML Processing ........................................................................................................................................................... 181 2.17.11. CRUD Matrix ............................................................................................................................................................... 181

2.18. Web Service: updateLegalAction .................................................................................................. 181 2.18.1. Functional Description ................................................................................................................................................. 181 2.18.2. Input Schema ................................................................................................................................................................ 181 2.18.3. Input Variables ............................................................................................................................................................. 182 2.18.4. Example Input .............................................................................................................................................................. 184 2.18.5. Output Schema ............................................................................................................................................................. 185 2.18.6. Output Variables ........................................................................................................................................................... 185 2.18.7. Example Output ............................................................................................................................................................ 186 2.18.8. Error Guide ................................................................................................................................................................... 186 2.18.9. Sort Sequence ............................................................................................................................................................... 187 2.18.10. XML Processing ........................................................................................................................................................... 187 2.18.11. CRUD Matrix ............................................................................................................................................................... 187

2.19. Web Service: saveK12ReportCard ................................................................................................ 188 2.19.1. Functional Description ................................................................................................................................................. 188 2.19.2. Input Schema ................................................................................................................................................................ 188 2.19.3. Input Variables ............................................................................................................................................................. 188 2.19.4. Example Input .............................................................................................................................................................. 189 2.19.5. Output Schema ............................................................................................................................................................. 191 2.19.6. Output Variables ........................................................................................................................................................... 191 2.19.7. Example Output ............................................................................................................................................................ 192 2.19.8. Error Guide ................................................................................................................................................................... 192 2.19.9. Sort Sequence ............................................................................................................................................................... 192 2.19.10. XML Processing ........................................................................................................................................................... 192 2.19.11. CRUD Matrix ............................................................................................................................................................... 192

2.20. Web Service: saveNote.................................................................................................................. 193 2.20.1. Functional Description ................................................................................................................................................. 193 2.20.2. Input Schema ................................................................................................................................................................ 193 2.20.3. Input Variables ............................................................................................................................................................. 195 2.20.4. Example Input .............................................................................................................................................................. 196



of 252

Revision 2.0

2.20.5. Output Schema ............................................................................................................................................................. 198 2.20.6. Output Variables ........................................................................................................................................................... 198 2.20.7. Example Output ............................................................................................................................................................ 198 2.20.8. Error Guide ................................................................................................................................................................... 199 2.20.9. Sort Sequence ............................................................................................................................................................... 200 2.20.10. XML Processing ........................................................................................................................................................... 200 2.20.11. CRUD Matrix ............................................................................................................................................................... 200

2.21. Web Service: getScheduledLegalActions...................................................................................... 200 2.21.1. Functional Description ................................................................................................................................................. 200 2.21.2. Input Schema ................................................................................................................................................................ 200 2.21.3. Input Variables ............................................................................................................................................................. 201 2.21.4. Example Input .............................................................................................................................................................. 201 2.21.5. Output Schema ............................................................................................................................................................. 202 2.21.6. Output Variables ........................................................................................................................................................... 203 2.21.7. Example Output ............................................................................................................................................................ 208 2.21.8. Error Guide ................................................................................................................................................................... 209 2.21.9. Sort Sequence ............................................................................................................................................................... 209 2.21.10. XML Processing ........................................................................................................................................................... 209 2.21.11. CRUD Matrix ............................................................................................................................................................... 209

2.22. Web Service: getEducationReportCardQuestionaire ..................................................................... 210 2.22.1. Functional Description ................................................................................................................................................. 210 2.22.2. Input Schema ................................................................................................................................................................ 210 2.22.3. Input Variables ............................................................................................................................................................. 210 2.22.4. Example Input .............................................................................................................................................................. 210 2.22.5. Output Schema ............................................................................................................................................................. 211 2.22.6. Output Variables ........................................................................................................................................................... 212 2.22.7. Example Output ............................................................................................................................................................ 213 2.22.8. Error Guide ................................................................................................................................................................... 225 2.22.9. Sort Sequence ............................................................................................................................................................... 226 2.22.10. XML Processing ........................................................................................................................................................... 226 2.22.11. CRUD Matrix ............................................................................................................................................................... 226

2.23. Web Service: getIntakeInvsDetails ............................................................................................... 226 2.23.1. Functional Description ................................................................................................................................................. 226 2.23.2. Input Schema ................................................................................................................................................................ 226 2.23.3. Input Variables ............................................................................................................................................................. 226 2.23.4. Example Input .............................................................................................................................................................. 227 2.23.5. Output Schema ............................................................................................................................................................. 227 2.23.6. Output Variables ........................................................................................................................................................... 230 2.23.7. Example Output ............................................................................................................................................................ 230 2.23.8. Error Guide ................................................................................................................................................................... 230 2.23.9. Sort Sequence ............................................................................................................................................................... 230 2.23.10. XML Processing ........................................................................................................................................................... 230 2.23.11. CRUD Matrix ............................................................................................................................................................... 230

2.24. Web Service: getCLSActiveEntities ............................................................................................. 231 2.24.1. Functional Description ................................................................................................................................................. 231 2.24.2. Input Schema ................................................................................................................................................................ 231 2.24.3. Input Variables ............................................................................................................................................................. 231 2.24.4. Example Input .............................................................................................................................................................. 232 2.24.5. Output Schema ............................................................................................................................................................. 233 2.24.6. Output Variables ........................................................................................................................................................... 233 2.24.7. Example Output ............................................................................................................................................................ 234 2.24.8. Error Guide ................................................................................................................................................................... 235 2.24.9. Sort Sequence ............................................................................................................................................................... 235 2.24.10. XML Processing ........................................................................................................................................................... 235 2.24.11. CRUD Matrix ............................................................................................................................................................... 235

2.25. Web Service: saveChildLegalAction ............................................................................................. 235 2.25.1. Functional Description ................................................................................................................................................. 235 2.25.2. Input Schema ................................................................................................................................................................ 236 2.25.3. Input Variables ............................................................................................................................................................. 237 2.25.4. Example Input .............................................................................................................................................................. 239 2.25.5. Output Schema ............................................................................................................................................................. 240 2.25.6. Output Variables ........................................................................................................................................................... 241 2.25.7. Example Output ............................................................................................................................................................ 241 2.25.8. Error Guide ................................................................................................................................................................... 242 2.25.9. Sort Sequence ............................................................................................................................................................... 243



of 252

Revision 2.0

2.25.10. XML Processing ........................................................................................................................................................... 243 2.25.11. CRUD Matrix ............................................................................................................................................................... 243

2.26. Web Service: saveInvestigation .................................................................................................... 243 2.26.1. Functional Description ................................................................................................................................................. 244 2.26.2. Input Schema ................................................................................................................................................................ 244 2.26.3. Input Variables ............................................................................................................................................................. 244 2.26.4. Example Input .............................................................................................................................................................. 244 2.26.5. Output Schema ............................................................................................................................................................. 245 2.26.6. Output Variables ........................................................................................................................................................... 245 2.26.7. Example Output ............................................................................................................................................................ 246 2.26.8. Error Guide ................................................................................................................................................................... 246 2.26.9. Sort Sequence ............................................................................................................................................................... 246 2.26.10. XML Processing ........................................................................................................................................................... 247 2.26.11. CRUD Matrix ............................................................................................................................................................... 247

3. Outliner Changes ..................................................................................................................... 247

3.1. Description .................................................................................................................................... 247

3.2. Audit Information .......................................................................................................................... 252



of 252

Revision 2.0

1. Introduction 1.1. General Purpose of this Document

The FSFN Mobile Tools XML/Web Services design document contains technical and functional details

of all the mobile webservices available to FSFN users. General functionality of the webservices are

getting data when given certain IDs and saving data. Webservices can fetch singular data points or lists of

data; however, each webservices has a specific function and you must call the correct one with the correct

input data. The purpose of this document is to assist users, testers, and developers in utilizing these

webservices by defining and explaining the input parameters, possible errors, and demonstrating the

correct outputs.

1.2. How to Invoke the Webservices The webservices uses the SOAP messaging protocol, meaning any number of SOAP clients can access

the webservices, provided they are on the Florida internal network. End-users will be using they mobile

clients, but this document does not cover those clients. It is assumed you will use a basic SOAP client for

testing or development. Something such as the Boomerang extension for Chrome would suffice. For all

clients, the following needs to be configured:

• The location of the WSDL (eg. https://fsfn-

production.dcf.state.fl.us/mobile/MobileService?WSDL)

• The location of the mobile endpoint (eg. https://fsfn-

production.dcf.state.fl.us/mobile/MobileService)

The actual request to the webservice will also need to be filled out and sent to the endpoint via a http

POST. From there, the resulting response will populate the client, be it a valid response or an error.

1.3. Primer for Webservice Guides Each webservice will have a concise guide for its general use consisting of the following sections. The

guides will sometimes diverge from this format if more information is needed, but every guide will

contain at least all the sections listed here:

1.1.1. Functional Description The Functional Description is a summary of the webservice’s purpose and use. It includes the intended

purpose of the webservice and a brief technical write-up of the process.

1.1.2. Input Schema The Input Schema is an XSD file (XML Schema Definition) that defines what exactly the input can

contain. It is utilized during the SOAP transaction to validate the input to ensure the webservice can

consume the input data. Failure to adhere to the schema results in a SOAP exception. This is a low-level

technical document to be used as a developer reference.

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:element name="mysteryFormInput" type="mysteryFormInput"/>

<xsd:complexType name="mysteryFormInput">

<xsd:element name="mysteryId" type="xsd:integer"/>

</xsd:complexType>

</xsd:schema>

1.1.3. Input Variables The Input Variables section is a table of values that need to be set in the Input. Below is a sample table for

the imaginary webservice “getMystery”; the first row explains what that column will contain, and the

remaining rows are example rows:



of 252

Revision 2.0

XML Tag

Name

Description FSFN Database Mapping FSFN Frontend Mapping

Data Type

The name of the

XML tag used in

the input. Each of

these will be

highlighted in the

Example Input to

illustrate where it

needs to be set.

A description

of the XML

tag and how is

used.

FSFN OLTP database table and

column where to which the input can

mapped. This is where the value is

stored generally, not necessarily

where the value will be saved in the

output. Sometimes, it is in the UDB

database instead; then it will be

marked with “(UDB)”. N/A means

“not applicable” and applies when

the XML tag does not map to a

database value.

FSFN webpage

where the

corresponding

information can

be found.

Type of

data /

character

limit (eg.

100 or

less)

mysteryFormInput Container

of all

mystery

data

N/A N/A Form

mysteryId This tag

sets the

mystery ID

that

corresponds

to a piece

of secret

knowledge.

MYSTERY_SPACE.ID_MYSTERY Mystery Page Integer /

100

1.1.4. Example Input The Example Input is a sample http POST to the webservice in question. Most of the contents of the

POST don’t change between webservices, so the relevant changes are highlighted. The highlighted parts

mostly correspond to the Input/Output table from the section prior to this. The basic sections are

“methodName”,“loginXML”, “inputXML”, and “outputXML”. “exceptionXML” does not take input

parameters here.

IMPORTANT: all input has added formatting marks for clarity which will disable auditing functionality.

Production input should have no added spaces or line breaks(all input on one line).

Here is the sample input for the imaginary “getMystery” webservice:



of 252

Revision 2.0

“methodName” simply contains the name of the webservice.

“loginXML” contains the LDAP login for the user on FSFN. It is always present in every webservice and

only the username and password need to be changed according to the user account used.

“inputXML” contains the bulk of the configurable input. The breadth of fields required here varies.

There’s no practical limit on how many fields can be configured here, but each webservice will be

different and the input is specific to that webservice.

“outputXML” is the output form used in Java to populate the output result. No configuration needed other

than the right name.

“exceptionXML” is not configured in the input, but comes into play in the output when errors occur.

Take special note of the CDATA tags surrounding any XML tags not in the format <jav:something>.

CDATA is telling the XML parser to not parse this section as XML. This is important because of how

<jav:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mob="http://fsfn.dcf.state.fl.us/mobile"

xmlns:jav="java:com.ams.sacwis.mobile.services">

<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getMystery</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>

<username>ds65506</username>

<password>xxxxxxxxx</password>

</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<mysteryFormInput>

<mysteryId>1994524</mysteryId>

</mysteryFormInput>

]]>

</jav:inputXML>

<jav:outputXML>?</jav:outputXML>

<jav:exceptionXML>?</jav:exceptionXML>

</mob:p_form>

</mob:mobileService>

</jav:Body>

</jav:Envelope>



of 252

Revision 2.0

data is delimited in the output. Basically, the webservice will throw a fatal error if the CDATA tags are

not used as illustrated.

1.1.5. Output Schema The Output Schema is an XSD file (XML Schema Definition) that defines what exactly the output can

contain. It is utilized during the SOAP transaction to build the output data. This is a low-level technical

document to be used as a developer reference.


<xsd:element name="mysteryFormOutput" type="mysteryFormOutput"/>

<xsd:complexType name="mysteryFormOutput">

<xsd:element name="theMystery" type="xsd:string"/>

</xsd:complexType>

</xsd:schema>

1.1.6. Output Variables The Output Variables section is the key for the output returned by the webservice. All the relevant output,

except for error output, will be inside of the <jav:outputXML> tag. In this imaginary example, the output

form is “mysteryFormOuput”. If the webservice contains sub-form (XML container form), the row will

be colored grey. Below, the example’s first row is a description of what that row will contain.

XML Tag

Name

Description FSFN Database

Mapping

FSFN Frontend

Mapping

Data Type

The name of

the XML tag

A description of

the XML tags

purpose

The FSFN OLTP

database mapping of

the value.

Sometimes, it is in

the UDB database

instead; then it will

be marked with

“(UDB)”. N/A

means “not

applicable” and

applies when the

XML tag does not

map to a database

value.

The FSFN page where

the corresponding

information can be found.

Type of data /

character limit

(eg. 20 or less)

mysteryFormO

utput

The form

containing all the

output.

N/A N/A N/A

theMystery A mysterious

variable created

for the purpose

of this example.

Contains secret

knowledge.

MYSTERY_SPAC

E.TX_MYSTERY

Mystery Page String / 100



of 252

Revision 2.0

1.1.7. Example Output The Example Output contains a sample response the SOAP client will receive after a http POST of the

input. Immediately, you will notice the output XML does not look like XML; the two-fold reason is the

ampersand symbols in the output (&amp) and the CDATA tags from the input which allows us to skip

parsing the output as XML. If CDATA was omitted, the ampersand would break the parsing and the

request would fail. It can be made sense of if you do the following transpositions:

&lt ; <

& &

Carriage return / new line

> >

The simple reason for this is the output returned is not consistent in formatting. The mobile apps

themselves are configured to handle the outputs of individual services, as they are internally consistent,

but not consistent compared to other services. This means that this guide will display the output in the

default UTF-8 format, regardless of how the endpoint app processes the output. The important sections

are highlighted: the data returned in the input form and the error output (success, in this case).

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">

<env:Header/>

<env:Body>

<m:mobileServiceResponse xmlns:m="http://fsfn.dcf.state.fl.us/mobile">

<m:MobileServiceForm>

<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDataXml</java:methodName>

<java:loginXML xmlns:java="java:com.ams.sacwis.mobile.services"></java:loginXML>

<java:inputXML xmlns:java="java:com.ams.sacwis.mobile.services"></java:inputXML>

<java:outputXML xmlns:java="java:com.ams.sacwis.mobile.services"><?xml

version="1.0" encoding="UTF-8"?>

<mysteryFormOutput>

<theMystery>birdsarenotreal</theMystery>

<tsCreated>2019-04-04T08:43:16-05:00</tsCreated>

</mysteryFormOutput>

</java:outputXML>

<java:exceptionXML xmlns:java="java:com.ams.sacwis.mobile.services"><?xml


<webServiceError>

<status>Success</status>

</webServiceError>

</java:exceptionXML>

</m:MobileServiceForm>

</m:mobileServiceResponse>

</env:Body>

</env:Envelope>



of 252

Revision 2.0

1.1.8. Error Guide The Error Guide section contains a table of all the possible errors that a webservice can return. If

something is wrong with the input, the Mobile webservice will return an error code and error text in the

“webServiceError” field of the output.

Error Code Error Description

1123 mysteryId is a required field

1134 SQL Exception message

1145 General Exception message

1.1.9. Sort Sequence The order in which the output will be returned (eg. Sorted numerically by case ID in descending order )

1.1.10. XML Processing If the webservices require special handling of raw output/input data, it will be listed here (eg. Photo, file

cabinet encoding/decoding).

1.1.11. CRUD Matrix A table indicating which database tables the webservices reads from, updates, inserts, or deletes from. In

the following example, the PERSON table is read from and the ADDRESS table is both read and updated.

Table Create Read Update Delete

PERSON X

ADDRESS X X

1.2. Security All mobile services require a valid login session to FSFN via LDAP. This is equivalent to the normal

FSFN login. It is not its own mobile service, but it is part of every mobile service.

1.2.1. Input Variables The key elements are listed below. These must be contained in the loginXML tag. See specific web

service input examples for a complete example for each webservice.

XML Tag Name Description FSFN Backend

Mapping

FSFN

Frontend

Mapping

Data

Type

MobileLogonForm The form class that

holds the logon elements

to be passed to the web

service

N/A N/A form

username The username element

holds the LDAP

username

WORKER.ID_LOGIN Maintain

Worker

String

password The password element

holds the LDAP

password

N/A (LDAP only) N/A (LDAP

only)

String



of 252

Revision 2.0

1.2.2. Example Input The credentials are placed in the <jav:loginXML> tag of the main input XML:

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

1.2.3. Error Guide Error Code Error Description

1 LDAP Password Needs to be changed

2 LDAP Login failed

3 LDAP user account is locked

12 System Error : LDAP Login Failed

14 User not in LDAP FSFN_USER Group

15 LDAP Password is expired

2. Individual Web Services Technical Information This section is the bulk of this document and contains guides of all the FSFN mobile webservices. The

guides all adhere to the format explained section 1.3 with some additions depending on the service. Also,

all the services contain the security elements from section 1.4, but since the security elements do not vary

between services, they will not be further elaborated upon, only included in the examples.

2.1. Web Service: getOrgWorkerRoleList 2.1.1. Functional Description

The getOrgWorkerRoleList service provides the list of worker profiles for the specified worker Id that is

passed in the input XML. Each element in the list contains a set of information regarding an individual

worker profile. The data elements include Worker Role Id, Worker Profile, Unit Name and Unit

Supervisor.

2.1.2. Input Schema <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:element name="workerInfoInputForm" type="WorkerInfoInputForm"/>

<xsd:complexType name="WorkerInfoInputForm">

<xsd:sequence>

<xsd:element name="loginId" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0

2.1.3. Input Variables

XML Tag Name Description FSFN Database

Mapping

FSFN

Frontend

Mapping

Data

Type

workerInfoInputForm The form class that holds

the input elements to be

passed to invoke the

getOrgWorkerRoleList

web method

N/A N/A form

loginId The loginId element holds

the loginId of the worker

whose profile needs to be

fetched


Worker

String / 100

2.1.4. Example Input

<jav:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mob="http://fsfn.dcf.state.fl.us/mobile" xmlns:jav="java:com.ams.sacwis.mobile.services">

<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getOrgWorkerRoleList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<workerInfoInputForm>

<loginId>MS11223</loginId>

</workerInfoInputForm>

]]>

</jav:inputXML>





of 252

Revision 2.0

</mob:p_form>


</jav:Body>

</jav:Envelope>



of 252

Revision 2.0

2.1.5. Output Schema <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:element name="workerInfoOutputForm" type="WorkerInfoOutputForm"/>

<xsd:complexType name="WorkerInfoOutputForm">

<xsd:sequence>

<xsd:element name="workerId" type="xsd:decimal"/>

<xsd:element name="workerFirstName" type="xsd:string"/>

<xsd:element name="workerLastName" type="xsd:string"/>

<xsd:element name="workerEmailId" type="xsd:string"/>

<xsd:element name="workerWorkPhone" type="xsd:string"/>

<xsd:element name="workerHomePhone" type="xsd:string"/>

<xsd:element name="workerCellPhone" type="xsd:string"/>

<xsd:element name="orgWorkerRoleList" type="OrgWorkerRoleList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="OrgWorkerRoleList">

<xsd:sequence>

<xsd:element name="orgWorkerRole" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="workerRoleId" type="xsd:decimal"/>

<xsd:element name="workerProfile" type="xsd:string"/>

<xsd:element name="unitSupervisor" type="xsd:string"/>

<xsd:element name="unitId" type="xsd:decimal"/>

<xsd:element name="unitName" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.1.6. Output Variables

XML Tag Name Description FSFN Database Mapping FSFN Frontend Mapping

Data Type/ Length

workerInfoOutput

Form

The form that

contains all the

output for this

service

N/A N/A form

workerId Worker’s Id WORKER.ID_PRSN Maintain

Worker Numeric

workerFirstName Worker’s First

Name

WORKER.NM_FRST Maintain

Worker String/40

workerLastName Worker’s Last

Name

WORKER.NM_LST Maintain

Worker String/40



of 252

Revision 2.0

workerEmailId Worker’s Email WORKER.TX_EMAIL Maintain

Worker String/60

workerHomePhone Worker’s Home

Phone Number

WORKER.AD_HOME_PH

ONE

Maintain

Worker String/10

workerWorkPhone Worker’s Work

Phone Number

WORKER.AD_WRK_PHO

NE

Maintain

Worker String/10

workerCellPhone Worker’s Cell

Phone

Number

WORKER.AD_CELL_PHO

NE

Maintain

Worker String/10

orgWorkerRoleLis

t

Array of

orgWorkerRole

forms

N/A array of forms

orgWorkerRole This form contains

the information

regarding the

Worker Role Id,

Worker Profile,

Unit Supervisor,

Unit Id and Unit

Name

N/A form

workerRoleId Worker Role ID ORG_WORKER_ROLE.ID_

WORKER_ROLE

N/A Numeric

workerProfile Worker’s unit and

role

ORG_UNIT.TX_NAME +

JOB_CLASS.TX_TITLE

Maintain

Worker String/80

unitSupervisor Unit Supervisor PERSON.NM_* Maintain

Worker String/100

unitId Unit ID ORG_UNIT.ID_UNIT Maintain

Worker Numeric

unitName Unit Name ORG_UNIT.TX_NAME Maintain

Worker String/50



of 252

Revision 2.0

2.1.7. Example Output <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">

<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getOrgWorkerRoleList</java:methodName>





<workerInfoOutputForm>

<workerId>990000011</workerId>

<workerFirstName>zman</workerFirstName>

<workerLastName>zeus</workerLastName>

<workerEmailId>[email protected]</workerEmailId>

<workerWorkPhone></workerWorkPhone>

<workerHomePhone></workerHomePhone>

<workerCellPhone></workerCellPhone>

<orgWorkerRoleList>

<orgWorkerRole>

<workerRoleId>990000013</workerRoleId>

<workerProfile>Alachua County Sheriff - CPI Support Staff</workerProfile>

<unitSupervisor>Xivdh, William T</unitSupervisor>

<unitId>40697</unitId>

<unitName>Alachua County Sheriff</unitName>

</orgWorkerRole>

<orgWorkerRole>


<workerProfile>200000 HEADQUARTERS - Acting

Supervisor</workerProfile>

<unitSupervisor>RMMZNLIZGL, RICHARD</unitSupervisor>


<unitName>200000 HEADQUARTERS</unitName>

</orgWorkerRole>

</orgWorkerRoleList>

</workerInfoOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>



of 252

Revision 2.0

</env:Envelope>

2.1.8. Error Guide


101 Login Id is a required field



104 Login Invalid

2.1.9. Sort Sequence

The output XML sent will be sorted by Worker Role Id ascending.

2.1.10. XML Processing

N/A – will be used for web services which have some special handling (e.g.

photo, file cabinet encoding/decoding, etc.)

2.1.11. CRUD Matrix Table Create Read Update Delete

WORKER X

ORG_WORKER_ROLE X

ORG_UNIT X

PERSON X

2.2. Web Service: getAssignedCaseList 2.2.1. Functional Description

This method provides a minimal set of information regarding the cases currently assigned to the

worker logged in, based on the login id. The specific data elements provided are each Case

Name with associated Case Id. The Case Name is comprised of the Last Name/ Provider, First

Name and Middle Name.


<xsd:element name="assignedCaseListInputForm"

type="AssignedCaseListInputForm"/>

<xsd:complexType name="AssignedCaseListInputForm">

<xsd:sequence>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0



Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

assignedCaseListInputForm The form class that

holds the input

elements to be passed

to invoke the

getAssignedCaseList

web method

N/A N/A form

loginId Login Id of the

worker that is used

to login into the

application. The

assigned cases for

this worker will be

returned in the

output.


Worker

String/16




<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getAssignedCaseList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<assignedCaseListInputForm>

<loginId>ds65506</loginId>

</assignedCaseListInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>



of 252

Revision 2.0

</jav:Envelope>


<xsd:element name="assignedCaseListOutputForm"

type="AssignedCaseListOutputForm"/>

<xsd:complexType name="AssignedCaseListOutputForm">

<xsd:sequence>

<xsd:element name="workerId" type="xsd:decimal"/>



<xsd:element name="workerEmailId" type="xsd:string"/>

<xsd:element name="workerWorkPhone" type="xsd:string"/>

<xsd:element name="workerHomePhone" type="xsd:string"/>

<xsd:element name="workerCellPhone" type="xsd:string"/>

<xsd:element name="assignedCaseList" type="AssignedCaseList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="AssignedCaseList">

<xsd:sequence>

<xsd:element name="assignedCase" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="caseId" type="xsd:decimal"/>

<xsd:element name="caseName" type="xsd:string"/>


<xsd:element name="workerProfile" type="xsd:string"/>

<xsd:element name="workerAssignmentRole" type="xsd:string"/>

<xsd:element name="unitSupervisor" type="xsd:string"/>

<xsd:element name="unitId" type="xsd:decimal"/>

<xsd:element name="unitName" type="xsd:string"/>

<xsd:element name="oldestContactDate" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.2.6. Output Variables XML Tag Name Description FSFN

Database

Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

assignedCaseListOutput

Form

The form class that holds

the array of returned

Cases and their sub items

for the Worker Role Id

that is passed as the input.

N/A N/A



of 252

Revision 2.0

workerId Worker’s Id WORKER.ID

_LOGIN

Maintain Worker Numeric

workerFirstName Worker’s First Name PERSON.NM

_UPR_FRST

Maintain Worker String/40

workerLastName Worker’s Last Name PERSON.NM

_UPR_LST


workerEmailId Worker’s Email Address WORKER.TX

_EMAIL


workerHomePhone Worker’s Home Phone

Number WORKER.A

D_HOME_PH

ONE


workerWorkPhone Worker’s Work Phone

Number

WORKER.A

D_WRK_PH

ONE +

WORKER.A

D_CELL_PH

ONE


workerCellPhone Worker’s Cell Phone

Number WORKER.A

D_CELL_PH

ONE


assignedCaseList Array of assignedCase

form

N/A Array of

forms

assignedCase Form containing case

specific data

N/A form

caseName Case Name CASE_MAST

ER.CD_MFO

NE_CLSTNM

Maintain Case String/100

caseId Case Id CASE_MAST

ER.ID_CASE

Maintain Case Numeric

workerRoleId Unique identifier

specifying the worker’s

role

ORG_WORK

ER_ROLE.ID

_WORKER_R

OLE

N/A Numeric

workerProfile Worker’s unit and role ORG_UNIT.T

X_NAME +

ORG_UNIT.T

X_TITLE


workerAssignmentRole Worker’s role ASSIGN_CA

TEGORY.TX

_ASGN_ROL

E




of 252

Revision 2.0

unitSupervisor Unit Supervisor PERSON.NM

_*


unitId Unit Id ORG_UNIT.I

D_UNIT


unitName Unit Name ORG_UNIT.T

X_NAME


oldestContactDate Oldest Visitation Date.

This date is the minimum

face-to-face contact date

from the latest contact date

of all the case participants.

For each participant in the

case we get the maximum

face-to-face contact date.

From all the maximum

face-to- face contact date,

we get the minimum of

Date. This is the oldest

contact date. This date is

obtained only for those

participants who have a

placement or a

living arrangement.

INVESTIGAT

ION_CNTC.D

T_CNTCT

N/A Timestamp

2.2.7. Example output


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getAssignedCaseList</java:methodName>





<assignedCaseListOutputForm>

<workerId>68982</workerId>

<workerFirstName>RICHARD</workerFirstName>

<workerLastName>RMMZNLIZGL</workerLastName>

<workerEmailId>[email protected]</workerEmailId>

<workerWorkPhone>9045413691</workerWorkPhone>

<workerHomePhone></workerHomePhone>

<workerCellPhone>0957898304</workerCellPhone>



of 252

Revision 2.0

<assignedCaseList>

<assignedCase>

<caseId>2646874</caseId>

<caseName>WLFTOZH, TERESITA</caseName>


<workerProfile>200000 HEADQUARTERS - Unit Supervisor

2</workerProfile>

<workerAssignmentRole>Secondary</workerAssignmentRole>




</assignedCase>

<assignedCase>


<caseName>TFGRVIIVA, MARIANA</caseName>



2</workerProfile>





</assignedCase>

<assignedCase>


<caseName>Wziwvm, KESHA M</caseName>



2</workerProfile>





</assignedCase>

<assignedCase>


<caseName>Sbkklorgv, Carmelite</caseName>



2</workerProfile>





</assignedCase>

</assignedCaseList>

</assignedCaseListOutputForm>

</java:outputXML>




of 252

Revision 2.0


<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.2.8. Error Guide






The output XML sent will be sorted by Case Id ascending.


N/A – will be used for web services which have some special handling (e.g. photo, file cabinet

encoding/decoding, etc.)


WORKER X

PERSON X

CASE_MASTER X

ORG_WORKER_ROLE X

ORG_UNIT X

ASSIGN_CATEGORY X

INVESTIGATION_CNTC X

2.3. Web Service: getCaseDetails 2.3.1. Functional Description

This webservice has a configurable output which returns details about a FSFN case.

The details are summaries about anything that can be attached to a case; this is roughly equivalent to the

FSFN Desktop graphical dropdown of the case’s work:



of 252

Revision 2.0

In this example, the Assignment dropdown is expanded. This webservice will return similar information

about the assignments on the case. Other dropdowns have the same parallels to the webservice output.


<xsd:element name="caseDetailsInputForm" type="CaseDetailsInputForm"/>

<xsd:complexType name="CaseDetailsInputForm">

<xsd:sequence>



<xsd:element name="requiredInfo" type="xsd:string"/>

<xsd:element name="participantId" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.3.3. Input Variables XML Tag Name Description FSFN Database

Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

caseDetailsInputF

orm




getCaseDetails web

method

N/A N/A N/A

caseId The caseId element holds

the Id of the case whose

case documents needs to

be fetched.

CASE_MASTER.ID_C

ASE Maintain Case Numeric

workerRoleId The worker role of the

FSFN user pulling the data.

Has no effect on the

output.

ORG_WORKER_ROLE.

ID_WORKER_ROLE

N/A Numeric



of 252

Revision 2.0

requiredInfo Modifier value to

change the returned

data.

Refer to the below

table for valid

variables and their

effect on the output.

N/A N/A String/30

participantId Participant Id. Has no

effect on the output.

PERSON.ID_PERSO

N Maintain Case

– Participants

Tab

Numeric

requiredInfo Value How the output is modified

All Gets all Case and Case participant

related Information.

CaseDemographicInformation Gets only Case Demographic

Information

CaseAssignments Gets only Case Assignments

CaseNotes Gets only Case Notes

CasePlanInformation Gets only Case Plan Information

JudicialReviewInformation Gets only Judicial Review

Information

FamilyAssessmentInformation Gets only Family Assessment

Information

CaseParticipantDemographicInformation Gets Demographic Information of

Selected participant.

CaseParticipantDemographicInformation Gets Demographic Information of

all Case participants.

MissingChildReportInformation Gets Missing Child Report

Information of Selected Participant.

MissingChildReportInformation Gets Missing Child Report

Information of all Case Participants.

MedicalInformation Gets Medical Information of

Selected Participant.

MedicalInformation Gets Medical Information of all

Case Participants.

EducationInformation Gets Education Information of

selected Participant.

EducationInformation Gets Education Information of all

Case Participants.

PermanencyInformation Gets Permanency Information of

selected participant.

PermanencyInformation Gets Permanency Information of all

Case Participants.



of 252

Revision 2.0

IndependentLivingInformation Gets Independent Living

Information of selected participant.

IndependentLivingInformation Gets Independent Living


LivingArrangementInformation Gets Living Arrangement

Information of selected participant.

LivingArrangementInformation Gets Living Arrangement


PlacementInformationList Gets Placement Information List of


PlacementInformationList Gets Placement Information List of

all Case Participants.

InhomeServiceInformation Gets Inhome Service Information of


InhomeServiceInformation Gets Inhome Service Information of

all Case Participants.

LegalActionList Gets Legal Action List of selected participants.




<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCaseDetails</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<caseDetailsInputForm>


<requiredInfo>All</requiredInfo>

<participantId>102345114</participantId>


</caseDetailsInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>



of 252

Revision 2.0

</jav:Envelope>


<xsd:element name="caseDetailsOutputForm" type="CaseDetailsOutputForm"

/>

<xsd:complexType name="CaseDetailsOutputForm">

<xsd:sequence>

<xsd:element name="caseDetails" minOccurs="0"

maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="caseId"

type="xsd:decimal" />

<xsd:element name="caseDemographicInfo"

type="CaseDemographicInfo" />

<xsd:element name="caseAssignments"

type="CaseAssignments" />

<xsd:element name="caseNotes"

type="CaseNotes" />

<xsd:element name="casePlanInfo"

type="CasePlanInfo" />

<xsd:element name="judicalReviewInfo"

type="JudicalReviewInfo" />

<xsd:element name="familyAssessmentInfo"

type="FamilyAssessmentInfo" />

<xsd:element

name="caseParticipantsDetails" type="CaseParticipantsDetails" />

<xsd:element name="casePartList"

type="CasePartList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CaseDemographicInfo">

<xsd:sequence>

<xsd:element name="caseStat" type="xsd:string" />

<xsd:element name="dateCaseOpen" type="xsd:string" />

<xsd:element name="programCode" type="xsd:string" />

<xsd:element name="caseType" type="xsd:string" />

<xsd:element name="familyStructure" type="xsd:string" />

<xsd:element name="restrictedCase" type="xsd:string" />

<xsd:element name="caseCounty" type="xsd:string" />

<xsd:element name="beginDate" type="xsd:string" />

<xsd:element name="type" type="xsd:string" />

<xsd:element name="cdStrtPobRoute" type="xsd:decimal" />

<xsd:element name="adStrtNbr" type="xsd:string" />

<xsd:element name="adStrtNme" type="xsd:string" />

<xsd:element name="cdUnitDsgnt" type="xsd:decimal" />

<xsd:element name="txUnitDsgnt" type="xsd:string" />

<xsd:element name="adBlgn" type="xsd:string" />

<xsd:element name="adPobox" type="xsd:string" />

<xsd:element name="cdRouteType" type="xsd:decimal" />

<xsd:element name="adRouteNmbr" type="xsd:string" />

<xsd:element name="adRouteBoxnmbr" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="adLn2" type="xsd:string" />

<xsd:element name="txCity" type="xsd:string" />

<xsd:element name="cdState" type="xsd:string" />

<xsd:element name="cdZip" type="xsd:string" />

<xsd:element name="adPhone" type="xsd:string" />

<xsd:element name="adFax" type="xsd:string" />

<xsd:element name="cdCntry" type="xsd:decimal" />

<xsd:element name="txEmail" type="xsd:string" />

<xsd:element name="adCell" type="xsd:string" />

<xsd:element name="adCntcExt" type="xsd:string" />

<xsd:element name="adCntcPhone" type="xsd:string" />

<xsd:element name="adNonflCnty" type="xsd:string" />

<xsd:element name="adWrkExt" type="xsd:string" />

<xsd:element name="adWrkPhone" type="xsd:string" />

<xsd:element name="cdCnty" type="xsd:decimal" />

<xsd:element name="txAdComments" type="xsd:string" />

<xsd:element name="txPhoneComments" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CaseAssignments">

<xsd:sequence>

<xsd:element name="caseAssignment" minOccurs="1"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="workerRoleId"


<xsd:element name="wrkFirstName"

type="xsd:string" />

<xsd:element name="wrkLastName"


<xsd:element name="assignmentType"


<xsd:element name="assignmentRole"


<xsd:element name="dateStart"


<xsd:element name="dateEnd"


<xsd:element name="orgUnitName"


<xsd:element name="adWrkPhone"


<xsd:element name="wrkrTxEmail"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>



of 252

Revision 2.0

<xsd:complexType name="CaseNotes">

<xsd:sequence>

<xsd:element name="caseNote" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="narrative"


<xsd:element name="dateBegin"


<xsd:element name="dateEnd"


<xsd:element name="investigationId"


<xsd:element name="type"


<xsd:element name="childId"


<xsd:element name="workerMakingContact"


<xsd:element name="category"


<xsd:element

name="contactInformationDetails" type="ContactInformationDetails" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ContactInformationDetails">

<xsd:sequence>

<xsd:element name="contactInformationDetail" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="lastName"


<xsd:element name="firstName"


<xsd:element name="reasonNotSeen"


<xsd:element name="faceToFaceContact"


<xsd:element name="contactDate"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CasePlanInfo">

<xsd:sequence>

<xsd:element name="casePlan" minOccurs="0"


<xsd:complexType>

<xsd:sequence>



of 252

Revision 2.0

<xsd:element name="fsfnTaskId"


<xsd:element name="casePlanStatus"


<xsd:element name="purpose"


<xsd:element name="expirationDate"


<xsd:element

name="dateSupervisorApproved" type="xsd:string" />

<xsd:element name="completed"


<xsd:element name="courtCase"


<xsd:element name="courtApprovedStat"


<xsd:element

name="courtApprovedStatDate" type="xsd:string" />

<xsd:element

name="casePlanFamilyAssessment" type="xsd:string" />

<xsd:element name="medicalRecords"


<xsd:element name="mentalHealthRecords"


<xsd:element name="immunizationRecords"


<xsd:element name="dentalRecords"


<xsd:element name="includeParents"


<xsd:element name="reportCards"


<xsd:element

name="individualEducationalPlan" type="xsd:string" />

<xsd:element name="otherSchoolRecords"


<xsd:element

name="quarterlyAccountingStat" type="xsd:string" />

<xsd:element name="feeAssessment"


<xsd:element

name="rightsResponsibilities" type="xsd:string" />

<xsd:element name="outHomePlan"


<xsd:element

name="casePlanTaskCasePartsList" type="CasePlanTaskCasePartsList" />

<xsd:element name="casePlanGoalsList"

type="CasePlanGoalsList" />

<xsd:element name="casePlanTaskNeedList"

type="CasePlanTaskNeedList" />

<xsd:element

name="casePlanTaskDevelopmentList" type="CasePlanTaskDevelopmentList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>



of 252

Revision 2.0

<xsd:complexType name="CasePlanTaskCasePartsList">

<xsd:sequence>

<xsd:element name="casePlanTaskCaseParts" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="caseParticipantId"






<xsd:element name="needs"


<xsd:element name="factors"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CasePlanGoalsList">

<xsd:sequence>

<xsd:element name="casePlanGoals" minOccurs="0"


<xsd:complexType>

<xsd:sequence>









<xsd:element name="status"




<xsd:element name="dateApproved"


<xsd:element name="courtApprovedStatus"


<xsd:element name="courtApprovedDate"






<xsd:element name="primaryGoal"


<xsd:element name="concurrentGoal"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>



of 252

Revision 2.0

</xsd:complexType>

<xsd:complexType name="CasePlanTaskNeedList">

<xsd:sequence>

<xsd:element name="casePlanTaskNeeds" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="identifiedProblem"


<xsd:element name="beginDate"


<xsd:element name="specificTaskList"

type="SpecificTaskList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="SpecificTaskList">

<xsd:sequence>

<xsd:element name="specificTask" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="specificTask"


<xsd:element name="desiredBehOutcome"


<xsd:element

name="specificTaskBeginDate" type="xsd:string" />

<xsd:element name="specificTaskEndDate"


<xsd:element name="privateProvider"


<xsd:element name="serviceCategory"


<xsd:element name="serviceType"


<xsd:element name="otherService"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CasePlanTaskDevelopmentList">

<xsd:sequence>

<xsd:element name="casePlanTaskDevelopment" minOccurs="0"


<xsd:complexType>

<xsd:sequence>









of 252

Revision 2.0

<xsd:element name="participation"


<xsd:element name="contactType"


<xsd:element name="contactDate"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="JudicalReviewInfo">

<xsd:sequence>

<xsd:element name="judicalReview" minOccurs="0"


<xsd:complexType>

<xsd:sequence>





<xsd:element name="creationDate"






<xsd:element name="medicalRecords"


<xsd:element name="mentalHealthRecords"


<xsd:element name="immunizationRecords"


<xsd:element name="dentalRecords"


<xsd:element name="includeParents"


<xsd:element name="reportCards"


<xsd:element

name="individualEducationalPlan" type="xsd:string" />

<xsd:element name="otherSchoolRecords"


<xsd:element

name="quarterlyAccountingStat" type="xsd:string" />

<xsd:element name="feeAssessment"


<xsd:element

name="rightsResponsibilities" type="xsd:string" />

<xsd:element name="outHomePlan"


<xsd:element

name="judicalPlanParticipantsList" type="JudicalPlanParticipantsList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>



of 252

Revision 2.0

</xsd:complexType>

<xsd:complexType name="JudicalPlanParticipantsList">

<xsd:sequence>

<xsd:element name="judicalPlanParticipant" minOccurs="0"


<xsd:complexType>

<xsd:sequence>







<xsd:element

name="judicalPlanParticipantGoalsList"

type="JudicalPlanParticipantGoalsList" />

<xsd:element

name="judicalPlanProgressMadeList" type="JudicalPlanProgressMadeList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="JudicalPlanParticipantGoalsList">

<xsd:sequence>

<xsd:element name="judicalPlanParticipantGoal"

minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>





<xsd:element name="reviewType"






<xsd:element

name="judicialReviewHearingDate" type="xsd:string" />

<xsd:element

name="permanencyHearingDate" type="xsd:string" />

<xsd:element

name="permanencyStaffingDate" type="xsd:string" />

<xsd:element

name="permanencyHearingDueDate" type="xsd:string" />

<xsd:element name="overAllCompliance"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="JudicalPlanProgressMadeList">

<xsd:sequence>



of 252

Revision 2.0

<xsd:element name="judicalPlanProgressMade" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="identifiedProblem"


<xsd:element name="overAllAchievement"


<xsd:element name="complianceOnTask"


<xsd:element

name="desiredBehavioralOutcomeList" type="DesiredBehavioralOutcomeList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="DesiredBehavioralOutcomeList">

<xsd:sequence>

<xsd:element name="desiredBehavioralOutcome" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="desiredBehaveOutcome"


<xsd:element name="specificTask"


<xsd:element name="endDate"


<xsd:element name="taskCompliance"


<xsd:element name="serviceDelivery"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="FamilyAssessmentInfo">

<xsd:sequence>

<xsd:element name="familyAssessment" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="assessmentDate"




<xsd:element name="purpose"


<xsd:element

name="familyAssessPartsList" type="FamilyAssessPartsList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>



of 252

Revision 2.0

<xsd:complexType name="FamilyAssessPartsList">

<xsd:sequence>

<xsd:element name="familyAssessPart" minOccurs="0"


<xsd:complexType>

<xsd:sequence>







<xsd:element name="serviceRole"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CaseParticipantsDetails">

<xsd:sequence>

<xsd:element name="caseParticipant" minOccurs="0"


<xsd:complexType>

<xsd:sequence>







<xsd:element

name="faceToFaceContactDate" type="xsd:string" />

<xsd:element name="lastRemovalDate"


<xsd:element name="lastPictureDate"


<xsd:element name="photoId"


<xsd:element name="legalStatus"


<xsd:element name="ssnId"




<xsd:element name="serviceRole"


<xsd:element name="birthDate"


<xsd:element

name="casePartDemographicInfo" type="CasePartDemographicInfo" />

<xsd:element

name="missingChildReportInfo" type="MissingChildReportInfo" />

<xsd:element name="medicalInfo"

type="MedicalInfo" />

<xsd:element name="educationInfo"

type="EducationInfo" />



of 252

Revision 2.0

<xsd:element name="permanencyInfo"

type="PermanencyInfo" />

<xsd:element

name="independentLivingInfo" type="IndependentLiving" />

<xsd:element

name="livingArrangementInfoList" type="LivingArrangementInfoList" />

<xsd:element name="placementInfoList"

type="PlacementInfoList" />

<xsd:element

name="inHomeServiceInfoList" type="InHomeServiceInfoList" />

<xsd:element name="legalActionList"

type="LegalActionList" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CasePartDemographicInfo">

<xsd:sequence>

<xsd:element name="ethnicity" type="xsd:string" />

<xsd:element name="age" type="xsd:decimal" />

<xsd:element name="gender" type="xsd:string" />

<xsd:element name="usCitizen" type="xsd:string" />

<xsd:element name="birthPlace" type="xsd:string" />

<xsd:element name="race" type="xsd:string" />

<xsd:element name="hispanicLatino" type="xsd:string" />

<xsd:element name="indianTribe1" type="xsd:string" />

<xsd:element name="indianTribe2" type="xsd:string" />

<xsd:element name="otherTribalInfo" type="xsd:string" />

<xsd:element name="tribalEnrollment" type="xsd:decimal" />

<xsd:element name="icwaEligible" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="MissingChildReportInfo">

<xsd:sequence>

<xsd:element name="dateEntered" type="xsd:string" />

<xsd:element name="missingFromDate" type="xsd:string" />

<xsd:element name="narrative" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="MedicalInfo">

<xsd:sequence>

<xsd:element name="participantMedicationList"

type="ParticipantMedicationList" />

<xsd:element name="mentalHealthInfo"

type="MentalHealthInfo" />

<xsd:element name="medicalTreatmentList"

type="MedicalTreatmentList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ParticipantMedicationList">

<xsd:sequence>

<xsd:element name="medication" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="physicianName" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="prescribedMedication" type="xsd:string" />

<xsd:element name="otherPhysicianName" type="xsd:string" />

<xsd:element name="medicationPsychotropic" type="xsd:string" />

<xsd:element name="datePrescribed" type="xsd:string" />

<xsd:element name="dateStopped" type="xsd:string" />

<xsd:element name="prescriptionQuantity" type="xsd:string" />

<xsd:element name="numberOfRefills" type="xsd:string" />

<xsd:element name="dosage" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="MentalHealthInfo">

<xsd:sequence>

<xsd:element name="lastCBHAEvaluation" type="xsd:string" />

<xsd:element name="substanceUseAlcohol" type="xsd:string" />

<xsd:element name="substanceUseDrugs" type="xsd:string" />

<xsd:element name="substanceUseMarijuana" type="xsd:string" />

<xsd:element name="substanceUseSolvents" type="xsd:string" />

<xsd:element name="substanceUseAlcoholFreq" type="xsd:string" />

<xsd:element name="substanceUseDrugsFreq" type="xsd:string" />

<xsd:element name="substanceUseMarijuanaFreq" type="xsd:string" />

<xsd:element name="substanceUseSolventsFreq" type="xsd:string" />

<xsd:element name="axis1" type="xsd:string" />

<xsd:element name="axis2" type="xsd:string" />

<xsd:element name="immunizationsUpToDate" type="xsd:string" />

<xsd:element name="recordOnFile" type="xsd:string" />

<xsd:element name="date" type="xsd:string" />

<xsd:element name="caregiverEmotionallyDisturbed" type="xsd:string" />

<xsd:element name="caregiverOtherMedicalCondition" type="xsd:string"

/>

<xsd:element name="caregiverLearningDisability" type="xsd:string" />

<xsd:element name="caregiverDrugAbuse" type="xsd:string" />

<xsd:element name="caregiverVisuallyHearingImpaired" type="xsd:string"

/>

<xsd:element name="caregiverMentalRetardation" type="xsd:string" />

<xsd:element name="caregiverPhysicallyDisabled" type="xsd:string" />

<xsd:element name="caregiverAlcoholAbuse" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="MedicalTreatmentList">

<xsd:sequence>

<xsd:element name="medication" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="serviceDatesFirst" type="xsd:string" />

<xsd:element name="serviceDatesLast" type="xsd:string" />

<xsd:element name="fsfnProviderName" type="xsd:string" />

<xsd:element name="providerType" type="xsd:string" />

<xsd:element name="serviceType" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>



of 252

Revision 2.0

<xsd:complexType name="EducationInfo">

<xsd:sequence>

<xsd:element name="schoolCounty" type="xsd:string" />

<xsd:element name="dateCurrentPlan" type="xsd:string" />

<xsd:element name="datePlanExpires" type="xsd:string" />

<xsd:element name="noPlanExists" type="xsd:string" />

<xsd:element name="highSchoolDiploma" type="xsd:string" />

<xsd:element name="graduationDate" type="xsd:string" />

<xsd:element name="gEDCertificate" type="xsd:string" />

<xsd:element name="gEDDate" type="xsd:string" />

<xsd:element name="certificateCompletion"


<xsd:element name="completionDate" type="xsd:string" />

<xsd:element name="schoolDetailsList"

type="SchoolDetailsList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="SchoolDetailsList">

<xsd:sequence>

<xsd:element name="schoolDetail" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="schoolName"


<xsd:element name="schoolType"


<xsd:element name="schoolAddress"


<xsd:element name="currentGradeLevel"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="PermanencyInfo">

<xsd:sequence>

<xsd:element name="courtApprovedPrimaryGoal"


<xsd:element name="courtApprovedConcurrentGoal"


</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="IndependentLiving">

<xsd:sequence>

<xsd:element name="normalcyPlanList"

type="NormalcyPlanList" />

<xsd:element name="subsidizedIndLivingEvaluationList"

type="SubsidizedIndLivingEvaluationList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="NormalcyPlanList">

<xsd:sequence>

<xsd:element name="normalcyPlan" minOccurs="0"


<xsd:complexType>



of 252

Revision 2.0

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="SubsidizedIndLivingEvaluationList">

<xsd:sequence>

<xsd:element name="subsidizedIndLivingEvaluation"

minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>



<xsd:element name="outcome" type="xsd:string" />

<xsd:element name="planDate" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="LivingArrangementInfoList">

<xsd:sequence>

<xsd:element name="livingArrangementInfo" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="primaryCaregiver" type="xsd:string" />

<xsd:element name="secondaryCaregiver" type="xsd:string" />

<xsd:element name="beginDate" type="xsd:string" />

<xsd:element name="endDate" type="xsd:string" />


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="PlacementInfoList">

<xsd:sequence>

<xsd:element name="placementInfo" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="removalBeginDate" type="xsd:string" />

<xsd:element name="removalEndDate" type="xsd:string" />

<xsd:element name="removalReason" type="xsd:string" />

<xsd:element name="removalManner" type="xsd:string" />

<xsd:element name="caregiverStructure" type="xsd:string" />

<xsd:element name="primaryCaregiver" type="xsd:string" />

<xsd:element name="secondaryCaregiver" type="xsd:string" />

<xsd:element name="placementBeginDate" type="xsd:string" />

<xsd:element name="placementEndDate" type="xsd:string" />

<xsd:element name="fiscalAgency" type="xsd:string" />

<xsd:element name="serviceCategory" type="xsd:string" />




of 252

Revision 2.0

<xsd:element name="placementSetting" type="xsd:string" />

<xsd:element name="providerName" type="xsd:string" />

<xsd:element name="childRelationship" type="xsd:string" />

<xsd:element name="providerCdRouteType" type="xsd:decimal" />

<xsd:element name="providerCdStrtPobRoute" type="xsd:decimal" />

<xsd:element name="providerAdRouteNmbr" type="xsd:string" />

<xsd:element name="providerAdRouteBoxnmbr" type="xsd:string" />

<xsd:element name="providerAdStrtNbr" type="xsd:string" />

<xsd:element name="providerAdStrtNme" type="xsd:string" />

<xsd:element name="providerTxTown" type="xsd:string" />

<xsd:element name="providerAdApt" type="xsd:string" />

<xsd:element name="providerAdLn2" type="xsd:string" />


<xsd:element name="providerCdState" type="xsd:string" />

<xsd:element name="providerCdZip" type="xsd:string" />

<xsd:element name="providerAdPhone" type="xsd:string" />

<xsd:element name="providerAdExt" type="xsd:string" />

<xsd:element name="providerAdFax" type="xsd:string" />

<xsd:element name="providerAdAltPhone" type="xsd:string" />

<xsd:element name="providerAdBlgn" type="xsd:string" />

<xsd:element name="providerTxUnitDsgnt" type="xsd:string" />

<xsd:element name="providerAdAltExt" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="InHomeServiceInfoList">

<xsd:sequence>

<xsd:element name="inHomeServiceInfo" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="placementBeginDate" type="xsd:string" />

<xsd:element name="placementEndDate" type="xsd:string" />

<xsd:element name="fiscalAgency" type="xsd:string" />

<xsd:element name="serviceCategory" type="xsd:string" />


<xsd:element name="providerName" type="xsd:string" />

<xsd:element name="childRelationship" type="xsd:string" />

<xsd:element name="providerCdRouteType" type="xsd:decimal" />

<xsd:element name="providerCdStrtPobRoute" type="xsd:decimal" />

<xsd:element name="providerAdRouteNmbr" type="xsd:string" />

<xsd:element name="providerAdRouteBoxnmbr" type="xsd:string" />

<xsd:element name="providerAdStrtNbr" type="xsd:string" />

<xsd:element name="providerAdStrtNme" type="xsd:string" />

<xsd:element name="providerTxTown" type="xsd:string" />

<xsd:element name="providerAdApt" type="xsd:string" />



<xsd:element name="providerCdState" type="xsd:string" />

<xsd:element name="providerCdZip" type="xsd:string" />

<xsd:element name="providerAdPhone" type="xsd:string" />

<xsd:element name="providerAdExt" type="xsd:string" />

<xsd:element name="providerAdFax" type="xsd:string" />

<xsd:element name="providerAdAltPhone" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="providerAdBlgn" type="xsd:string" />

<xsd:element name="providerTxUnitDsgnt" type="xsd:string" />

<xsd:element name="providerAdAltExt" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="LegalActionList">

<xsd:sequence>

<xsd:element name="legalAction" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="completedDate"


<xsd:element name="scheduleDate"


<xsd:element name="legalAction"


<xsd:element name="legalStatus"


<xsd:element name="legalCaseStatus"


<xsd:element name="county"


<xsd:element name="legalCustodyStatus"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CasePartList">

<xsd:sequence>

<xsd:element name="CPL" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="PARTID" type="xsd:string"/>

<xsd:element name="PARTFNM"

type="xsd:string"/>

<xsd:element name="PARTLNM"

type="xsd:string"/>

<xsd:element name="PARTSFX"

type="xsd:string"/>

<xsd:element name="PARTDOB" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.3.6. Output Variables The output of this webservice is extremely dense. There are forms, lists of forms, forms with subforms,



of 252

Revision 2.0

and subforms with lists of forms. Since there are so many sub-forms, use this table as reference with an

existing output (such as the sample provided) and the schema for reference.


Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

CaseDetailsOutputFor

m

The form class that

holds the array of

returned Cases and their

sub items for the Case

Id that is

passed as the input.

N/A N/A N/A

caseId Case Id that is passed as

the input.

CASE_MASTER.ID_

CASE

Maintain Case

page - header

Numeric

caseDemographicInfo Case demographic

information place

holder.Elements below.

N/A

N/A

N/A

programCode Program Code CASE_MASTER.CD_

PRGRM_CODE

Maintain Case

page - header

String/1

dateCaseOpen Open Date CASE_MASTER.DT_

CASE_OPN

Maintain Case

page - header

String/1

0

caseStat Status CASE_MASTER.C

D_CASE_STAT

Maintain

Case page -

Participants tab

String/6

caseType Case Type CASE_MASTER.C

D_CASE_TYPE

Maintain

Case page -

Participants tab

String/6

0

familyStructure Family Structure CODE_DESC.TX_DE

SC_LRG where

ID_GRP =

'CASEDESC'

Maintain Case

page -

Participants tab

String/6

0

restrictedCase Restricted Case CASE_MASTER.C

D_DCF_WRK_INV

Maintain Case

page -

Participants

tab

- checkbox

String/1

caseCounty Case County CODE_DESC.TX_

DESC_LRG where

ID_GRP =

'REGION'

Maintain

Case page -

Participants tab

String/6

0

adApt Apartment ADDRESS.AD_AP

T

Maintain

Case page –

Address tab

String/4

beginDate Begin Date ADDRESS.

DT_EFCT_START

Maintain

Case page –

Address tab

String/1

0



of 252

Revision 2.0

type Type ADDRESS.CD_RO

UTE_TYPE

Maintain

Case page –

Address tab

String/1

0

adStrtNbr Street number ADDRESS.AD_ST

RT_NBR

Maintain

Case page –

Address tab

String/1

3

adStrtNme Street name ADDRESS.AD_ST

RT_NBR

Maintain

Case page –

Address tab

String/6

0

adLn2 Address line ADDRESS.AD_LN2 Maintain Case

page - Address

tab

String/3

6

adLn3 Address line ADDRESS.AD_LN

3

Maintain

Case page –

Address tab

String/1

2

txTown City ADDRESS.TX_TO

WN

Maintain

Case page –

Address tab

String/4

0

cdState State ADDRESS.CD_ST

ATE

Maintain

Case page –

Address tab

String/2

cdZip Zip ADDRESS.CD_ZIP Maintain Case

page - Address

tab

String/9

adRouteNmbr Route Number ADDRESS.AD_RO

UTE_NMBR

Maintain

Case page –

Address tab

String/1

5

adRouteBoxnmbr Route Box Number ADDRESS.AD_RO

UTE_BOXNMBR

Maintain

Case page –

Address tab

String/1

5

adPhone Home Phone ADDRESS.AD_PH

ONE

Maintain

Case page –

Address tab

String/1

0

adAltPhone Alternative Phone ADDRESS.AD_ALT_

PHONE

Maintain Case

page – Address

tab

String/1

0

adExt Extension ADDRESS.AD_EX

T

Maintain

Case page –

Address tab

String/4

adAltExt Alternative Extension ADDRESS.AD_AL

T_EXT

Maintain

Case page -

Address

tab

String/4

adFax Fax ADDRESS.AD_EX

T

Maintain

Case page -

Address

tab

String/1

0



of 252

Revision 2.0

cdCntry Country ADDRESS.CD_CN

TRY

Maintain

Case page -

Address

tab

Numeric

cdTown FL City ADDRESS.CD_TO

WN

Maintain

Case page -

Address

tab

Numeric

txEmail Email ADDRESS.TX_EMAI

L

Maintain Case

page -

Address tab

String/6

0

adCell Cell Number ADDRESS.AD_CE

LL

Maintain

Case page -

Address

tab

String/1

0

adCellExt Alternative Cell Number ADDRESS.AD_CE

LL_EXT

Maintain

Case page -

Address

tab

String/4

adBlgn Building ADDRESS.AD_BLG

N

Maintain Case

page -

Address tab

String/1

5

adCntcExt Contact Extension ADDRESS.AD_CNT

C_EXT

Maintain Case

page -

Address tab

String/4

adCntcPhone Contact Phone ADDRESS.AD_CN

TC_PHONE

Maintain

Case page -

Address

tab

String/1

0

adNonflCnty Non Florida County ADDRESS.AD_NO

NFL_CNTY

Maintain

Case page -

Address

tab

String/1

5

adPobox PO Box ADDRESS.AD_PO

BOX

Maintain

Case page -

Address

tab

String/1

5

adWrkExt Worker Extension ADDRESS.AD_WRK

_EXT

Maintain Case

page -

Address tab

String/4

adWrkPhone Worker Phone ADDRESS.AD_WRK

_PHONE

Maintain Case

page – Address

tab

String/1

0

cdCnty County ADDRESS.CD_CNT

Y

Maintain Case

page -

Address tab

Numeric



of 252

Revision 2.0

cdRouteType Route ADDRESS.CD_RO

UTE_TYPE

Maintain

Case page -

Address

tab

Numeric

cdStrtPobRoute Street/PO Box/Route ADDRESS.CD_ST

RT_POB_ROUTE

Maintain

Case page –

Address tab

Numeric

cdUnitDsgnt Unit Designator code ADDRESS.CD_UN

IT_DSGNT

Maintain

Case page –

Address tab

Numeric

txUnitDsgnt Unit Designator text ADDRESS.TX_UNIT

_DSGNT

Maintain Case

page -

Address tab

String/1

5

txAdComments Comments ADDRESS.TX_AD

_COMMENTS

Maintain

Case page -

Address

tab

String/2

00

txPhoneComments Comments ADDRESS.TX_PH

ONE_COMMENTS

Maintain

Case page -

Address

tab

String/2

00

caseAssignments Assignments information

container. Contains

below elements.

N/A N/A N/A

workerRoleId Worker Role Id ORG_WORKER

_ROLE.ID_WO

RKER_ROLE

Worker

Assignme

nt pop-up

page

Numeric

wrkFirstName Worker First Name PERSON.NM_F

RST

Worker

Assignme

nt pop-up

page

String/4

0

wrkLastName Worker Last Name PERSON.NM_L

ST

Worker

Assignme

nt pop-up

page

String/4

0

assignmentType Assignment Type ASSIGNMENT.CD_A

SGN_TYPE

Worker

Assignme

nt pop-up

page

String/4

0

assignmentRole Assignment Role ASSIGNMENT.CD_A

SGN_ROLE

Worker

Assignme

nt pop-up

page

String/4

0

dateStart Assignment Start

Date/Time

ASSIGNMENT.DT_S

TRT

Worker

Assignme

nt pop-up

page

String/1

0



of 252

Revision 2.0

dateEnd Assignment End

Date/Time (if applicable)

ASSIGNMENT.DT_E

ND

Worker

Assignme

nt pop-up

page

String/1

0

orgUnitName Unit Name ORG_UNIT.TX_

NAME

Worker

Manageme

nt page

String/5

0

adWrkPhone Worker Phone Number WORKER.AD_WRK_

PHONE

Worker

Management

page

String/1

0

wrkrTxEmail Worker Mail Id WORKER.TX_EMAI

L

Worker

Manageme

nt page

String/6

0

caseNotes Case Notes information

container. Contains

below elements.

N/A N/A N/A

Narrative Case Notes narrative CAN_TEXT.TX_CAN

_NARRATIVE

Case Notes

page

String/3

2000

dateBegin Contact begin date CAN_TEXT_EVENT.

DT_BEGIN

Case Notes

page

String/1

0

dateEnd Contact Date End CAN_TEXT_EVENT.

DT_END

Case Notes

page

String/1

0

investigationId Assessment Id CAN_TEXT_EVENT.

ID_INVS

Case Notes

page

Numeric

type Case Note Type CATEGORY_TYPE.T

X_CTGRY_TYPE

Case Notes

page

String/1

00

childId Child Id PERSON.ID_PRSN Case Notes

page

Numeric

workerMakingContact Workers Name. WORKER.NM_* Case Notes

page

String/1

00

category Case Note Category CATEGORY_TYPE.T

X_CTGRY_TYPE

Case Notes

page

String/2

0

CasePlanInfo Case Plan

information

Container. Contains

below elements.

N/A N/A N/A

fsfnTaskId FSFN Task Id CASE_PLAN_TASK.I

D_CASE_PLAN_TAS

K

header group

box

Numeric

casePlanStatus Case Plan Status APPROVAL.CD_STA

T

header group

box

String/1

2

purpose Purpose CODE_DESC_STATI

C. TX_SDESC_LRG

where

ID_SDESC_GRP =

'CPPURP'

header group

box

String/4

0



of 252

Revision 2.0

expirationDate Expiration Date CASE_PLAN_TASK.

DT_TARGET

header group

box

String/1

0

dateSupervisorApprove

d

Date Supervisor

Approved

CASE_PLAN_TASK.

DT_APRVL

header group

box

String/1

0

completed Completed (Y/N) CASE_PLAN_TASK.

DT_TARGET

header group

box

String/1

courtCase Court Case # CASE_PLAN_TASK.

TX_COURT_NBR

header group

box

String/2

0

courtApprovedStat

Court Approved Status

CASE_PLAN_TASK.

COURT_STAT

header group

box

String/2

00

courtApprovedStatDate Court Approved Status

Date

CASE_PLAN_TASK.

DT_COURT

header group

box

String/1

0

casePlanFamilyAssess

ment This Case Plan is based

on a Family Assessment

(Y/N)

CASE_PLAN_TASK.

CD_FMLY_ASSMNT

Development

tab

String/1

medicalRecords

Medical Records (Y/N)

CASE_PLAN_TASK.

FL_MED_REC

Attachments tab

- checkbox

String/1

mentalHealthRecords Mental health records

(Y/N)

CASE_PLAN_TASK.

FL_MENTAL_REC

Attachments tab

- checkbox

String/1

immunizationRecords Immunization records

(Y/N)

CASE_PLAN_TASK.F

L_IMMUNE_REC Attachments tab

- checkbox

String/1

dentalRecords

Dental records (Y/N)

CASE_PLAN_TASK.

FL_DENTAL_REC Attachments tab

- checkbox

String/1

includeParents Include parents,

siblings &

grandparents (if

applicable) (Y/N)

CASE_PLAN_TASK.F

L_VISIT_REC

Attachments tab

- checkbox

String/1

reportCards Report cards (Y/N) CASE_PLAN_TASK.

FL_RPTCRDS_REC Attachments tab

- checkbox

String/1

individualEducationalPl

an

Individual Educational

Plan (if applicable) (Y/N)

CASE_PLAN_TASK.

FL_IEP_REC Attachments tab

- checkbox

String/1

otherSchoolRecords Other school records

(Y/N)

CASE_PLAN_TASK.

FL_OTHR_SCHL_RE

C

Attachments tab

- checkbox

String/1

quarterlyAccountingSta

t

Quarterly accounting

statement (Y/N)

CASE_PLAN_TASK.

FL_QAS_REC Attachments tab

- checkbox

String/1

feeAssessment Notice of Fee

Assessment and

Rights of Foster Child

Regarding

Government

Benefits (Y/N)

CASE_PLAN_TASK.

FL_FEE_ASSMNT_RE

C

Attachments tab

- checkbox

String/1

rightsResponsibilities Rights and

Responsibilities (Y/N)

CASE_PLAN_TASK.

FL_RGHTS_RESP_RE

C

Attachments tab

- checkbox

String/1

outHomePlan Out of Home Plan (if

applicable) (Y/N)

CASE_PLAN_TASK.

FL_OHP_REC Attachments tab

- checkbox

String/1



of 252

Revision 2.0

casePlanTaskNeedList Array of Case Plan Task

Needs

Needs tab

N/A

casePlanTaskDevelopm

entList

Array of Case Plan Task

Development

Development

tab

N/A

casePlanTaskCaseParts

List

Array of

casePlanTaskCaseParts

N/A N/A N/A

casePlanTaskCaseParts Contains elements for

each case participant with

a case task. Contains

below elements.

personFirstName Case Participant

PERSON.NM_FRST Strengths/Need

s tab - Case

Participant

Strengths/Need

s group box

String/4

0

personLastName Case Participant PERSON.NM_LST Strengths/Need

s tab – Case

Participant

Strengths/Need

s

group box

String/4

0

factors Factors

QSTN_BANK.TX_S

ML_QSTN

Strengths tab -

Case Participant

Strengths group

box

String/3

00

needs Needs

QSTN_BANK.

QSTN_BANK_TX_

LRG_QSTN

Needs tab -

Case

Participant

Needs group

box

String/3

00

casePlanGoalsList Array of casePlanGoals N/A N/A N/A

casePlanGoals Container of case plan

goals for a participant.

Contains below elements.

N/A

personFirstName

Child Name

PERSON.NM_FRST header group

box

String/4

0

personLastName

Child Name

PERSON.NM_LST header group

box

String/4

0

fsfnTaskId

FSFN Task Id

CASE_PLAN_GOAL.

ID_CASE_PLAN_TA

SK

header group

box

Numeric

status

Status

CASE_PLAN_GOAL.

CD_STATUS

header group

box

String/1

2

expirationDate

Expiration Date

CASE_PLAN_GOAL.

DT_EXPIRATION

header group

box

String/1

0

dateApproved

Date Approved

CASE_PLAN_GOAL.

DT_PLAN_EFCT

header group

box

String/1

0



of 252

Revision 2.0

courtApprovedStatus

Court Approved Status

CASE_PLAN_GOAL.

CD_CRT_APPRD_ST

ATUS

header group

box

String/2

00

courtApprovedDate

Court Approved Date CASE_PLAN_GOAL.

DT_CRT_APPRD

header group

box

String/1

0

courtCase

Court Case #

CASE_PLAN_GOAL.

TX_COURT_NBR

header group

box

String/2

0

completed Completed (Y/N) CASE_PLAN_GOAL.

DT_TARGET

header group

box

String/1

primaryGoal Child's Proposed Primary

Goal

CASE_PLAN_GOAL.

CD_PRMNC_PRPSD

_GOAL

Basic tab String/2

00

concurrentGoal Child's Proposed

Concurrent Goal

CASE_PLAN_GOAL.

CD_CONCRRNT_PR

PSD_GOAL

Basic tab String/2

00

judicialReviewInfo Array of judicialreview

object

N/A N/A

judicialReview Container of judicial

review data. Contains

below elements.

N/A N/A

fsfnTaskId FSFN Task Id CASE_PLAN_TASK_

REVW.ID_CP_TASK

_REVW

header group

box

Numeric

expirationDate Case Plan ExpirationDate CASE_PLAN_TASK_

REVW.DT_EXPIRE

header group

box

String/1

0

creationDate Creation Date CASE_PLAN_TASK_

REVW.DT_CASE_PR

GRSS_EVAL

header group

box

String/1

0

courtCase Court Case # CASE_PLAN_TASK_

REVW.TX_COURT_

NBR

header group

box

String/2

0

completed Completed (Y/N) CASE_PLAN_TASK_

REVW.FL_COMPLE

TED

header group

box

String/1

medicalRecords Medical Records (Y/N) CASE_PLAN_TASK_

REVW.CPE_FL_ME

D_REC

Attachments tab

- checkbox

String/1

mentalHealthRecords Mental health records

(Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_ME

NTAL_REC

Attachments tab

- checkbox

String/1

immunizationRecords Immunization records

(Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_IMM

UNE_REC

Attachments tab

- checkbox

String/1

dentalRecords Dental records (Y/N) CASE_PLAN_TASK_

REVW.CPE_FL_DEN

TAL_REC

Attachments tab

- checkbox

String/1



of 252

Revision 2.0

includeParents Include parents, siblings

& grandparents (if

applicable) (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_VISI

T_REC

Attachments tab

- checkbox String/1

reportCards Report cards (Y/N) CASE_PLAN_TASK_

REVW.CPE_FL_RPT

CRDS_REC.CPE_FL_

RPTCRDS_REC

Attachments tab

- checkbox

String/1

individualEducationalPl

an

Individual Educational

Plan (if applicable) (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_IEP_

REC

Attachments tab

- checkbox

String/1

otherSchoolRecords Other school records

(Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_OTH

R_SCHL_REC

Attachments tab

- checkbox

String/1

quarterlyAccountingSta

t

Quarterly accounting

statement (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_QAS

_REC

Attachments tab

- checkbox

String/1

feeAssessment Notice of Fee

Assessment and

Rights of Foster Child

Regarding

Government

Benefits (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_FEE

_ASSMNT_REC

Attachments tab

- checkbox

String/1

rightsResponsibilities Rights and

Responsibilities (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_RGH

TS_RESP_REC

Attachments tab

- checkbox

String/1

outHomePlan Out of Home Plan (if

applicable) (Y/N)

CASE_PLAN_TASK_

REVW.CPE_FL_OHP

_REC

Attachments tab

- checkbox

String/1

judicalPlanParticipantsLi

st

Array of

judicalPlanParticipant.

Contained by

judicalReview

N/A N/A N/A

judicalPlanParticipant Contains elements of a

participant’s judicial plans.


N/A N/A N/A

caseParticipantId Person Id of the case

participant CASE_PART.ID_PRS

N

Header group

box

personFirstName

Child Name

PERSON.NM_FRST header group

box

String/4

0

personLastName

Child Name

PERSON.NM_LST header group

box

String/4

0

JudicalPlanParticipantG

oalsList

Array of

judicalPlanParticipantGoal

. Contained by

judicalPlanParticipant.


N/A N/A N/A

fsfnTaskId FSFN Task Id CASE_PLAN_GOAL

_REVIEW.ID_CASE_

header group

box

Numeric



of 252

Revision 2.0

PLAN_TASK

expirationDate Case Plan Expiration

Date

CASE_PLAN_GOAL

_REVIEW.DT_EXPIR

ATION

header group

box

String/1

0

reviewType Review Type CASE_PLAN_GOAL

_REVIEW.CD_TYPE

header group

box

String/2

00

courtCase Court Case # CASE_PLAN_TASK.

TX_COURT_NBR

header group

box

String/2

0

completed Completed (Y/N) CASE_PLAN_TASK_

REVW.TX_COURT_

NBR

header group

box

String/1

0

judicialReviewHearing

Date Date of Last

Judicial Review

Hearing

CASE_PLAN_G

OAL_REVIEW.

DT_LST_JUD_R

VW_HEARING

Permanenc

y Plan

Information tab

String/1

0

permanencyHearingDat

e

Date of Last

Permanency Hearing

CASE_PLAN_G

OAL_REVIEW.

DT_LST_PERM

_HEARING

Permanenc

y Plan

Information tab

String/1

0

permanencyStaffingDat

e

Date of Last

Permanency Staffing

CASE_PLAN_G

OAL_REVIEW.

DT_IL_STAFFI

NG

Permanenc

y Plan

Information tab

String/1

0

permanencyHearingDue

Date

Date by Which Next

Permanency Hearing is

Due

CASE_PLAN_G

OAL_REVIEW.

DT_NXT_PRM

NCY_HRNG_D

UE

Permanenc

y Plan

Information tab

String/1

0

judicalPlanProgressMade

List

Array of


. Contained by

JudicalPlanParticipantsLi

st

N/A N/A N/A

judicalPlanProgressMade Contains below elements

of participant’s judicial

plans with progress made

N/A N/A N/A

identifiedProblem Identified Problem CASE_PLAN_TASK_

ITEM.TX_CPITEM_I

DNTFY_PRBLM

Progress Made String/2

50

overallAchievement OverAll Achievement CP_TASK_REVW_IT

EM.CD_PRGRSS_ST

AT


0

complianceRegarTask Discuss compliance

regarding completion of

tasks and how that

relates

to behavioral outcome.

DOC_NARRATIVE.T

X_NARR where

CD_WRK_TYPE =

1235 and ID_WRK =

CP_TASK_REVW_ITE

M.ID_CP_TASK_REV

Progress Made

String/3

2000



of 252

Revision 2.0

W_ITEM

desiredBehavioralOutco

meList

Array of

desiredBehavioralOutcom

e contained by


N/A N/A N/A

desiredBehavioralOutco

me

Contains elements below

regarding desired

behavioral outcomes for a

participant

N/A N/A N/A

desiredBehaveOutcome Desired Measurable

Behavioral Outcome

CP_TASK_REVW_ITE

M_DTL.TX_CPEIDTL

_OUTCOME

Progress Made

String/2

50

specificTask Specific Task CP_TASK_REVW_ITE

M_DTL.TX_CPEIDTL

_SPCFC_TASK


00

endDate End Date CP_TASK_REVW_ITE

M_DTL.DT_END


0

taskCompliance Task Compliance CP_TASK_REVW_ITE

M_DTL.CD_PRGRSS


00

serviceDelivery Service Delivery CP_TASK_REVW_ITE

M_DTL.CD_SRVC_D

LVRY


00

familyAssessmentInfo Array of

familyAssessment

N/A N/A N/A

familyAssessment A single family

assessment. Contains

all elements below.

N/A N/A N/A

assessmentDate Assessment Date FAMILY_ASS

MNT.TS_CR

Family

Assessme

nt page -

header

String/1

0

status Status of assessment FAMILY_ASSMNT.C

D_STAT

Family

Assessment

page - header

String/4

0

purpose Purpose of the

assessment

FAMILY_ASSMNT.C

D_PURPOSE

Family

Assessment

page - header

String/4

0

familyAssessPartsList Array of Family

Assessment

Participants. Contained

by familyAssessment

N/A Family

Assessme

nt page -

Participants tab

N/A



of 252

Revision 2.0

personFirstName Participants

PERSON.NM_F

RST

Family

Assessme

nt page -

Participants tab

String/4

0

personLastName Participants

PERSON.NM_L

ST

Family

Assessme

nt page -

Participants tab

String/4

0

serviceRole Service Role CASE_PART.CD_S

RVC_ROLE

Family

Assessment

page -

Participants

tab for each

participant

String/6

0

caseParticipantsDetails Case participant detail

container.. Array of

caseParticipant.

N/A N/A N/A

caseParticipant Contains all subforms for

a participant. Contained

by caseParticipantDetails.

N/A N/A N/A

caseParticipantId Person ID of case

participant

CASE_PART.ID_PRS

N

Maintain Case -

Participants Tab Numeric

firstName First name of case part PERSON.NM_FRST Maintain Case -

Participants Tab String

lastName Last name of case part PERSON.NM_LST Maintain Case -

Participants Tab String

legalStatus Legal CASE_PART.CD_LG

L_STAT

Maintain Case

page -

Participants

tab

String/6

0

ssnId SSN PERSON.ID_SSN Person

Manageme

nt record

String/9

status Status CASE_PART.CD_

STAT

Maintain

Case page -

Participants tab

String/8

serviceRole Service Role CASE_PART.CD_

SRVC_ROLE

Maintain

Case page -

Participants tab

String/6

0

birthDate Date of Birth PERSON.DT_BRTH Person

Manageme

nt record

String/1

0

casePartDemographicInf

o

Array of all case

participants demographic

info. Contains elements

below.

N/A N/A N/A



of 252

Revision 2.0

ethnicity Ethnicity PERSON_ETHNI

CITY.FL_* where

PERSON_ETHNI

CITY.ID_PRSN

is

CASE_PART.ID_

PRSN

Person

Manageme

nt record

String/6

0

age Age PERSON.QT_AG

E

Person

Manageme

nt

record

Numeric

gender Gender PERSON.CD_GN

DR

Person

Manageme

nt

record

String/7

usCitizen U.S. Citizen PERSON.CD_CTZN Person

Manageme

nt record

String/1

birthPlace Birth Place PERSON.TX_BR

TH_PLC

Person

Manageme

nt

record

String/2

0

race Race PERSON.CD_RACE* Person

Manageme

nt record

String/1

20

hispanicLatino Hispanic/Latino PERSON.CD_HS

PNC

Person

Manageme

nt

record

String/1

indianTribe1 Indian Tribe 1 PERSON.CD_IN

DN

Person

Manageme

nt

record

String/6

0

indianTribe2 Indian Tribe 2 PERSON.CD_IN

DN2

Person

Manageme

nt

record

String/6

0

otherTribalInfo Other Tribal Info PERSON.TX_OT

HR_TRIBL_INF

O

Person

Manageme

nt

record

String/3

0

tribalEnrollment Tribal Enrollment # PERSON.TX_OT

HR_TRIBL_INF

O

Person

Manageme

nt

record

Numeric

icwaEligible ICWA Eligible PERSON.FL_IC

WA_ELIGIBLE

Person

Manageme

nt

record

String/1



of 252

Revision 2.0

permanencyInfo Array of cour approved

primary and concurrent

goals for participants.

courtApprovedPrimary

Goal

Current court approved

primary goal

LEGAL_ACTION.CD

_PRM_PRIOR_GOAL

Legal page –

Tracking tab

String/2

00

courtApprovedConcurr

entGoal

Current court approved

concurrent goal.

LEGAL_ACTION.CD

_CONCUR_PRIOR_G

OAL

Legal page -

Tracking tab

String/2

00

educationInfo Array of education info for

each case participant

schoolCounty

School District/County

SCHOOL.CD_SCHL_

LEA

Education

record - header

String/2

00

dateCurrentPlan Date of Current

Individualized Education

Plan

EDUCATION.DT_IE

P_CRNT

Educati

on

record –

Educati

on

Informat

ion tab

String/1

0

datePlanExpires

Date Current

Individualized

Education

Plan Expires

EDUCATION.

DT_IEP_EXP

Educati

on

record -

Educati

on

Information tab

String/1

0

noPlanExists No Individualized

Education Plan exists

(Y/N)

EDUCATION

FL_EXT_SCHL_YR

Education

record –

Education

Information tab

String/1

highSchoolDiploma High School

Diploma (Y/N)

EDUCATION.

FL_HS_DPLM

A

Educati

on

record -

Educati

on

Information tab

String/1

graduationDate Highschool Graduation

Date

EDUCATION.

DT_HS_GRA

D

Educati

on

record -

Educati

on

Information tab

String/1

0

gEDCertificate GED Certificate (Y/N)

EDUCATION.

FL_GED_CER

T

Educati

on

record -

Educati

on

Information tab

String/1



of 252

Revision 2.0

gEDDate GED Date

EDUCATION.

DT_GED

Educati

on

record -

Educati

on

Information tab

String/1

0

certificateCompletion Certificate of

Completion/Speci

al Diploma (Y/N)

EDUCATION.

FL_HSED_CE

RT

Educati

on

record -

Educati

on

Information tab

String/1

completionDate Completion Date

EDUCATION.

DT_HSED_D

ATE

Educati

on

record -

Educati

on

Information tab

String/1

0

schoolDetailsList Array of schoolDetail for


N/A N/A N/A

schoolDetail Details of a case

participants school and

grade level

N/A N/A N/A

schoolName School Name

SCHOOL.NM

_SCHL

Educati

on

record -

Educati

on

History tab

String/2

4

schoolType

School Type

SCHOOL.SCH

OOL_TYPE

Educati

on

record -

Education

History tab

String/4

0

schoolAddress

School Address

SCHOOL.TX_

ADDRESS

Educati

on

record -

Education

History tab

String/1

00

currentGradeLevel

Current Grade Level

SCHOOL.CD_

GRADE

Educati

on

record -

Educati

on

History tab

String/6

0

legalActionList Array of legalAction for


legalAction An array of legal actions

for a case participant



of 252

Revision 2.0

completedDate

Completed Date

LEGAL_ACTION.DT

_COMPLETED

Legal Record

page

String/1

0

scheduleDate Scheduled Date LEGAL_ACTION.DT

_SCHEDULED

Legal page String/1

0

legalAction

Legal Action

CODE_DESC.TX_DE

SC_LRG where

LEGAL_ACTION.CD

_INITIATE =

.ID_GRPI and

ID_GRP = 'LAINIT'

Legal Record

page

String/2

00

legalStatus

Result

CODE_DESC.TX_DE

SC_LRG where

LEGAL_ACTION.

CD_RESULT=

.ID_GRPI and

ID_GRP =

‘LARESULT

Legal Record

page

String/2

00

legalCaseStatus

Legal Case Status

CODE_DESC.TX_DE

SC_LRG where

LEGAL_ACTION.

CD_LEGAL_CASE_S

TAT= .ID_GRPI and

ID_GRP =

‘LEGLSTAT’

Legal Record

page

String/2

00

county County CODE_DESC.TX_DE

SC_LRG where

LEGAL_ACTION.

CD_COUNTY=

.ID_GRPI and

ID_GRP = ‘REGION’

Legal page String/6

0

legalCustodyStatus Legal Custody Status CODE_DESC.TX_DE

SC_LRG where

LEGAL_ACTION.

CD_COUNTY (should

be

CD_LEGAL_CUST_S

TAT)= .ID_GRPI and

ID_GRP = ‘LACUST’

Legal page String/2

00

livingArrangementInfoLi

st

Array of

livingArrangementInfo for


livingArrangementInfo Info about a case

participants living

arrangement

beginDate

Living

Arrangement Begin

Date and Time

LIVING_ARRANGE

MENT.DT_BGN

Living

Arrangeme

nt page

String/1

0



of 252

Revision 2.0

endDate Living Arrangement End Date and Time (if applicable)

LIVING_ARRANGEMENT.DT_END

Living Arrangement

page

String/1

0

primaryCaregiver

Primary Caregiver Name

LIVING_ARRAN

GEMENT.CD_PC

Living

Arrangeme

nt

page

String/1

00

secondaryCaregiver

Secondary Caregiver

(if applicable)

LIVING_ARRANGE

MENT.CD_SC

Living

Arrangeme

nt page

String/1

00

placementInfoList Array of placementInfo for


placementInfo Array of placement

information for a case

participant

removalBeginDate

Removal Begin Date and

Time

EPISODE.DT_BGN Out of Home

Placement

page

- Removal/

Placement

tab

String/1

0

removalEndDate

Removal End Date

and Time (if

applicable)

EPISODE.DT_END Out of Home

Placement

page

- Removal/

Placement

tab

String/1

0

removalReason Removal Reason(s). Any

EPISODE.FL_* columns

flagged as true contribute

to the removal reason

EPISODE.FL_* Out of Home

Placement

page

- Removal/

Placement

tab

String/6

00

removalManner

Manner of Removal

EPISODE.CD_RMV

L_MNR

Out of Home

Placement

page

- Removal/

Placement

tab

String/6

0

caregiverStructure

Caregiver Structure

EPISODE.CD_CRT

KR

(CODE_DESC.ID_G

RP = ‘CARETKR’)

Out of Home

Placement

page

- Removal/

Placement

tab

String/6

0



of 252

Revision 2.0

primaryCaregiver Primary Caregiver

EPISODE.ID_PRSN

_PC

Out of Home

Placement

page

- Removal/

Placement

tab

String/1

00

secondaryCaregiver

Secondary Caregiver

(if applicable)

EPISODE.ID_PRSN

_SC

Out of Home

Placement

page

- Removal/

Placement

tab

String/1

00

placementBeginDate

Placement Begin

Date and Time

EPISODE.DT_BGN Out of Home

Placement

page

- Removal/

Placement

tab

String/1

0

placementEndDate

Placement End Date

and Time (if

applicable)

EPISODE.DT_END Out of Home Placement page

- Removal/

Placement

tab

String/1

0

fiscalAgency

Fiscal Agency

ORG_ENTITY.TX_

NAME

Out of Home

Placement

page

- Removal/

Placement

tab

String/3

0

serviceCategory

Service Category

SERVICE_TYPE.C

D_SRVC_CTGRY

Out of Home

Placement

page

- Removal/

Placement

tab

String/6

0

serviceType

Service Type

EPISODE.CD_SRV

C

Out of Home

Placement

page

- Removal/

Placement

tab

String/4

0

placementSetting

Placement Setting

EPISODE.CD_PLC

M_SETNG

(CODE_DESC.ID_G

RP = ‘PLCMSTNG’)

Out of Home

Placement

page

- Removal/

Placement

tab

String/6

0



of 252

Revision 2.0

providerName

Provider Name

PROVIDER_ORG.N

M_*

Out of Home

Placement

page

- Provider tab

String/8

0

childRelationship Relationship of Child to

Relative Caregiver

(if applicable)

EPISODE.CD_REL

(CODE_DESC.ID_G

RP = ‘EPSDRLTN’)

Out of Home

Placement

page

- Provider tab

String/6

0

providerCdRouteType

Provider Address

ADDRESS.CD_RO

UTE_TYPE

Out of Home

Placement

page

- Provider tab

Numeric

providerCdStrtPobRout

e

Provider Address

ADDRESS.CD_STR

T_POB_ROUTE

Out of Home

Placement

page

- Provider tab

Numeric

providerAdRouteNmbr

Provider Address

ADDRESS.AD_RO

UTE_BOXNMBR

Out of Home

Placement

page

- Provider tab

Numeric

providerAdRouteBoxn

mbr

Provider Address

ADDRESS.AD_RO

UTE_BOXNMBR

Out of Home

Placement

page

- Provider tab

Numeric

providerAdStrtNbr

Provider Address

ADDRESS.AD_STR

T_NBR

Out of Home

Placement

page

- Provider tab

Numeric

providerAdStrtNme

Provider Address

ADDRESS* Out of Home

Placement

page

- Provider tab

String/6

0

providerTxTown

Provider Address


Placement

page

- Provider tab

String/4

0

providerAdApt

Provider Address


Placement

page

- Provider tab

String/4

providerAdLn2

Provider Address


Placement

page

- Provider tab

String/3

6

providerAdLn3

Provider Address


Placement

page

- Provider tab

String/1

2



of 252

Revision 2.0

providerCdState

Provider Address

ADDRESS* - Provider tab String/2

providerCdZip

Provider Address


Placement

page

- Provider tab

String/9

providerAdPhone

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdExt

Provider Address


Placement

page

- Provider tab

String/4

providerAdFax

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdAltPhone

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdBlgn

Provider Address


Placement

page

- Provider tab

String/1

5

providerTxUnitDsgnt

Provider Address


Placement

page

- Provider tab

String/1

5

providerAdAltExt

Provider Address


Placement

page

- Provider tab

String/4

inHomeServiceInfoList Array of

inHomeServiceInfo for


inHomeServiceInfo Array of placement

services for a participant

placementBeginDate

Service Begin Date

EPISODE.DT_BGN Services page -

Service tab

String/1

0

placementEndDate Service End Date (if

applicable)

EPISODE.DT_END Services page -

Service tab

String/1

0

fiscalAgency

Fiscal Agency

EPISODE.ID_FSCL_

AGNCY

Services page -

Service tab

String/3

0

serviceCategory

Service Category

SERVICE_TYPE.C

D_SRVC_CTGRY

(CODE_DESC.ID_G

RP = 'SRVCTGRY')

Services page -

Service tab

String/6

0



of 252

Revision 2.0

serviceType

Service Type

EPISODE.CD_SRV

C Services page -

Service tab

String/4

0

providerName

Provider Name

PROVIDER_ORG.N

M_* Services page -

Provider tab

String/8

0

childRelationship Relationship of Child

to Relative Caregiver

(if

applicable)

EPISODE.CD_REL

(CODE_DESC.ID_G

RP = ‘EPSDRLTN’)

Services page

- Provider tab

String/6

0

providerCdRouteType

Provider Address


Placement

page

- Provider tab

Numeric

providerCdStrtPobRout

e

Provider Address ADDRESS* Placement page

- Provider tab

Numeric

providerAdRouteNmbr

Provider Address


Placement

page

- Provider tab

Numeric

providerAdRouteBoxn

mbr

Provider Address


Placement

page

- Provider tab

Numeric

providerAdStrtNbr

Provider Address


Placement

page

- Provider tab

Numeric

providerAdStrtNme

Provider Address


Placement

page

- Provider tab

String/6

0

providerTxTown

Provider Address


Placement

page

- Provider tab

String/4

0

providerAdApt

Provider Address


Placement

page

- Provider tab

String/4

providerAdLn2

Provider Address


Placement

page

- Provider tab

String/3

6

providerAdLn3

Provider Address


Placement

page

- Provider tab

String/1

2

providerCdState

Provider Address


Placement

page

String/2



of 252

Revision 2.0

- Provider tab

providerCdZip

Provider Address


Placement

page

- Provider tab

String/9

providerAdPhone

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdExt

Provider Address


Placement

page

- Provider tab

String/4

providerAdFax

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdAltPhone

Provider Address


Placement

page

- Provider tab

String/1

0

providerAdBlgn

Provider Address


Placement page

– Provider tab

String/1

5

providerTxUnitDsgnt

Provider Address


Placement

page

- Provider tab

String/1

5

providerAdAltExt

Provider Address


Placement

page

- Provider tab

String/4

MedicalInfo Container for all case

participant medical info.

Contains all forms of

medical arrays for each

participant.

participantMedicationLis

t

Array of medication for a

participant

medication A prescription for a

medication for a case

participant.Contains the

following elements.



of 252

Revision 2.0

physicianName

Name of Prescribing

Physician/ Practitioner

MEDICATIONS.N

M_PHYS_PRACT

Medical/

Mental Health

record -

Medications

tab

-

Medications

pop-up

page.

String/1

00

prescribedMedication

Prescribed Medication

MEDICATIONS.NM_P

RESC_MED

Medical/

Mental

Health

record -

Medications tab

String/1

00

otherPhysicianName

If Other Specify

MEDICATIONS.TX_O

THER_SPEC

Medical/

Mental Health

record -

Medications

tab

-

Medications

pop-up

page.

String/1

00

medicationPsychotropic Psychotropic Medication

MEDICATIONS.FL_M

ED_PSYC

Medical/

Mental

Health

record -

Medications

tab

String/1

datePrescribed

Date Prescribed

MEDICATIONS.DT_M

ED_PRESC

Medical/

Mental

Health

record -

Medications tab

String/1

0

dateStopped

Date Stopped

(if applicable)

MEDICATIONS.DT_M

ED_STOPPED

Medical/

Mental

Health

record -

Medications tab

String/1

0

prescriptionQuantity Prescription Quantity MEDICATIONS.TX_P

RESC_QTY

Medical/

Mental Health

record -

Medications

tab

-

Medications

pop-up

page.

String/1

0



of 252

Revision 2.0

numberOfRefills Number of Refills MEDICATIONS.QT_N

UM_REFILLS Medical/

Mental

Health

record -

Numeric

dosage Dosage MEDICATIONS.TX_N

ARR

Medical/

Mental Health

record -

Medications

tab

-

Medications

pop-up

page.

String/3

2000

MedicalTreatmentList Array of medical treatment

rendered for each

participant

serviceDatesFirst Service Dates - First

(if applicable)

PAY_CLAIM_HIST

ORY.DT_FST_SRV

C

Medical/

Mental Health

record -

Medical

History

tab

String/1

0

serviceDatesLast Service Dates - Last

(if applicable)

PAY_CLAIM_HIST

ORY.DT_LST_SRV

C

Medical/

Mental Health

record -

Medical

History

tab

String/1

0

fsfnProviderName FSFN Provider/ Other

Provider (if

applicable)

PAY_CLAIM_HIST

ORY.ID_EPSDT_P

RVD and

PROVIDER_ORG.N

M_*

Medical/

Mental Health

record -

Medical

History

tab

String/2

00

providerType Provider Type PAY_CLAIM_HIST

ORY.ID_EPSDT_PR

VD and

PROVIDER_ORG.S

RVC_TYPE

Medical/

Mental Health

record -

Medical

History

tab

String/2

00

serviceType Type of Service PAY_CLAIM_HIST

ORY.CD_COND_T

YPE

(CODE_DESC.ID_

GRP =

‘TYPESERV’)

Medical/

Mental Health

record -

Medical

History tab

String/2

00

mentalHealthInfo Array of mental health

info for each case

participant



of 252

Revision 2.0

lastCBHAEvaluation Last CBHA Evaluation MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile

tab

String/1

0

substanceUseAlcohol Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

Profile tab

String/1

substanceUseDrugs Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

substanceUseMarijuana Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

substanceUseSolvents Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

substanceUseAlcoholF

req

Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/6

0

substanceUseDrugsFre

q

Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/6

0

substanceUseMarijua

naFreq

Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/6

0

substanceUseSolvents

Freq

Substance Use and

associated

Frequency

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

Profile tab

String/6

0

axis1 AXIS I MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

String/1

6



of 252

Revision 2.0

Profile tab

axis2 AXIS II MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

Profile tab

String/1

6

caregiverEmotionallyDi

sturbed

Caregiver(s)

Information at time of

Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

Profile tab

String/1

0

caregiverOtherMedica

lCondition

Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0

caregiverLearningDisab

ility

Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record –

Mental Health

Profile tab

String/1

0

caregiverDrugAbuse Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0

caregiverVisuallyHear

ingImpaired

Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0

caregiverMentalRetarda

tion

Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0

caregiverPhysicallyDi

sabled

Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0



of 252

Revision 2.0

caregiverAlcoholAbuse Caregiver(s)


Intake

MEDICAL_PROFILE/

MENTAL_HEALTH_P

ROFILE

Medical/

Mental Health

record -

Mental Health

Profile tab

String/1

0

CasePlanTaskDevelop

mentList Array of

casePlanTaskDevelopme

nt for each participant

casePlanTaskDevelopm

ent Array of case plans for a

participant

caseParticipantId Case Participant

CASE_PLAN,PERSON

,CAS_PLAN_PARTICI

PATION

Case Plan

Task→

Developme

nt Tab→

Case Plan

Tasks

Development

String/1

00

participation Participation

CASE_PLAN,PERSON

,CAS_PLAN_PARTICI

PATION

(CODE_DECODE.ID_

GRP=‘CPPRTCPT’)

Case Plan

Task→

Developme

nt Tab→

Case Plan

Tasks

Development

String/2

00

contactType Type of Contact

CASE_PLAN,PERSON

,CAS_PLAN_PARTICI

PATION

(CODE_DECODE.ID_

GRP = ‘CPCNTCT’)

Case Plan

Task→

Developme

nt Tab→

Case Plan

Tasks

Development

String/2

00

contactDate Contact Date

CASE_PLAN,PERSON

,CAS_PLAN_PARTICI

PATION

Case Plan

Task→

Developme

nt Tab→

Case Plan

Tasks

Development

String/1

0

casePlanTaskNeedList Array of

casePalnTaskNeeds for

each participant



of 252

Revision 2.0

casePlanTaskNeeds Array of case plan task

needs for a participant

identifiedProblem Identified Problem CASE_PLAN_TASK_

ITEM

Maintain Case

Plan Item

String/2

50

beginDate Begin Date CASE_PLAN_TASK_

ITEM

Maintain Case

Plan Item

String/1

0

specificTaskList Array of Specific Tasks

for a participant

Maintain Case

Plan Item

specificTask Array of a specific task for

a participant

specificTask The specific task in

question

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/2

50

desiredBehOutcome Desired Measurable

Behavioral Outcome

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/2

50

specificTaskBeginDate

Specific Task Begin Date

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/1

0

specificTaskEndDate

Specific Task End Date

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/1

0

privateProvider

Private/Provider

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/1

00

serviceCategory

Service Category

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

(CODE_DESC_LRG.I

D_GRP =

‘SFTYCTGR’)

Maintain Case

Plan Item

String/2

00

serviceType

Service Type

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

Maintain Case

Plan Item

String/2

00



of 252

Revision 2.0

PROVIDER_ORG

(TX_LDESC_LRG.

ID_GRP =

'SFTYSRVC')

otherService

Other Service

CASE_PLAN_TASK_

ITEM,

CP_TASK_ITEM_DE

TAIL,

PROVIDER_ORG

Maintain Case

Plan Item

String/1

00

contactInformationDetail

s

Array of

contactInformationDetail

for each participant

contactInformationDetail Contact of participant with

guardian information

lastName Last name of contact INVESTIGATION_C

NTC, PERSON

Case Note String/1

00

firstName First name of contact INVESTIGATION_C

NTC, PERSON

Case Note String/1

00

reasonNotSeen Reason Not Seen. INVESTIGATION_C

NTC, PERSON

Case Note String/6

0

faceToFaceContact Most recent Face to

face Contact Visitation

Date (only if a

placement or a living

arrangement is present

for that participant). If

there is a date of

removal or date of

living arrangement and

date last visit is null

then it means there is no

visit done for the child.

If there is no date of

removal and no date of

living arrangement and

there is a visit date then

there will be no

faceToFaceContactDate

.

INVESTIGATION_C

NTC, PERSON

Case

Notes

Page.

String/1

0

contactDate Contact Date/Time INVESTIGATION_C

NTC, PERSON

Case Note String/1

0

missingChildReportInfo Array of missing child info

for any participant

dateEntered

Date Entered

MISSING_CHILD_

MAIN

Missing Child

Report→

Child

Information

String/1

0



of 252

Revision 2.0

missingFromDate

Missing From date

MISSING_CHILD_

MAIN

Missing Child

Report→

Child

Information

String/1

0

narrative

Narrative.

MISSING_CHILD_M

AIN,

DOC_NARRATIVE

Missing Child

Report→

Narrative Tab.

String/3

2000

IndependentLiving Array of normalcyPlanList

and

subsidiszedIndLivingEval

uationList for each

participant

normalcyPlanList Array of normalcyPlan


Independent

Living

N/A

normalcyPlan Array of normalcy plans:

date and type for each

participant

date

Date of the normalcy

plan

IL_PLAN_DATE.D

T_PLAN

Independent

Living→ Age

13-17 tab→

Normalcy

Plan

Date

String/1

0

type

Type of normalcy plan

IL_PLAN_DATE.C

D_PLAN_STAT (1

= initial, 2 =

Updated)

Independent

Living→ Age

13-17 tab→

Normalcy

Plan

String/1

0

subsidizedIndLivingEvalu

ation

Array of subsidized

independent living

evaluations for each

participant

date

Date of Evaluation

IL_EVALUATIO

N

Independent

Living→

Age 13-17

tab→Subsidize

d Independent

Living

Evaluation

String/1

0



of 252

Revision 2.0

type

Type

IL_EVALUATIO

N

Independent

Living→

Age 13-17

tab→Subsidize

d Independent

Living

Evaluation

String/1

0

outcome

Outcome

IL_EVALUATIO

N

(CODE_DECODE

.ID_GRP =

‘ILOUTCOME’)

Independent

Living→

Age 13-17

tab→Subsidize

d Independent

Living

Evaluation

String/2

00

planDate

Date of Plan

IL_EVALUATIO

N

Independent

Living→

Age 13-17

tab→Subsidize

d Independent

Living

Evaluati

on

String/1

0

2.3.7. Example Output The following output will be shorter if a different “requiredInfo” option is used other than “All”.


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDetails</java:methodName>





<caseDetailsOutputForm>

<caseDetails>


<caseDemographicInfo>

<caseStat>Reopen</caseStat>

<dateCaseOpen>05/04/2018</dateCaseOpen>

<programCode>C</programCode>

<caseType>Out-of-Home - Court Ordered</caseType>

<familyStructure>Unable to Determine</familyStructure>

<restrictedCase>N</restrictedCase>

<caseCounty>Hillsborough</caseCounty>

<beginDate>2015-09-11 00:00:00.0</beginDate>



of 252

Revision 2.0

<type>Primary Residence</type>

<cdStrtPobRoute>1</cdStrtPobRoute>

<adStrtNbr>1120</adStrtNbr>

<adStrtNme>V Gdrtth HG</adStrtNme>

<cdUnitDsgnt>9</cdUnitDsgnt>

<txUnitDsgnt>G472</txUnitDsgnt>

<adBlgn></adBlgn>

<adLn2></adLn2>

<txCity>Tampa</txCity>

<cdState>FL</cdState>

<cdZip>336023158</cdZip>

<adPhone></adPhone>

<adFax></adFax>

<cdCntry>1</cdCntry>

<txEmail></txEmail>

<adCell></adCell>

<adCntcExt></adCntcExt>

<adCntcPhone></adCntcPhone>

<adNonflCnty></adNonflCnty>

<adWrkExt></adWrkExt>

<adWrkPhone></adWrkPhone>

<cdCnty>29</cdCnty>

<txAdComments></txAdComments>

<txPhoneComments></txPhoneComments>

</caseDemographicInfo>

<caseAssignments>

<caseAssignment>


<wrkFirstName>REBECCA</wrkFirstName>

<wrkLastName>EZIVGLMR</wrkLastName>

<assignmentType>Hotline</assignmentType>

<assignmentRole>Counselor</assignmentRole>

<dateStart>2015-09-11 21:25:07.402409</dateStart>

<dateEnd>2015-09-11 21:25:07.402409</dateEnd>

<orgUnitName>HOTLINE-FAMILY SAFETY</orgUnitName>


<wrkrTxEmail>[email protected]</wrkrTxEmail>

</caseAssignment>

</caseAssignments>


<wrkFirstName>REBECCA</wrkFirstName>

<wrkLastName>EZIVGLMR</wrkLastName>

<assignmentType>Hotline</assignmentType>

<assignmentRole>CI Unit Counselor</assignmentRole>

<dateStart>2015-09-11 21:25:07.402409</dateStart>

<dateEnd>2015-09-11 21:26:46.416889</dateEnd>

<orgUnitName>HOTLINE-FAMILY SAFETY</orgUnitName>


<wrkrTxEmail>[email protected]</wrkrTxEmail>

</caseAssignment>



of 252

Revision 2.0

</caseAssignmenst>

<caseNotes>

<caseNote>

<narrative>NA</narrative>

<dateBegin>2018-05-04 18:32:04.33605</dateBegin>

<investigationId>104684038</investigationId>

<type>Note to File - General</type>

<childId>102174574</childId>

<workerMakingContact>Wvmmrhlm, Courtney J</workerMakingContact>

<category>Child Investigation</category>

<contactInformationDetails/>

</caseNote>

<caseNote>

<narrative>NA</narrative>

<dateBegin>2018-07-03 14:57:09.309026</dateBegin>

<investigationId>104684038</investigationId>

<type>Note to File - General</type>

<childId>102174574</childId>

<workerMakingContact>Wvmmrhlm, Courtney J</workerMakingContact>

<category>Child Investigation</category>

<contactInformationDetails/>

</caseNote>

</caseNotes>

<casePlanInfo/>

<judicalReviewInfo/>

<familyAssessmentInfo/>

<caseParticipantsDetails>

<caseParticipant>

<caseParticipantId>7234346</caseParticipantId>

<firstName>Derrick</firstName>

<lastName>Hkvvw</lastName>

<ssnId>735028958</ssnId>

<status>Active</status>

<serviceRole>Parent Not In The Home</serviceRole>

<birthDate>1980-03-11 00:00:00.0</birthDate>

<casePartDemographicInfo>

<ethnicity>Unknown</ethnicity>

<gender>Male</gender>

<usCitizen>Y</usCitizen>

<birthPlace></birthPlace>

<race>Black/African American</race>

<hispanicLatino> </hispanicLatino>

<otherTribalInfo> </otherTribalInfo>

<icwaEligible>N</icwaEligible>

</casePartDemographicInfo>

<missingChildReportInfo/>

<medicalInfo>

<participantMedicationList/>

<mentalHealthInfo/>



of 252

Revision 2.0

<medicalTreatmentList/>

</medicalInfo>

<educationInfo/>

<permanencyInfo/>

<independentLivingInfo/>

<livingArrangementInfoList/>

<placementInfoList/>

<inHomeServiceInfoList>

<inHomeServiceInfo>

<placementBeginDate>1991-10-03 00:00:00.0</placementBeginDate>

<placementEndDate>1992-05-27 00:00:00.0</placementEndDate>

<fiscalAgency>Sarasota YMCA</fiscalAgency>

<serviceCategory>Relative</serviceCategory>

<serviceType>Relative Placement</serviceType>

<providerName>DoNotUse, Conversion</providerName>

<providerCdStrtPobRoute>1</providerCdStrtPobRoute>

<providerCdState>FL</providerCdState>

<providerAdPhone></providerAdPhone>

<providerAdExt></providerAdExt>

<providerAdFax></providerAdFax>

<providerAdAltPhone></providerAdAltPhone>

<providerAdAltExt></providerAdAltExt>

</inHomeServiceInfo>

</inHomeServiceInfoList>

<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Linda</firstName>

<lastName>Ef</lastName>






<ethnicity>Unable To Determine</ethnicity>

<age>23</age>

<gender>Female</gender>



<race>Asian</race>

<hispanicLatino>U</hispanicLatino>

<otherTribalInfo></otherTribalInfo>




<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>



of 252

Revision 2.0

<educationInfo/>

<permanencyInfo/>




<inHomeServiceInfoList/>

<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Jimmy</firstName>




<serviceRole>Relative In Home</serviceRole>



<ethnicity>Chinese</ethnicity>




<race>Asian</race>

<hispanicLatino>N</hispanicLatino>





<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Dat</firstName>






<ethnicity>Japanese</ethnicity>





of 252

Revision 2.0


<race>White</race>






<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Allison</firstName>


<faceToFaceContactDate>2019-07-03 18:30:00.0</faceToFaceContactDate>



<serviceRole>Child Receiving Services</serviceRole>


<photoId>9536747</photoId>

<lastPictureDate>2019-07-16 00:00:00.0</lastPictureDate>

<lastRemovalDate>2018-05-04 18:00:00.0</lastRemovalDate>


<ethnicity>African American/Black</ethnicity>


<usCitizen>N</usCitizen>


<race>Asian, Black/African American</race>






<medicalInfo>


<mentalHealthInfo>

<substanceUseAlcohol>N</substanceUseAlcohol>

<substanceUseDrugs>N</substanceUseDrugs>

<substanceUseMarijuana>N</substanceUseMarijuana>

<substanceUseSolvents>N</substanceUseSolvents>

<axis1></axis1>



of 252

Revision 2.0

<axis2></axis2>

<immunizationsUpToDate>Y</immunizationsUpToDate>

<recordOnFile>Y</recordOnFile>

<date>2015-09-17 00:00:00.0</date>

</mentalHealthInfo>

<medicalTreatmentList>

<medication>

<serviceDatesFirst>2015-09-17 00:00:00.0</serviceDatesFirst>

</medication>

<medication>


</medication>

<medication>


</medication>

<medication>


</medication>

</medicalTreatmentList>

</medicalInfo>

<educationInfo>

<schoolCounty>Hillsborough</schoolCounty>

<noPlanExists>N</noPlanExists>

<highSchoolDiploma>N</highSchoolDiploma>

<gEDCertificate>N</gEDCertificate>

<certificateCompletion>N</certificateCompletion>

<schoolDetailsList>

<schoolDetail>

<schoolName>Simmons Achievement Center</schoolName>

<schoolType>Child Care Program</schoolType>

<schoolAddress>107 E Clay Ave, Brandon, FL

33510</schoolAddress>

<currentGradeLevel>None</currentGradeLevel>

</schoolDetail>

</schoolDetailsList>

</educationInfo>

<permanencyInfo/>


<livingArrangementInfoList>

<livingArrangementInfo>

<primaryCaregiver>Ef, Brenda Quan</primaryCaregiver>

<secondaryCaregiver></secondaryCaregiver>

<beginDate>2016-04-29 17:00:00.0</beginDate>

<endDate>2016-11-10 13:00:00.0</endDate>

<type>Living with One Parent</type>

</livingArrangementInfo>

</livingArrangementInfoList>

<placementInfoList>

<placementInfo>

<removalBeginDate>2015-09-16 19:45:00.0</removalBeginDate>

<removalEndDate>2016-04-29 16:00:00.0</removalEndDate>



of 252

Revision 2.0

<removalReason>Emotional Abuse/Neglect</removalReason>

<removalManner>Court Ordered</removalManner>

<caregiverStructure>Unmarried Couple</caregiverStructure>



<fiscalAgency>Eckerd Community-Hillsborough</fiscalAgency>

<serviceCategory>Foster Home</serviceCategory>

<serviceType>Foster Home Traditional 0-5</serviceType>

<placementSetting>Foster Family Home (Non-

Relative)</placementSetting>

<providerName>Riley, Karen</providerName>


<providerAdStrtNbr>13201</providerAdStrtNbr>

<providerAdStrtNme>Ovdrh Tzooztsvi IW</providerAdStrtNme>

<providerTxTown>Dover</providerTxTown>

<providerAdLn2></providerAdLn2>


<providerCdZip>335274523</providerCdZip>

<providerAdPhone>8137703937</providerAdPhone>


<providerAdBlgn></providerAdBlgn>

<providerTxUnitDsgnt></providerTxUnitDsgnt>

</placementInfo>

</placementInfoList>


<inHomeServiceInfo>





<serviceType>CPA Administrative Fee Only</serviceType>

<providerName>Children's Home Network</providerName>


<providerAdRouteNmbr></providerAdRouteNmbr>

<providerAdRouteBoxnmbr></providerAdRouteBoxnmbr>


<providerAdStrtNme>Nvnlirzo SDB</providerAdStrtNme>

<providerTxTown>Tampa</providerTxTown>





<providerAdAltPhone></providerAdAltPhone>



<providerAdAltExt></providerAdAltExt>


<inHomeServiceInfo>






of 252

Revision 2.0



<providerName>FLORIDA UNITED METHODIST

CHILDREN'S</providerName>



<providerAdStrtNme>D Ivbmlowh HG</providerAdStrtNme>

<providerTxTown>Plant City</providerTxTown>










<legalActionList>

<legalAction>

<completedDate>2015-11-12 14:00:00.0</completedDate>

<scheduleDate>2015-11-12 14:00:00.0</scheduleDate>

<legalAction>Mediation</legalAction>

<legalStatus>Agreement</legalStatus>

<county>Hillsborough</county>

</legalAction>

<legalAction>


<scheduleDate>2015-11-03 10:00:00.0</scheduleDate>

<legalAction>Hearing - Advisory - Initial</legalAction>

<legalStatus>Denied</legalStatus>


</legalAction>

</legalActionList>

</caseParticipant>

<caseParticipant>


<firstName>Brenda</firstName>







<ethnicity>Unable To Determine</ethnicity>

<age>21</age>


<race>Asian</race>

<hispanicLatino>U</hispanicLatino>






of 252

Revision 2.0

<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Unknown</firstName>

<lastName>Fmpmldm</lastName>


<serviceRole>Other</serviceRole>



<ethnicity>Unknown</ethnicity>




<race>Unknown</race>






<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Cataleya</firstName>


<faceToFaceContactDate>2019-07-03 18:30:00.0</faceToFaceContactDate>





of 252

Revision 2.0

<serviceRole>Child Receiving Services</serviceRole>



<lastPictureDate>2019-07-16 00:00:00.0</lastPictureDate>

<lastRemovalDate>2018-05-04 18:00:00.0</lastRemovalDate>


<ethnicity>African American/Black</ethnicity>


<usCitizen>N</usCitizen>


<race>Asian, Black/African American</race>






<medicalInfo>


<mentalHealthInfo>

<substanceUseAlcohol>N</substanceUseAlcohol>

<substanceUseDrugs>N</substanceUseDrugs>

<substanceUseMarijuana>N</substanceUseMarijuana>

<substanceUseSolvents>N</substanceUseSolvents>

<axis1></axis1>

<axis2></axis2>

<immunizationsUpToDate>N</immunizationsUpToDate>

<recordOnFile>N</recordOnFile>

</mentalHealthInfo>

<medicalTreatmentList>

<medication>


</medication>

<medication>


</medication>

</medicalTreatmentList>

</medicalInfo>

<educationInfo>

<schoolCounty>Hillsborough</schoolCounty>

<noPlanExists>N</noPlanExists>

<highSchoolDiploma>N</highSchoolDiploma>

<gEDCertificate>N</gEDCertificate>

<certificateCompletion>N</certificateCompletion>

<schoolDetailsList>

<schoolDetail>

<schoolName>Simmons Achievement Center</schoolName>

<schoolType>Child Care Program</schoolType>

<schoolAddress>107 E Clay Ave, Brandon, FL

33510</schoolAddress>

<currentGradeLevel>None</currentGradeLevel>

</schoolDetail>



of 252

Revision 2.0

</schoolDetailsList>

</educationInfo>

<permanencyInfo/>



<placementInfoList>

<placementInfo>

<removalBeginDate>2018-06-08 13:15:00.0</removalBeginDate>

<removalEndDate>2018-07-20 13:00:00.0</removalEndDate>

<removalReason>Emotional Abuse/Neglect, Caretaker's Inability to

Cope</removalReason>

<removalManner>Court Ordered</removalManner>

<caregiverStructure>Unmarried Couple</caregiverStructure>




<serviceType>Foster Home Traditional 0-5</serviceType>

<placementSetting>Foster Family Home (Non-

Relative)</placementSetting>

<providerName>Blake, Patricia</providerName>


<providerAdRouteNmbr></providerAdRouteNmbr>

<providerAdRouteBoxnmbr></providerAdRouteBoxnmbr>


<providerAdStrtNme>Drxpvgifm WI</providerAdStrtNme>

<providerTxTown>Brandon</providerTxTown>







</placementInfo>

</placementInfoList>


<inHomeServiceInfo>






<providerName>FLORIDA UNITED METHODIST

CHILDREN'S</providerName>



<providerAdStrtNme>D Ivbmlowh HG</providerAdStrtNme>

<providerTxTown>Plant City</providerTxTown>







of 252

Revision 2.0






<legalActionList>

<legalAction>


<legalAction>Case Plan Acceptance - Subsequent</legalAction>

<legalStatus>Approved</legalStatus>


</legalAction>

<legalAction>


<legalAction>Hearing - Advisory - Subsequent</legalAction>

<legalStatus>Consent</legalStatus>


</legalAction>

<legalAction>


<legalAction>Hearing - Advisory - Initial</legalAction>



</legalAction>

<legalAction>


<legalAction>Motion - Other</legalAction>



</legalAction>

</legalActionList>

</caseParticipant>

<caseParticipant>


<firstName>Wilma</firstName>

<lastName>Szignzm</lastName>


<status>Inactive</status>






<race></race>






<medicalInfo>




of 252

Revision 2.0

<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

<caseParticipant>


<firstName>Jose</firstName>

<lastName>Hzmxsva</lastName>



<serviceRole>Non-Relative/Not In Home</serviceRole>






<race></race>






<medicalInfo>


<mentalHealthInfo/>


</medicalInfo>

<educationInfo/>

<permanencyInfo/>





<legalActionList/>

</caseParticipant>

</caseParticipantsDetails>

<casePartList>

<CPL>

<PARTID>7234346</PARTID>

<PARTFNM>Derrick</PARTFNM>

<PARTLNM>Hkvvw</PARTLNM>

<PARTSFX></PARTSFX>

<PARTDOB>1980-03-11 00:00:00.0</PARTDOB>

</CPL>



of 252

Revision 2.0

<CPL>


<PARTFNM>Linda</PARTFNM>

<PARTLNM>Ef</PARTLNM>

<PARTSFX></PARTSFX>

<PARTDOB>1988-09-28 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Jimmy</PARTFNM>


<PARTSFX></PARTSFX>

<PARTDOB>1991-10-28 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Dat</PARTFNM>


<PARTSFX></PARTSFX>

<PARTDOB>1953-06-11 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Allison</PARTFNM>


<PARTSFX></PARTSFX>

<PARTDOB>2015-08-25 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Brenda</PARTFNM>


<PARTSFX></PARTSFX>

<PARTDOB>1993-12-15 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Unknown</PARTFNM>

<PARTLNM>Fmpmldm</PARTLNM>

<PARTSFX></PARTSFX>

<PARTDOB>1900-01-01 00:00:00.0</PARTDOB>

</CPL>

<CPL>


<PARTFNM>Cataleya</PARTFNM>


<PARTSFX></PARTSFX>

<PARTDOB>2017-05-25 00:00:00.0</PARTDOB>

</CPL>

<CPL>




of 252

Revision 2.0

<PARTFNM>Jose</PARTFNM>

<PARTLNM>Hzmxsva</PARTLNM>

<PARTSFX></PARTSFX>

<PARTDOB>1956-03-15 00:00:00.0</PARTDOB>

</CPL>

</casePartList>

</caseDetails>

</caseDetailsOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


301 Case Id is a required field

302 Worker Role Id is a required field



305 Required Information is a required field

306 Enter Valid Required Information

2.3.9. Sort Sequence Each section of the output is sorted by ascending creation date (not visible)

2.3.10. XML Processing N/A


ADDRESS X

ASSIGNMENT X

CAN_TEXT X

CAN_TEXT_EVENT X

CASE_MASTER X

CASE_PLAN X

CASE_PLAN_GOAL X

CASE_PLAN_PARTICIPATION X

CASE_PLAN_TASK X

CASE_PLAN_TASK_ITEM X

CASE_PLAN_TASK_ITEM_DETAIL X

CATEGORY_TYPE X



of 252

Revision 2.0

CODE_DECODE X

CODE_DESC X

CODE_DESC_LRG X

CODE_LDESC_LRG X

CP_TASK_REVW_ITEM_DTL X

DOC_NARRATIVE X

EDUCATION X

EPISODE X

FAMILY_ASSMNT X

IL_EVALUATION X

IL_PLAN_DATE X


LEGAL_ACTION X

LEGAL_ACTION X

LIVING_ARRANGEMENT X

MEDICAL_PROFILE X

MEDICATIONS X

MENTAL_HEALTH_PROFILE X

MISSING_CHILD_MAIN X

PAY_CLAIM_HISTORY X

PERSON X

PROVIDER_ORG X

QSTN_BANK X

SCHOOL X

SERVICE_TYPE X

WORKER X

2.4. Web Service: getCodeDecodeList 2.4.1. Functional Description

This webservices retrieves the identifiers and description for dropdown fields in the FSFN application. In

the FSFN application code, codified lists in dropdown fields (eg. Grade levels, service types, provider

types etc.) are populated by specifying the group name. This group name is run through the reference

data system to populate the dropdown with the full text descriptions. The getCodeDecodeList retrieves

the same results as this process in FSFN, using the same input (group name).

These reference values are stored in the CODE_DESC, CODE_DECODE, CODE_DESC_STATIC, and

CODE_DESC_LRG tables. For each input group name, the respective results will be retrieved (Code

Group Id, Code Group Name and the Description).

The below table contains all the possible group names the input will accept.

TABLE NAME GROUP NAME FSFN MAPPING

CODE_DESC CASETYPE Maintain Case page - Participants tab - Case

Type

ABSFREQ Medical Mental Health - Frequency

KINGRADE Education - Current Grade Level



of 252

Revision 2.0

SRVCROLE Maintain Case page - Service Role

EPSDRLTN

Out of Home Placement - Relationship of Child

to

Relative Caregiver

SRVCTGRY Out of Home Placement - Service Category

PLCMSTNG Out of Home Placement – Placement Setting

EPSDRMVM Out of Home Placement – Manner of Removal

CARETKER Out of Home Placement – Caregiver Structure

EPSDRLTN

Out of Home Placement – Relationship of child

to

Relative Caregiver

CASEPLAN Out of Home Safety Plan – Status.

REGION Person Management - County

CASEDESC Maintain Case page – Family structure

CMBNETHN Person Management - Ethnicity

INDNTRIB Person Management - Indian Tribe 1

ACESTYPE Intake – Access Type.

RSNSEEN Case Note - Reason Not Seen

TYPESERV Medical Mental Health – Type of Service

PRVDTYPE Medical Mental Health - Provider Type

CODE_DECODE CPCOURT Case Plan - Court Approved Status

CASEPLGL Case Plan Goal – Primary Goal, Secondary Goal

CPTRPURP Case Plan Goal Review - Review Type

LAOUTCME Legal – Primary

LAGOAL Legal – Primary

CONDTYPE Medical Mental Health - Condition Type

LEGLSTAT Legal - Legal Status

LARESULT Legal – Result.

LAINIT Legal – Legal Action Initiated

LACUST Legal - Legal Custody Status

CMPLNC Case Plan Task Review - Overall Compliance

CPSRVCDL Case Plan Task Review - Service Delivery

CPCNTCT Case Plan - Type of Contact

CPPRTCPT Case Plan – Participation

ILOUTCME Independent Living - Outcome

CODE_DESC_STATIC SCHLTYPE Education – School Type

FASTAT Family Assessment - Status

FAPURPSE Family Assessment - Purpose

CPPURP Case Plan - Case Plan Tasks Information -

Purpose

FTOFCNTC Case Note - Face-to-Face Contact



of 252

Revision 2.0

CODE_DESC_LRG LVNGARRN Out Of Home Placement – Living Arrangement

SFTYCTGR Maintain Case Plan Item - Service Category

LEGLSTAT Legal - Legal Status

SFTYSRVC Maintain Case Plan Item - Service Type


<xsd:element name="codeDecodeListInputForm"

type="CodeDecodeListInputForm" />

<xsd:complexType name="CodeDecodeListInputForm">

<xsd:sequence>

<xsd:element name="workerRoleId" type="xsd:decimal" />

<xsd:element name="GroupIdList" type="GroupIdList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="GroupIdList">

<xsd:sequence>

<xsd:element name="GRPID" minOccurs="0"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="groupId"


<xsd:element name="filter"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.4.3. Input Variables XML Tag Name Description FSFN

Database

Mapping

FSFN

Frontend

Mapping

Data Type

codeDecodeListInputForm The form class that holds the

input elements to be passed to

invoke the

getCodeDecodeList

web method

N/A N/A N/A

workerRoleId No effect on output N/A N/A Numeric

groupIdList List of Group Id’s. N/A N/A N/A



of 252

Revision 2.0

groupId The group name of the

reference data representing a

dropdown in FSFN. The only

non-group name input that

will return data is “All”,

which will return all the

possible group name results.

N/A String

2.4.4. Example Input <jav:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mob="http://fsfn.dcf.state.fl.us/mobile"

xmlns:jav="java:com.ams.sacwis.mobile.services">

<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCodeDecodeList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<codeDecodeListInputForm>


<groupIdList>

<groupId>SFTYCTGR</groupId>

<groupId>LAINIT</groupId>

</groupIdList>

</codeDecodeListInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="codeDecodeListOutputForm"

type="CodeDecodeListOutputForm"/>



of 252

Revision 2.0

<xsd:complexType name="CodeDecodeListOutputForm">

<xsd:sequence>

<xsd:element name="codeDecode" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="groupId" type="xsd:string"/>

<xsd:element name="groupName" type="xsd:string"/>

<xsd:element name="groupDescription" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag Name Description FSFN

Databas

e

Mapping

FSFN

Frontend

Mapping

Data Type/Length

codeDecodeListOutputForm The form class that

holds the array of

returned list of values

N/A N/A N/A

codeDecode The form class that

holds the GroupId,

Group Name and

GroupDescription

information

N/A N/A

groupId The GroupId

element holds the group

id for the

particular code

decode group

CODE_DEC

ODE.ID_GRP

,

CODE_DESC

.ID_GRP,

CODE_DESC

_STATIC,

CODE_DESC

*

N/A Numeric

groupDescription The GroupDescription

element holds the

group description for

the particular code

decode

group

N/A String/60

groupName The GroupName N/A String/8



of 252

Revision 2.0

element holds the group

name.

2.4.7. Example Output Note: Output has been curtailed for brevity by removing most of the codeDecode results for each group

name.


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCodeDecodeList</java:methodName>





<codeDecodeListOutputForm>

<codeDecode>

<groupId>1</groupId>

<groupName>SFTYCTGR</groupName>

<groupDescription>Basic Life Skills</groupDescription>

</codeDecode>

<codeDecode>


<groupName>SFTYCTGR</groupName>

<groupDescription>Basic Parenting Assistance</groupDescription>

</codeDecode>

<codeDecode>


<groupName>LAINIT</groupName>

<groupDescription>Appeal - SC - 9.7 - Oral Argument</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - 9.7 - Decision Rendered</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - 9.8 - Post-Decision

Motion</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - 9.9 - Response to Post-Decision




of 252

Revision 2.0

</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - 9.9.1 - Order on Post Decision


</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - 9.9.2 - Mandate Issued</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Appeal - SC - Reply Brief on Merits</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Status Review - Drug Court</groupDescription>

</codeDecode>

<codeDecode>



<groupDescription>Status Review - ICPC</groupDescription>

</codeDecode>

</codeDecodeListOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.4.8. Error Guide





1504 Group Id is a required field

1505 Enter Valid Group Information



of 252

Revision 2.0


The output XML sent will be sorted by group name.




2.4.11. CRUD Matrix


CODE_DESC X

CODE_DECODE

CODE_DESC_LRG

CODE_DESC_STATIC

2.5. Web Service: getCaseDocumentList 2.5.1. Functional Description

This webservice provides the list of case documents that are available for the specified case

ID. Each element in the list contains a minimal set of information regarding the individual

case document. The documents contained in this list include only those which are created in

FSFN. Those created from the Mobile Data Capture Solution are handled in the

getMobileDocumetList web service. The tags related to Safety Plan and Out of Home plan

are only populated for the Safety Plan and Out of Home Plan documents.


<xsd:element name="caseDocumentListInputForm"

type="CaseDocumentListInputForm"/>

<xsd:complexType name="CaseDocumentListInputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database Mapping

FSFN Frontend Mapping

Data Type

CaseDocumentListInputForm The form class that holds



getCaseDocumentList web

method

N/A N/A N/A



of 252

Revision 2.0

caseId The caseId is the ID of the

case for which the output

will be returned.

CASE_M

ASTER.ID

_CASE

Maintain

Case page

– header

Numeric

workerRoleId No effect on output. ORG_WORK

ER_ROLE.ID

_WORKER_

ROLE

N/A Numeric



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCaseDocumentList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<caseDocumentListInputForm>



</caseDocumentListInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="caseDocumentListOutputForm"

type="CaseDocumentListOutputForm"/>

<xsd:complexType name="CaseDocumentListOutputForm">

<xsd:sequence>

<xsd:element name="caseDocument" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>



of 252

Revision 2.0




<xsd:element name="personId" type="xsd:decimal"/>

<xsd:element name="personFirstName" type="xsd:string"/>

<xsd:element name="personLastName" type="xsd:string"/>

<xsd:element name="documentTextId" type="xsd:decimal"/>

<xsd:element name="documentId" type="xsd:decimal"/>

<xsd:element name="documentName" type="xsd:string"/>

<xsd:element name="createdDate" type="xsd:string"/>

<xsd:element name="safetyPlanStatus" type="xsd:string"/>

<xsd:element name="safetyPlanDtEffective" type="xsd:string"/>

<xsd:element name="safetyPlanId" type="xsd:decimal"/>

<xsd:element name="outofHomePlanStatus" type="xsd:string"/>

<xsd:element name="outofHomePlanDtEffective" type="xsd:string"/>

<xsd:element name="outofHomePlanId" type="xsd:decimal"/>

<xsd:element name="outofHomePlanPartId" type="xsd:decimal"/>

<xsd:element name="outofHomePlanPartFirstName" type="xsd:string" />

<xsd:element name="outofHomePlanPartLastName" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database Mapping


Data

Type/

Length

caseDocumentListOutputForm The form class that

holds the array of

returned case

documents for the

input case Id

N/A N/A N/A

caseDocument The form class that

holds the

DocumentId, CaseId,

DocumentTextId,

WorkTypeId and

CountyId information

DOCUMENT

_MGMT

N/A N/A

documentTextId The DocumentTextId

element holds the Id

of the document text

and is part of the

primary key for

identifying a

document that is

retrieved for the case

DOCUMENT

_MGMT

N/A Numeric



of 252

Revision 2.0

Id

documentId This element holds

the document Id of

the document

DOCUMENT

_MGMT

N/A Numeric

personId The participantId


of the case participant

for which the

document is created

(if available).

DOCUMENT

_MGMT

Case

Informatio

n Page

Numeric

personFirstName The personFirstName

element holds the first

name of the case

participant for which

the document is created

(if available).

DOCUMENT

_MGMT

Case

Informatio

n Page

String/40

personLastName The personLastName

element holds the last

name of the case

participant for which

the document is created

(if available).

DOCUMENT

_MGMT

Case

Information

Page

String/40

workerRoleId The workerId element

holds the information

regarding worker who

created the document

DOCUMENT

_MGMT

Case

Information

Page

Numeric

workerFirstName The workerFirstName

element holds the

information regarding

worker first name who


DOCUMENT

_MGMT

Case

Information

Page

String/40

workerLastName The workerLastName

element holds the

information regarding

worker last name who


DOCUMENT

_MGMT

Case

Information

Page

String/40

documentName The documentName

element holds the name

of the document.

DOCUMENT

_MGMT

N/A String/100



of 252

Revision 2.0

createdDate Document created

timestamp in FSFN

DOCUMENT

_MGMT

Safety Plan

Page

String/10

safetyPlanStatus Status of the Safety

Plan

SAFETY_PL

AN

Safety Plan

Page

String/15

safetyPlanDtEffective Date from which the

safety plan is effective

SAFETY_PL

AN

Safety Plan

Page

String/10

safetyPlanId Unique identifier

associated with the

safety plan record

saved

SAFETY_PL

AN

Safety Plan

Page

Numeric

outofHomePlanStatus Status of out of home

plan

SAFETY_PL

AN

Safety Plan

Page

String/15

outofHomePlanDtEffective Date from which the

out of home plan is

effective

SAFETY_PL

AN

Safety Plan

Page

String/10

outofHomePlanId Unique identifier

associated with the out

of home plan record

SAFETY_PL

AN

Safety Plan

Page

Numeric

outofHomePlanPartId The participant Id for whom the out of home plan is created

SAFETY_PL

AN

Safety Plan

Page

Numeric

outofHomePlanPartFirstName First name associated with the participant for whom the out of home plan is created

SAFETY_PL

AN

Safety Plan

Page

String/40

outofHomePlanPartLastName Last name associated with the participant for whom the out of home plan is created

SAFETY_PL

AN

Safety Plan

Page

String/40

2.5.7. Example Output


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDocumentList</java:methodName>





<caseDocumentListOutputForm>



of 252

Revision 2.0

<caseDocument>


<workerFirstName>Christian</workerFirstName>

<workerLastName>Zoeziva</workerLastName>

<documentTextId>154483627</documentTextId>

<documentId>1011059</documentId>

<createdDate>2016-04-14 15:26:47.891184</createdDate>

</caseDocument>

</caseDocumentListOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.5.8. Error Guide






505 There are no documents for this case


The output XML sent will be sorted by document name.




2.5.11. CRUD Matrix


DOCUMENT_MGMT X

SAFETY_PLAN X

2.6. Web Service: getCaseDocument 2.6.1. Functional Description



of 252

Revision 2.0

This webservice returns the specified document, in soft copy, from the FSFN document

repository, based on the document selected from the document list. This includes only those

documents which are created in FSFN. Those documents created from the Mobile Data

Capture Solution are handled by the getMobileDocument web service.

2.6.2. Input Schema


<xsd:element name="caseDocumentInputForm" type="CaseDocumentInputForm"/>

<xsd:complexType name="CaseDocumentInputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag Name Description FSFN Database Mapping


Data Type

caseDocumentInput

Form

The form class

that holds the

input elements

to be passed to

invoke the

getCaseDocum

ent web

method

N/A N/A N/A

documentTextId The

documentTextI

d element

holds the Id of

the document

to be fetched

DOCUMENT_TEXT

N/A Numeric

workerRoleId Worker Role

Id. No effect on

output.

N/A N/A Numeric



<jav:Header/>



of 252

Revision 2.0

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCaseDocument</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<caseDocumentInputForm>



</caseDocumentInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="caseDocumentOutputForm" type="CaseDocumentOutputForm"/>

<xsd:complexType name="CaseDocumentOutputForm">

<xsd:sequence>

<xsd:element name="documentStream" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag Name Descriptio

n

FSFN

Database

Mapping

FSFN Frontend

Mapping

Data

Type/

Lengt

h

caseDocumentOutput

Form

The form class

that holds the

output.

N/A N/A N/A



of 252

Revision 2.0

documentStream The

documentStre

am element is

a hexadecimal

representation

of the

document.

DOCUMENT_TE

XT.BL_TEXT

N/A BLOB(

21474836

47)


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDocument</java:methodName>





<caseDocumentOutputForm>

<documentStream>...output in hexadecimal...</documentStream>

</caseDocumentOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.6.8. Error Guide


401 Document Text Id is a required field





Not applicable for this web service.






of 252

Revision 2.0

2.6.11. CRUD Matrix


DOCUMENT_TEXT X

2.7. Web Service: getChildPhotoList 2.7.1. Functional Description

This web service retrieves the list of photos available in FSFN for a specific person. This

includes current and historical photos accessible from each participant’s person management

record in FSFN. The pictures themselves are not returned, only the identifiers for those

pictures.


<xsd:element name="childPhotoListInputForm" type="ChildPhotoListInputForm"/>

<xsd:complexType name="ChildPhotoListInputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data

Type

childPhotoListInputForm The form class that

holds the input

elements to be

passed to invoke

the

getChildPhotoList

web

method

N/A N/A

personId The personId

element holds the

Id of the child

whose photos

needs to be fetched

PERSON.ID_PRSN Person

Management Numeric

workerRoleId Worker Role Id. No

effect on output.

N/A Numeric



<jav:Header/>



of 252

Revision 2.0

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getChildPhotoList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<childPhotoListInputForm>


<personId>106002615</personId>

</childPhotoListInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="childPhotoListOutputForm"

type="ChildPhotoListOutputForm"/>

<xsd:complexType name="ChildPhotoListOutputForm">

<xsd:sequence>

<xsd:element name="childPhoto" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>




<xsd:element name="photoId" type="xsd:decimal"/>

<xsd:element name="photoType" type="xsd:string"/>

<xsd:element name="fileName" type="xsd:string"/>

<xsd:element name="photoDate" type="xsd:string"/>

<xsd:element name="comments" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0



Datab

ase

Mappi

ng

FSFN Frontend

Mapping

Data

Typ

e/

Len

gth

childPhotoListOutpu

tForm

that holds the

array of

returned

photos for the

input personId

N/A N

/

A

childPhoto The form class

that holds the

filename,

personId and

photoId,

personFirstNa

me,

personLastNa

me, comments,

photoDa

te

informat

ion

N/A N

/

A

fileName The filename

element holds

the

name of the

photo

IMAGING_M

GMT.TX_FIL

E_NAME

Imaging page String/100

personId The personId

element holds

the Id of the

person for

which the

photo is being

retrieved

IMAGING_M

GMT.ID_IMG

_PRIMARY

Imaging page Numeric

photoId Primary key

of photo

table. Unique

identifier for

the photo.

IMAGING_M

GMT.ID_IMA

GING_MGMT




of 252

Revision 2.0

photoDate The photoDate

element holds

the

name of the

photo

IMAGING_M

GMT.DT_EFC

TV


comments The comments

element holds

the additional

comments

regarding the

image scanned

into FSFN

IMAGING_M

GMT.TX_CO

MMENTS


personFirstName The

personFirstNa

me element

holds the

name of the

person

PERSO

N.NM_

FRST

Person Management String/40

personLastName The person’s

last name

PERSO

N.

NM_LS

T +

PERSO

N.NM_

SFX

Person Management String/40

2.7.7. Example output


<env:Header/>

<env:Body>



<java:methodName xmlns:java="java:com.ams.sacwis.mobile.services">getChildPhotoList</java:methodName>



<java:outputXML xmlns:java="java:com.ams.sacwis.mobile.services"><?xml version="1.0" encoding="UTF-8"?>

<childPhotoListOutputForm>

<childPhoto>


<personFirstName>Cayden</personFirstName>



of 252

Revision 2.0

<personLastName>Bzmxvb</personLastName>


<photoType>Person Photo</photoType>

<fileName>IPHONE-image.jpg</fileName>

<photoDate>12/04/2017</photoDate>

</childPhoto>

<childPhoto>






<fileName>Cayden Yancey.jpg</fileName>


</childPhoto>

<childPhoto>








</childPhoto>

<childPhoto>








</childPhoto>

</childPhotoListOutputForm>

</java:outputXML>

<java:exceptionXML xmlns:java="java:com.ams.sacwis.mobile.services"><?xml version="1.0" encoding="UTF-8"?>



of 252

Revision 2.0

<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.7.8. Error Guide


701 Person Id is a required field









2.7.11. CRUD Matrix


IMAGING_MGMT X

PERSON X

2.8. Web Service: getChildPhoto 2.8.1. Functional Description

This method returns the specified case participant photo, based on the participant photo

selected from the photo list.


<xsd:element name="childPhotoInputForm" type="ChildPhotoInputForm"/>

<xsd:complexType name="ChildPhotoInputForm">

<xsd:sequence>

<xsd:element name="photoId" type="xsd:decimal"/>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>




of 252

Revision 2.0

XML Tag

Name

Description FSFN Database Mapping FSFN Frontend Mapping

Data Type

childPhotoInputFor

m

The form class

that holds the

input elements to

be passed to

invoke the

getPhoto web

method

N/A N/A N/A

photoId The photoId

element holds the

photo Id.

IMAGING.ID_IMAGING_MGM

T (UDB database only)


workerRoleId Worker Role Id.

No effect on

output.

N/A Numeric

2.8.4. Example Input <jav:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mob="http://fsfn.dcf.state.fl.us/mobile" xmlns:jav="java:com.ams.sacwis.mobile.services"> <jav:Header/> <jav:Body> <mob:mobileService> <mob:p_form> <jav:methodName>getChildPhoto</jav:methodName> <jav:loginXML> <![CDATA[ <mobileLogonForm> <username>ds65506</username> <password>xxxxxxxxx</password> </mobileLogonForm> ]]> </jav:loginXML> <jav:inputXML> <![CDATA[ <childPhotoInputForm> <workerRoleId>12345678</workerRoleId> <photoId>900000120</photoId> </childPhotoInputForm> ]]> </jav:inputXML> <jav:outputXML>?</jav:outputXML> <jav:exceptionXML>?</jav:exceptionXML> </mob:p_form> </mob:mobileService> </jav:Body>



of 252

Revision 2.0

</jav:Envelope>


<xsd:element name="childPhotoOutputForm" type="ChildPhotoOutputForm"/>

<xsd:complexType name="ChildPhotoOutputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag

Name

Descriptio

n

FSFN Database Mapping FSFN

Fronte

nd

Mappin

g

Data

Type/Length

childPhotoOutputFo

rm

The form class

that holds the

binary stream

of the

document that

is returned for

the input

photoId

N/A N/A

documentStream The

documentStre

am element

holds the

stream

information of

the photo in

Hex

format.

IMAGING.BL_IMAGE (UDB

database only)

N/A BLOB(104857

6)

fileName Name of the

File.

IMAGING_MGMT.TX_FILE_N

AME

N/A String/100


<env:Header/>

<env:Body>



<java:methodName



of 252

Revision 2.0

xmlns:java="java:com.ams.sacwis.mobile.services">getChildPhoto</java:methodName>





<childPhotoOutputForm>

<fileName></fileName>

<documentStream>…hexadecimal photo data … </documentStream>

</childPhotoOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.8.8. Error Guide


601 Photo Id is a required field







For getPhoto (Clients using the .NET framework):

1. Clients are not required to decode the image using the Hex decoder.

For getPhoto (Clients using the java framework):

1. Clients are required to decode the image using the Hex decoder.


IMAGING_MGMT X

PERSON X

2.9. Web Service: saveChildPhoto 2.9.1. Functional Description



of 252

Revision 2.0

This web service saves a new participant photo with identifying information, including

location, case ID, person ID, and a comment.


<xsd:element name="saveChildPhotoInputForm" type="saveChildPhotoInputForm"/>

<xsd:complexType name="saveChildPhotoInputForm">

<xsd:sequence>


<xsd:element name="casePartId" type="xsd:decimal"/>

<xsd:element name="datePhotoTaken" type="xsd:date"/>

<xsd:element name="photo" type="xsd:string"/>

<xsd:element name="latitude" type="xsd:decimal"/>

<xsd:element name="longitude" type="xsd:decimal"/>

<xsd:element name="altitude" type="xsd:decimal"/>

<xsd:element name="tsCreated" type="xsd:date"/>

<xsd:element name="comment" type="xsd:string"/>

<xsd:element name="txFileName" type="xsd:string"/>


<xsd:element name="deviceType" type="xsd:decimal"/>

<xsd:element name="gpseviceType" type="xsd:decimal"/>

<xsd:element name="gpsAccuracy" type="xsd:string"/>

<xsd:element name="workType" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag

Name

Description FSFN Database

Mapping

FSFN Frontend

Mapping

Data

Type

/

Leng

th

saveChildPhotoF

orm




saveNewChildPhoto web

method

N/A N/A


the case id of the person

whose photo needs to be

saved.

CASE_MASTER.ID_

CASE

Maintain Case page

– header Numeric



of 252

Revision 2.0

casePartId The casePartId element

holds the case part id of

the person whose photo

needs to be saved

CASE_PART.ID_PRSN

Person Management

Numeric

datePhotoTaken The photoTaken element

holds the Photo taken

date and time of the

person whose photo

needs to be saved

IMAGING_PART.TS_

CR

Imaging page Timesta

mp

photo The photo element holds

the Binary stream of the

Person photo.

IMAGING.BL_IMAG

E (UDB)

Imaging page HexStrin

g

latitude Latitude value of the

location where the photo

was taken.

GPS_COORD.NUM_L

ATITUDE


longitude Longitude value of the


was taken.

GPS_COORD.NUM_L

ONGITUDE


altitude Altitude value of the


was taken.

GPS_COORD.NUM_A

LTITUDE


comment Comments on the photo

which goes into

the comments

section.

IMAGING_MGMT.TX

_COMMENTS

Imaging page String /

500

tsCreated Date and Time Created

for GPS Purpose. IMAGING_MGMT.TS

_CR

Imaging page Timesta

mp

txFileName File Name of the Photo IMAGING_MGMT.TX

_FILE_NAME

Imaging page String /

100

workerRoleId Worker Role Id. Must be

a role with an assignment

to the specified case.

ORG_WORKER_ROL

E.ID_WORKER_ROL

E

N/A Numeric

deviceType The type of device :

Blackberry or

Laptop

RDC_EVENTS.

CD_RDC_DVC_TYPE

N/A Numeric

gpseviceType

GPS type : Satellite

Type or BB GPS RDC_EVENTS.

CD_RDC_DVC_TYPE

N/A Numeric

gpsAccuracy Accuracy of the

GPS coordinates RDC_EVENTS.TX_G

PS_ACCURACY

N/A String

/200

workType RDC type of work : Case

management, CPI, CLS RDC_EVENTS.

CD_RDC_WRK_TYP

E

N/A Numeric

Reference values for deviceType



of 252

Revision 2.0

deviceType Group Id Description

2033 RDCDTYPE Blackberry

2034 RDCDTYPE Laptop

Reference values for gpseviceType

GPSTYPE Group Id Description

2035 GPSTYPE Satellite Type

2036 GPSTYPE BB GPS

2040 GPSTYPE Verizon AGPS

Reference values for workType


2037 RDCWTYPE Case Management

2038 RDCWTYPE CPI

2039 RDCWTYPE CLS



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>saveChildPhoto</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveChildPhotoInputForm>


<casePartId>990000081</casePartId>

<datePhotoTaken>2010-06-17T00:00:00-04:00</datePhotoTaken>

<photo>ffd8ffe000104a46494600010100000100010000</photo>

<latitude>24.1234567</latitude>

<longitude>-80.2400023</longitude>

<altitude></altitude>

<comment></comment>


<txFileName>test.jpg</txFileName>


<deviceType>2033</deviceType>



of 252

Revision 2.0

<gpseviceType>2035</gpseviceType>

<gpsAccuracy>test</gpsAccuracy>

<workType>2038</workType>

</saveChildPhotoInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="saveChildPhotoOutputForm" type="SaveChildPhotoOutputForm"/>

<xsd:complexType name="SaveChildPhotoOutputForm">

<xsd:sequence>

<xsd:element name="imageId" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag Name Descripti

on

FSFN Database Mapping FSFN

Fronte

nd

Mappin

g

Data

Type/

Lengt

h

SaveChildPhotoOutputF

orm

The form class

that

holds the

output of this

web method

N/A N/A

imageId Id of the photo

from

the database that

was just saved.

IMAGING.ID_IMAGING_MG

MT (UDB)

Imaging

page

Numeric

2.9.7. Example output <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">

<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">saveChildPhoto</java:methodName>



of 252

Revision 2.0





<saveChildPhotoOutputForm>

<imageId>990000032</imageId>

</saveChildPhotoOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.9.8. Error Guide



902 Case Part Id is a required field

903 Date Photo Taken is a required field

904 Photo is a required field




908 Timestamp Created is a required field

909 Longitude is required if Latitude is present

910 Latitude is required if Longitude is present

911 Longitude and latitude are required if

altitude is present

912 For the same person on same date/time

photo has been uploaded.

913 WorkerRoleId is invalid

914 Case ID and Case Participant Id

combination is not valid.

915 WorkerRoleId passed doesn’t have open

assignment to the case.

916 Timestamp Created should not be a future

date.

917 Date Photo Taken should not be a future

date.

918 File Name is a required field.

919 The format of the tsCreated is not correct.

Please send a valid timestamp



of 252

Revision 2.0

920 The format of the dataPhotoTaken is not

correct. Please send a valid timestamp

921 RDC Device Type is not a valid value

922 GPS Device Type is not a valid value

923 RDC Work Type is not a valid value


Not applicable for this web service


For SaveChildPhoto (Clients using the .NET/Java framework):

1. Clients are required to encode the image in the .NET/Java code in the Hexadecimal format

and need to send the photo via the XML and they are not required to be aware of the

decoding part on the server side.

Photo gets saved in FSFN only after the input data goes through all the validation

checks for both required fields and valid values.


IMAGING_MGMT X

ORG_WORKER_ROLE X

CASE_PART X

ASSIGNMENT X

IMAGING (UDB) X X

IMAGING_PART X X

GPS_COORD X X

RDC_EVENTS X X

2.10. Web Service: saveCaseDataXml 2.10.1. Functional Description

This web service saves the Safety Plan, Out of Home Plan, Case Notes and form data passed

in the input XML to the database as a blob. When the data is passed in the input XML, those

elements that are to be captured within the Safety Plan or Out of Home Plan pages will be

extracted and input into the appropriate fields if they exist in FSFN. This data is not to be

confused with the Safety Plan and Out of Home Plan forms that are being sent to FSFN from

the Mobile Data Capture Solution, which are outlined within the saveMobileCaseDocument,

getMobileCaseDocumentList and getMobileCaseDocument web services. The Safety Plan and

Out of Home Plan forms uploaded into FSFN using saveMobileCaseDocument will be linked

to the Out of Home Plan and Safety Plan pages created with the saveCaseDataXml webservice

only when the documentId returned from saveMobileCaseDocument is passed in the input of

saveCaseDataXml. For Safety Plan pages created from saveCaseDataXml to be linked to

Safety Plan form created by saveMobileCaseDocument, the documentId returned in

saveMobileCaseDocument should be passed into the input (element idImagingMngmnt of

SafetyPlan) of saveCaseDataXml. Similarly, Out of Home Plan pages will be linked to the Out



of 252

Revision 2.0

of Home Plan form uploaded when documentId returned is passed into the input

(idImagingMngmnt of outOfHomePlan) of saveCaseDataXml. When the Safety Plan

document uploaded is linked with the Safety Plan Page created in FSFN, the document can be

seen on the desktop under the Safety Plan in Planning expando of case expando. Similarly,

when the Out of Home Plan document uploaded is linked with the Out of Home Page Created

in FSFN, the document can be seen on the desktop under the Out of Home Plan in Planning

expando of case expando. The Safety Plan document uploaded can be seen in FSFN when the

corresponding Safety Plan is expanded on the desktop under the case expando. Similarly, Out

of Home Plan document uploaded can be seen in SFN when the corresponding .When the data

is passed in the input XML, those elements that are to be captured within a Case Note, will

automatically be input into the Narrative field of the Case Note. All Case Notes created from

the Remote Data Capture Solution will be given a Note Category of „Mobile Device.‟ This

Note Category will not be available for selection by users in the FSFN application and will

only be used for this purpose. Within the Note Category “Mobile Device,” the following Note

Types will be used: Verification, Permanency Plan and Case Plan, Observation of the Child,

Type of Visit, Educational, Child Age 13 and older and in Out of Home Care, Review of

Visitation Plan for Out of Home Care, Cultural or Religious Concerns or Needs, Child’s

Comments and Questions, and Provider/Caregiver’s Comments and Questions. In addition,

based on the data passed in the input XML, FSFN will populate the appropriate Contact Begin

Date and Time for each note, as well as the Contact End Date and Time, if provided.


<xsd:element name="rDCsaveXMLInput" type="RDCsaveXMLInput"/>

<xsd:complexType name="RDCsaveXMLInput">

<xsd:sequence>



<xsd:element name="formData" type="xsd:string"/>


<xsd:element name="latitude" type="xsd:decimal"/>

<xsd:element name="longitude" type="xsd:decimal"/>

<xsd:element name="altitude" type="xsd:decimal"/>

<xsd:element name="deviceType" type="xsd:decimal"/>

<xsd:element name="gpseviceType" type="xsd:decimal"/>

<xsd:element name="gpsAccuracy" type="xsd:string"/>

<xsd:element name="workType" type="xsd:decimal"/>

<xsd:element name="caseNotesList" type="CaseNotesList"/>

<xsd:element name="safetyPlan" type="SafetyPlan"/>

<xsd:element name="outOfHomePlanList" type="OutOfHomePlanList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CaseNotesList">

<xsd:sequence>

<xsd:element name="caseNote" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>


<xsd:element name="cdType" type="xsd:decimal"/>



of 252

Revision 2.0

<xsd:element name="cdCategory" type="xsd:decimal"/>

<xsd:element name="cdWrkrActCode" type="xsd:decimal"/>

<xsd:element name="tsOccured" type="xsd:date"/>

<xsd:element name="contactEndDate" type="xsd:date"/>

<xsd:element name="noteText" type="xsd:string"/>

<xsd:element name="contactInformationList"

type="contactInformationList"/>

<xsd:element name="otherContactsList" type="otherContactsList"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="contactInformationList">

<xsd:sequence>

<xsd:element name="contactInformation" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>


<xsd:element name="contactName" type="xsd:string"/>

<xsd:element name="faceToFace" type="xsd:string"/>

<xsd:element name="reasonNotSeen" type="xsd:decimal"/>

<xsd:element name="contactDate" type="xsd:date"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="otherContactsList">

<xsd:sequence>

<xsd:element name="otherContacts" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="otherContactName" type="xsd:string"/>

<xsd:element name="affiliation" type="xsd:string"/>

<xsd:element name="title" type="xsd:string"/>

<xsd:element name="otherContactDate" type="xsd:date"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="SafetyPlan">

<xsd:sequence>

<xsd:element name="status" type="xsd:string" />

<xsd:element name="idImagingMngmnt" type="xsd:decimal"/>



of 252

Revision 2.0

<xsd:element name="homeEnvironment" type="xsd:string"/>

<xsd:element name="affectingSafety" type="xsd:string"/>

<xsd:element name="residesInHome" type="xsd:string"/>

<xsd:element name="provideServices" type="xsd:string"/>

<xsd:element name="safetyFactorDesc" type="xsd:string"/>

<xsd:element name="safetyActionsTaken" type="xsd:string"/>

<xsd:element name="safetyConcernsDesc" type="xsd:string"/>

<xsd:element name="neededSrvcsExist" type="xsd:string"/>

<xsd:element name="neededSrvcsAvailable" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="OutOfHomePlanList">

<xsd:sequence>

<xsd:element name="outOfHomePlan" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="caseParticipantId" type="xsd:decimal"

/>

<xsd:element name="status" type="xsd:string" />

<xsd:element name="idImagingMngmnt"

type="xsd:decimal"/>

<xsd:element name="onlyChild" type="xsd:string" />

<xsd:element name="siblingsSeparation" type="xsd:string" />

<xsd:element name="childFunction" type="xsd:string" />

<xsd:element name="servedByGroup" type="xsd:string" />

<xsd:element name="meetsSpcCare" type="xsd:string" />

<xsd:element name="americanIndian" type="xsd:string" />

<xsd:element name="relativeAvailable" type="xsd:string" />

<xsd:element name="tribalRepresentative" type="xsd:string"

/>

<xsd:element name="plcmntInvolves" type="xsd:string" />

<xsd:element name="dateNotifiedByMail" type="xsd:date" />

<xsd:element name="determineActionDesc"


<xsd:element name="outsidePlacementDesc"


<xsd:element name="indianChldPreferred" type="xsd:string"

/>

<xsd:element name="indianChldAvailable" type="xsd:string"

/>

<xsd:element name="indianChldSelected" type="xsd:string"

/>

<xsd:element name="fosterHomeByIndPreferred"


<xsd:element name="fosterHomeByIndAvailable"


<xsd:element name="fosterHomeByIndSelected"


<xsd:element name="indianFosterHomePreferred"



of 252

Revision 2.0


<xsd:element name="indianFosterHomeAvailable"


<xsd:element name="indianFosterHomeSelected"


<xsd:element name="groupHomeByIndPreferred"


<xsd:element name="groupHomeByIndAvailable"


<xsd:element name="groupHomeByIndSelected"


<xsd:element name="institutionByIndPreferred"


<xsd:element name="institutionByIndAvailable"


<xsd:element name="institutionByIndSelected"


<xsd:element name="OtherPreferred" type="xsd:string" />

<xsd:element name="OtherAvailable" type="xsd:string" />

<xsd:element name="OtherSelected" type="xsd:string" />

<xsd:element name="needSpecialSkills" type="xsd:string" />

<xsd:element name="describeDesc" type="xsd:string" />

<xsd:element name="concernChildsSafety" type="xsd:string"

/>

<xsd:element name="othersAggrBvrs" type="xsd:string" />

<xsd:element name="othersSexuallyAbusive"


<xsd:element name="othersOtherBehaviors"


<xsd:element name="ConcernOthersSafety" type="xsd:string"

/>

<xsd:element name="childAggrBvrs" type="xsd:string" />

<xsd:element name="childSexuallyAbusive"


<xsd:element name="childOtherBehaviors" type="xsd:string"

/>

<xsd:element name="immediateSftyCncrnsDesc"


<xsd:element name="safetyPlanDesc" type="xsd:string" />

<xsd:element name="spcialTraining" type="xsd:string" />

<xsd:element name="closerSprvision" type="xsd:string" />

<xsd:element name="additionalRules" type="xsd:string" />

<xsd:element name="additionalContact" type="xsd:string" />

<xsd:element name="installSpclEqpmnt" type="xsd:string" />

<xsd:element name="livingArrangements" type="xsd:string"

/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>



of 252

Revision 2.0

</xsd:complexType>

</xsd:schema>




Data Type/ Length

rDCsaveXMLInput The form class that holds



saveCaseNote web

method.

N/A N/A N/A

workerRoleId Worker Role Id. Must be a

role with an assignment to

the specified case.

RDC_EVENT

S.ID_CR,

RDC_XML_R

EPOSITORY.I

D_CR

Maintain

Worker

Numeric


the Case Id for which the

Case Note is created

RDC_XML_R

EPOSITORY.I

D_CASE

Maintain Case Numeric

formData XML data from the RDC

solution.

RDX_XML_R

EPOSITORY.

BL_RDC_XM

L_DATA

String /

30000

tsCreated Time stamp the data created RDC_XML_R

EPOSITORY.

TS_CR,RDC_

EVENTS.TS_

CR

Timestamp

Latitude Latitude value of the child

location /visitation

GPS_COORD Numeric

Longitude Longitude value of the child location/visitation

GPS_COORD Numeric

Altitude Altitude value of the child

location/visitation

GPS_COORD Numeric

deviceType The type of device :

Blackberry or Laptop GPS_COORD Numeric

gpseviceType

GPS type : Satellite Type

or BB GPS GPS_COORD Numeric

gpsAccuracy Accuracy of the GPS

coordinates GPS_COORD String /200

workType RDC type of work : Case

management, CPI, CLS

RDC_EVEN

TS

Numeric



of 252

Revision 2.0

safetyPlan Array of Safety Plan

Information. For each

participant. Contains below

elements.

N/A

status Status. Valid Values are

P,O, H,R,T.

SAFETY_PL

AN

Safety Plan

Page

String/1

idImagingMngmnt Image Management ID SAFETY_PL

AN

Safety Plan

Page

Numeric

homeEnvironment Safety Plan – Safety

Considerations Tab –

The home environment

is calm and stable

enough for Services to

be provided and

for the service providers to

be in the home safely. Valid

Values are either Y or N.

SAFETY_PL

AN

Safety Plan

Page

String/1

affectingSafety Safety Plan – Safety


Safety Actions that control

all of the conditions

affecting safety can be

immediately put in place.

Valid Values are

either Y or N.

SAFETY_PL

AN

Safety Plan

Page

String/1

residesInHome Safety Plan –

Safety Considerations Tab –

Parent/Legal custodian

resides in the home. Valid


SAFETY_PL

AN

Safety Plan

Page

String/1

safetyConcernsDesc Safety Plan – Safety


Describe safety concerns

that would pose immediate

or serious harm or threats

of harm. Consider factors

that pertain to child

vulnerabilities, protective

capacities and signs of

immediate emerging

danger.

SAFETY_PL

AN

Safety Plan

Page

VARCHAR

(32000)



of 252

Revision 2.0

safetyActionsDesc Safety Plan – Safety

Actions Tab –

Describe the specific

safety actions to be taken.

For each action include

the person responsible for

the action, when the

action will occur,

duration, frequency, and

person responsible for

monitoring the safety

plan.

SAFETY_PL

AN

Safety Plan

Page

VARCHAR

(32000)

safetyFactorDesc Safety Plan – Safety

Actions Tab-

Describe how these

specific actions provide

protection from

immediate danger of

serious harm, for each

child, thus decreasing

child vulnerability and

increasing

protective capacities.

SAFETY_PL

AN

Safety Plan

Page

VARCHAR

(32000)

neededSrvcsExist Safety Plan – Safety

Actions Tab -

needed services exist. Valid

values are either Y or N.

SAFETY_PL

AN

Safety Plan

Page

String/1

neededSrvcsAvailable Safety Plan – Safety

Actions Tab-

Needed

services/providers are

currently available at

level/time required.

Valid Values are either

Y or N.

SAFETY_PL

AN

Safety Plan

Page

String/1

caseNotesList Array of Case Notes for

each participant

N/A

cdType Type of the Note.

Refer below for

reference values.

CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Numeric

cdCategory Category of the Note.

Refer below for

reference

values.

CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Numeric



of 252

Revision 2.0

tsOccured Contact Begin Date CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Timestamp

contactEndDate Contact End Date CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Timestamp

noteText Narrative CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes String

/

30000

cdWrkrActCode Worker Activity Code.

Refer below for reference

values.

CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Numeric

personId Participant Id. CAN_TEXT_

EVENT,

CAN_EVENT

_TYPE,

CAN_PART

Case Notes Numeric

contactInformationList Array of Contact

Information.

N/A

otherContactsList Array of Other Contacts

Information.

N/A

personId Person ID INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

Numeric

contactName Contact Name INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/100

faceToFace Face –To –Face

Contact. Refer below

Reference

Values.

INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/1

reasonNotSeen Reason not Seen. Refer

below Reference Values.

INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Numeric



of 252

Revision 2.0

Contacts tab

contactDate Contact Date/Time INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

Timestamp

otherContactName Contact Name INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/120

affiliation Affiliation INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/30

title Title INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/30

otherContactDate Contact Date/Time INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

Timestamp

provideServices Safety Plan – Safety

Considerations Tab – The

parents/legal custodian is

willing for services to be

provided and will cooperate

with service Providers.

Valid Values are either Y or

N.

INVESTIGAT

ION_CNTC

Maintain Case -

Professional/Fa

mily Support

Network

Contacts tab

String/1

outOfHomePlanList Array of outofHomePlan


N/A

outOfHomePlan Contains out of home plan

related info for each

participant

caseParticipantId Case Participant ID SAFETY_PL

AN_OH

Numeric

status Status. Valid values are

P,O,H R,T. SAFETY_PL

AN_OH

String/1

idImagingMngmnt Image Management ID SAFETY_PL

AN_OH

Numeric



of 252

Revision 2.0

onlyChild Out of Home Plan –

Placement

Considerations Tab - Is

this child an only

child?. Valid values are

either Y or N

SAFETY_PL

AN_OH

String/1

siblingsSeparation Out of Home Plan –

Placement

Considerations Tab -

This

Placement involves

the separation of

siblings?. Valid values

are either Y or N

SAFETY_PL

AN_OH

String/1

childFunction Out of Home Plan –

Placement


Child can

function within a

family setting. Valid

values are either Y or

N

SAFETY_PL

AN_OH

String/1

servedByGroup Out of Home Plan –

Placement


Child can best be served

by a group setting. Valid


N

SAFETY_PL

AN_OH

String/1

meetsSpcCare Out of Home Plan –

Placement


Child meets specialized

care criteria. Valid


N

SAFETY_PL

AN_OH

String/1

americanIndian Out of Home Plan –

Placement


Child is an American

Indian child as defined

by the Indian Child

Welfare Act. Valid

values are either

Y or N

SAFETY_PL

AN_OH

String/1



of 252

Revision 2.0

relativeAvailable Out of Home Plan –

Placement Considerations

Tab - Relative/Non-

Relatives are suitable and

available.

Valid values are either Y

or N

SAFETY_PL

AN_OH

String/1

tribalRepresentative Out of Home Plan –

Placement


Tribal Representative

Notified. Valid values

are either Y or N

SAFETY_PL

AN_OH

String/1

plcmntInvolves Out of Home Plan –

Placement


Placement

Involves ICPC. Valid

values are either Y or N

SAFETY_PL

AN_OH

String/1

dateNotifiedByMail Out of Home Plan –

Placement Considerations

Tab – Date Notified by

Mail

SAFETY_PL

AN_OH

Timestamp

determineActionDesc Out of Home Plan –

Special Requirements Tab

- Describe the action taken

to determine whether the

child meets the

requirements of the Indian

Child Welfare Act

SAFETY_PL

AN_OH

VARCHAR

(32000)

outsidePlacementDesc Out of Home Plan –


- If Placement is not in

close proximity to the

child's home and the child

has been removed from

his/her school district,

explain why the placement

outside the child's

community was

necessary:

SAFETY_PL

AN_OH

VARCHAR

(32000)

indianChldPreferred Out of Home Plan –


- Member

of the Indian child's

extended family - Preferred

SAFETY_PL

AN_OH

String/60



of 252

Revision 2.0

indianChldAvailable Out of Home Plan –Special

Requirements Tab -

Member of the Indian

child's extended family –

Available. Valid


SAFETY_PL

AN_OH

String/1

indianChldSelected Out of Home Plan –


– Member of the Indian

child's

extended family - Selected

SAFETY_PL

AN_OH

String/60

fosterHomeByIndPreferr

ed

Out of Home Plan –

Special Requirements

Tab - Foster Home

licensed, approved or

specified by Indian

Child's

Tribe – Preferred

SAFETY_PL

AN_OH

String/60

fosterHomeByIndAvaila

ble



Tab - Foster Home


specified by Indian

Child's

Tribe - Available.

Valid Values are

either Y or N.

SAFETY_PL

AN_OH

String/1

fosterHomeByIndSelecte

d



Tab - Foster Home


specified by Indian

Child's

Tribe - Selected

SAFETY_PL

AN_OH

String/60

indianFosterHomePrefer

red



Tab - Indian Foster

Home licensed or

approved by non-

Indian authority –

Preferred

SAFETY_PL

AN_OH

String/60

indianFosterHomeAvaila

ble



- Indian Foster Home

licensed or approved by

non-Indian authority –

Available. Valid


SAFETY_PL

AN_OH

String/1



of 252

Revision 2.0

indianFosterHomeSelect

ed



Tab - Indian Foster

Home licensed or

approved by non-

Indian authority -

Selected

SAFETY_PL

AN_OH

String/60

groupHomeByIndPreferr

ed

Out of Home Plan –Special

Requirements Tab -

Group Home approved

or operated by Indian

Tribe/Organization -

Preferred

SAFETY_PL

AN_OH

String/60

groupHomeByIndAvaila

ble


Requirements Tab - Group

Home approved or

operated by Indian

Tribe/Organization

– Available. Valid Values

are either Y or N.

SAFETY_PL

AN_OH

String/1

groupHomeByIndSelect

ed


Requirements Tab - Group

Home approved or

operated by Indian

Tribe/Organization

- Selected

SAFETY_PL

AN_OH

String/60

institutionByIndPreferre

d



Tab - Institution for

children approved or

operated by Indian

Tribe - Preferred

SAFETY_PL

AN_OH

String/60

institutionByIndAvailabl

e





operated by Indian

Tribe – Available.

Valid Values are

either Y or N.

SAFETY_PL

AN_OH

String/1

institutionByIndSelected Out of Home Plan –




operated by Indian

Tribe - Selected

SAFETY_PL

AN_OH

String/60



of 252

Revision 2.0

OtherPreferred Out of Home Plan –Special

Requirements Tab -

Other – Preferred

SAFETY_PL

AN_OH

String/60

OtherAvailable Out of Home Plan –


Tab - Other – Available.

Valid Values are

either Y or N.

SAFETY_PL

AN_OH

String/1

OtherSelected Out of Home Plan –


Tab - Other –

Selected

SAFETY_PL

AN_OH

String/60

needSpecialSkills Out of Home

Plan –

Placement

Safety Tab - Do the

placement providers need

to acquire any special

skills or knowledge to

meet the needs of the

child and handle the

behaviors of this child in a

safe manner?. Valid

Values

are either Y or N.

SAFETY_PL

AN_OH

String/1

describeDesc Out of Home

Plan –

Placement

Safety Tab - Describe

SAFETY_PL

AN_OH

VARCHAR

(32000)

concernChildsSafety Out of Home

Plan –

Placement

Safety Tab - Do behaviors

of others in the placement

setting present a concern

for the child's safety? .

Valid


SAFETY_PL

AN_OH

String/1

othersAggrBvrs Out of Home

Plan –

Placement

Safety Tab- Aggressive

Behaviors? . Valid

Values are either Y or

N.

SAFETY_PL

AN_OH

String/1



of 252

Revision 2.0

othersSexuallyAbusive Out of Home

Plan –

Placement

Safety Tab - Sexually

Abusive or Re-active

Behaviors?. Valid Values

are

either Y or N.

SAFETY_PL

AN_OH

String/1

othersOtherBehaviors Out of Home

Plan –

Placement

Safety Tab - Other

Behaviors (Mental Health,

Animal Cruelty, Substance

Abuse, Fire Setting, etc.) .

Valid Values are either Y

or N.

SAFETY_PL

AN_OH

String/1

ConcernOthersSafety Out of Home

Plan –

Placement

Safety Tab - Do behaviors

of this child present a

concern for the safety of

others in the placement

setting? . Valid


SAFETY_PL

AN_OH

String/1

childAggrBvrs Out of Home

Plan –

Placement

Safety Tab -

Aggressive Behaviors?

. Valid Values are

either Y or N.

SAFETY_PL

AN_OH

String/1

childSexuallyAbusive Out of Home

Plan –

Placement

Safety Tab - Sexually

Abusive or Re-active

Behaviors?. Valid Values

are either Y or N.

SAFETY_PL

AN_OH

String/1

childOtherBehaviors Out of Home

Plan –

Placement

Safety Tab - Other

Behaviors (Mental Health,

Animal Cruelty, Substance

Abuse, Fire Setting, etc.) .

Valid Values are either Y

or N.

SAFETY_PL

AN_OH

String/1



of 252

Revision 2.0

immediateSftyCncrnsDe

sc

Out of Home

Plan –

Placement


safety concerns that would

pose immediate or serious

harm or threats of harm.

SAFETY_PL

AN_OH

VARCHAR

(32000)

safetyPlanDesc Out of Home

Plan –

Placement


the specific safety

actions to be taken. For

each action include the


the action, when the

action will occur,

duration, frequency, and


monitoring the safety plan.

SAFETY_PL

AN_OH

VARCHAR

(32000)

spcialTraining Out of Home

Plan –

Placement

Safety Tab - Additional or

special training for

placement providers.


Y or N.

SAFETY_PL

AN_OH

String/1

closerSprvision Out of Home

Plan –

Placement

Safety Tab - Closer

supervision of children

by caregivers. Valid


SAFETY_PL

AN_OH

String/1

additionalRules Out of Home

Plan –

Placement

Safety Tab - Additional

house rules. Valid Values

are either Y or N.

SAFETY_PL

AN_OH

String/1

additionalContact Out of Home

Plan –

Placement

Safety Tab - Additional

contact by agency or

other providers. Valid


SAFETY_PL

AN_OH

String/1



of 252

Revision 2.0

installSpclEqpmnt Out of Home

Plan –

Placement

Safety Tab - Install special

equipment (ramp, door

alarm, etc.). Valid Values

are either Y or N.

SAFETY_PL

AN_OH

String/1

livingArrangements Out of Home

Plan –

Placement

Safety Tab - Rearrange

living arrangements.


Y or N.

SAFETY_PL

AN_OH

String/1

Reference values for cdCategory and cdType.

cdCategory Description cdType Description

59 Mobile Device 1 Type of Visit

2 Who Present at Visit

3 Permanency Plan and Case Plan

4 Observation of the child

5 Educational

6 Child age 13+ in OOH Care

7 Review of Visitation Plan for OOH Care

8 Cultural or religious concerns or needs

9 Child's comments and questions

10 Provider/Caregiver's comments and questions

1 Case 1 Home Visit - Child's Current Residence

2 Home Visit - Parent/CG Removed From

8 Field Visit - School/Daycare

9 Field Visit - Other

13 Visitation - Sibling

14 Visitation - Parent/CG Removed From

15 Visitation - Other Parent

16 Visitation - Relative

17 Visitation - Other

52 Home Visit - Other Parent

Reference values for cdWrkrActCode.

cdWrkrActCode Group Id Description

1 WRKACODE Eligibility Determination

2 WRKACODE Medicaid Administration

3 WRKACODE Case Management

4 WRKACODE Foster Care Placement



of 252

Revision 2.0

5 WRKACODE Targeted Case Management

6 WRKACODE Staff Development Training

7 WRKACODE Recruitment Licensing

8 WRKACODE Transportation Foster Care/Group

9 WRKACODE Transportation - Other

10 WRKACODE In Home Services

11 WRKACODE Intensive In-Home Intervention

12 WRKACODE Intensive Therapeutic Interventions

13 WRKACODE TANF Relative Caregiver Activities

14 WRKACODE Adoption Placement

15 WRKACODE Admin

Reference values for faceToFace.

faceToFace Group Id Description

C FTOFCNTC Completed

A FTOFCNTC Attempted

N FTOFCNTC Not Attempted

Reference values for reasonNotSeen.

reasonNotSeen Group Id Description

1 RSNSEEN Absconded/Abducted

2 RSNSEEN Access Not Allowed

3 RSNSEEN Avoiding/Refusing Contact

4 RSNSEEN Deceased

5 RSNSEEN Family Moved

6 RSNSEEN Family Traveling

7 RSNSEEN Hospitalized

8 RSNSEEN Jailed

9 RSNSEEN Judge Issued a No Contact Order

10 RSNSEEN Long Term Licensed Custody

11 RSNSEEN Not at Home

12 RSNSEEN Not at School

13 RSNSEEN Out of Town/State

14 RSNSEEN Runaway

15 RSNSEEN Situation Resolved (special conditions

only)

16 RSNSEEN Unable to Locate

Reference values for deviceType


2033 RDCDTYPE Blackberry

2034 RDCDTYPE Laptop

Reference values for gpseviceType



of 252

Revision 2.0

GPSTYPE Group Id Description

2035 GPSTYPE Satellite Type

2036 GPSTYPE BB GPS

2040 GPSTYPE Verizon AGPS

Reference values for workType


2037 RDCWTYPE Case Management

2038 RDCWTYPE CPI

2039 RDCWTYPE CLS



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>saveCaseDataXml</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<rDCsaveXMLInput>



<formData>Testing SavecaseDataXml web service</formData>


<latitude>12</latitude>

<longitude>34</longitude>

<altitude>45</altitude>


<gpseviceType>2035</gpseviceType>

<gpsAccuracy>test</gpsAccuracy>


<caseNotesList>

<caseNote>


<cdWrkrActCode>2</cdWrkrActCode>



of 252

Revision 2.0

<cdType>2</cdType>

<cdCategory>59</cdCategory>

<tsOccured>2009-06-17T00:00:00-04:00</tsOccured>

<contactEndDate>2009-06-17T00:00:00-04:00</contactEndDate>

<noteText>Testing..............</noteText>

<contactInformationList>

<contactInformation>


<contactName>Jakson</contactName>

<faceToFace>C</faceToFace>

<reasonNotSeen>3</reasonNotSeen>

<contactDate>2009-06-17T00:00:00-04:00</contactDate>

</contactInformation>



<contactName>Stacy</contactName>


<reasonNotSeen>4</reasonNotSeen>



</contactInformationList>

</caseNote>

</caseNotesList>

<safetyPlan>

<effDate>2009-06-17T00:00:00-04:00</effDate>

<status>P</status>

<homeEnvironment>Y</homeEnvironment>

<affectingSafety>Y</affectingSafety>

<residesInHome>Y</residesInHome>

<provideServices>Y</provideServices>

<safetyFactorDesc>Y</safetyFactorDesc>

<safetyActionsTaken>Y</safetyActionsTaken>

<safetyConcernsDesc>Y</safetyConcernsDesc>

<idImagingMngmnt>10120</idImagingMngmnt>

<neededSrvcsExist>Y</neededSrvcsExist>

<neededSrvcsAvailable>Y</neededSrvcsAvailable>

</safetyPlan>

<outOfHomePlanList>

<outOfHomePlan>


<firstName>Jakson</firstName>

<lastName>Stacy</lastName>

<status>P</status>

<effDate>20 09-06-17T00:00:00-04:00</effDate>

<onlyChild>Y</onlyChild>

<siblingsSeparation>Y</siblingsSeparation>

<childFunction>Y</childFunction>

<servedByGroup>Y</servedByGroup>

<meetsSpcCare>Y</meetsSpcCare>



of 252

Revision 2.0

<americanIndian>N</americanIndian>

<relativeAvailable>N</relativeAvailable>

<tribalRepresentative>N</tribalRepresentative>

<plcmntInvolves>Y</plcmntInvolves>

<dateNotifiedByMail>2009-06-17T00:00:00-04:00</dateNotifiedByMail>

<determineActionDesc>N</determineActionDesc>

<outsidePlacementDesc>Y</outsidePlacementDesc>

<indianChldPreferred>N</indianChldPreferred>

<indianChldAvailable>N</indianChldAvailable>

<indianChldSelected>Y</indianChldSelected>

<fosterHomeByIndPreferred>Y</fosterHomeByIndPreferred>

<fosterHomeByIndAvailable>N</fosterHomeByIndAvailable>

<fosterHomeByIndSelected>N</fosterHomeByIndSelected>

<indianFosterHomePreferred>N</indianFosterHomePreferred>

<indianFosterHomeAvailable>Y</indianFosterHomeAvailable>

<indianFosterHomeSelected>Y</indianFosterHomeSelected>

<groupHomeByIndPreferred>N</groupHomeByIndPreferred>

<groupHomeByIndAvailable>Y</groupHomeByIndAvailable>

<groupHomeByIndSelected>N</groupHomeByIndSelected>

<institutionByIndPreferred>N</institutionByIndPreferred>

<institutionByIndAvailable>Y</institutionByIndAvailable>

<institutionByIndSelected>N</institutionByIndSelected>

<OtherPreferred>N</OtherPreferred>

<OtherAvailable>Y</OtherAvailable>

<OtherSelected>Y</OtherSelected>

<needSpecialSkills>N</needSpecialSkills>

<describeDesc>N</describeDesc>

<concernChildsSafety>N</concernChildsSafety>

<othersAggrBvrs>Y</othersAggrBvrs>

<othersSexuallyAbusive>N</othersSexuallyAbusive>

<othersOtherBehaviors>Y</othersOtherBehaviors>

<ConcernOthersSafety>Y</ConcernOthersSafety>

<childAggrBvrs>N</childAggrBvrs>

<childSexuallyAbusive>Y</childSexuallyAbusive>

<childOtherBehaviors>Y</childOtherBehaviors>

<immediateSftyCncrnsDesc>Y</immediateSftyCncrnsDesc>

<safetyPlanDesc>Y</safetyPlanDesc>

<spcialTraining>N</spcialTraining>

<closerSprvision>Y</closerSprvision>

<additionalRules>N</additionalRules>

<additionalContact>Y</additionalContact>

<installSpclEqpmnt>N</installSpclEqpmnt>

<idImagingMngmnt>102 50</idImagingMngmnt>

<livingArrangements>Y</livingArrangements>

</outOfHomePlan>

</outOfHomePlanList>

</rDCsaveXMLInput>

]]>



of 252

Revision 2.0

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="rDCsaveXMLOutput" type="RDCsaveXMLOutput"/>

<xsd:complexType name="RDCsaveXMLOutput">

<xsd:sequence>

<xsd:element name="rDCXMLId" type="xsd:decimal"/>

<xsd:element name="safetyPlan" type="Safetyplan"/>

<xsd:element name="outofHomePlanList" type="OutofHomePlanList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="Safetyplan">

<xsd:sequence>

<xsd:element name="status" type="xsd:string"/>


</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="OutofHomePlanList">

<xsd:sequence>

<xsd:element name="outofHomePlan" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="status" type="xsd:string"/>

<xsd:element name="outofHomePlanId" type="xsd:decimal"/>

<xsd:element name="caseParticipantId" type="xsd:decimal"/>

<xsd:element name="caseParticipantFirstName" type="xsd:string" />

<xsd:element name="caseParticipantLastName" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

rDCsaveXMLOutput The form class that

holds the output

status of the web

N/A N/A



of 252

Revision 2.0

method

rDCXMLId Key to identify where

rDCXMLId is saved

RDC_EVENTS,

RDC_XML_RE

POSITORY

N/A Numeric

safetyPlan Safety Plan

Information.

N/A N/A

status Status of the Safety

Plan

SAFETY_PLA

N

Safety Plan String

safetyPlanId Unique identifier

associated with

the safety plan

record

saved

SAFETY_PLA

N

Safety Plan Numeric

outOfHomePlanList Array of

outOfHomePlan

objects.

outOfHomePlan Contains a single

outOfHomePlan

collection of values

status Status of out of home

plan

SAFETY_PLA

N_OH

Out of Home

Plan

String

outofHomePlanId Unique identifier

associated with the

out

of home plan record

SAFETY_PLA

N_OH

Out of

Home Plan Numeric

caseParticipantId The participant Id for

whom the out of home

plan is created

SAFETY_PLA

N_OH

Person

Management

Numeric

caseParticipantFirstNam

e

First name associated

with the participant

for whom the out of

home

plan is created

SAFETY_PLA

N_OH

Person

Managemen

t

String

caseParticipantLastName Last name associated

with the participant

for whom the out of

home

plan is created

SAFETY_PLA

N_OH

Person

Managemen

t

String

2.10.7. XML Example output <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">

<env:Header/>

<env:Body>





of 252

Revision 2.0

<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">saveCaseDataXml</java:methodName>





<rDCsaveXMLOutput>

<rDCXMLId>990000011</rDCXMLId>

<safetyPlan>

<status>P</status>

<safetyPlanId>990000011</safetyPlanId>

</safetyPlan>

<outofHomePlanList>

<outofHomePlan>

<status>P</status>

<outofHomePlanId>990000011</outofHomePlanId>


</outofHomePlan>

</outofHomePlanList>

</rDCsaveXMLOutput>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.10.8. Error Guide


1001 Case Id is required.


1003 cdType is required.

1004 tsOccured is required.

1005 noteText is required.

1006 Timestamp Created is a required field.




1010 cdType should be in between 1 to 10.

1011 provideServices can be either Y or N

1012 homeEnvironment can be either Y or N.

1013 affectingSafety can be either Y or N.



of 252

Revision 2.0

1014 residesInHome can be either Y or N.

1015 safetyFactorDesc is a required field.

1016 safetyActionsTaken is a required field.

1017 safetyConcernsDesc is a required field.

1018 neededSrvcsExist can be either Y or N.

1019 neededSrvcsAvailable can be either Y or N.

1020 onlyChild can be either Y or N.

1021 siblingsSeparation can be either Y or N.

1022 childFunction can be either Y or N.

1023 meetsSpcCare can be either Y or N.

1024 meetsSpcCare can be either Y or N.

1025 plcmntInvolves can be either Y or N.

1026 servedByGroup can be either Y or N.

1027 americanIndian can be either Y or N.

1029 tribalRepresentative can be either Y or N.

1030 indianChldAvailable can be either Y or N.

1031 fosterHomeByIndAvailable can be either Y or

N.

1032 indianFosterHomeAvailable can be either Y or

N.

1033 groupHomeByIndAvailable can be either Y or

N.

1034 institutionByIndAvailable can be either Y or

N.

1035 otherAvailable can be either Y or N.

1036 needSpecialSkills can be either Y or N.

1037 concernChildsSafety can be either Y or N.

1038 othersAggrBvrs can be either Y or N.

1039 othersSexuallyAbusive can be either Y or N.

1040 othersOtherBehaviors can be either Y or N.

1041 concernOthersSafety can be either Y or N.

1042 childAggrBvrs can be either Y or N.

1043 childSexuallyAbusive can be either Y or N.

1044 childOtherBehaviors can be either Y or N.

1045 spcialTraining can be either Y or N.

1046 closerSprvision can be either Y or N.

1047 additionalRules can be either Y or N.

1048 additionalContact can be either Y or N.

1049 installSpclEqpmnt can be either Y or N.

1050 livingArrangements can be either Y or N.

1051 personId is a required field.

1052 contactName is a required field.

1053 faceToFaceContact is a required field.

1054 reasonNotSeen is a required field.

1055 contactDate is a required field.



of 252

Revision 2.0

1056 WorkerRoleId is Invalid



1058 Contact Begin Date should not be a future

date.

1059 Contact Date cannot be before Contact Begin

Date.

1060 Timestamp Created should not be a future

date.

1061 Contact Date should not be a future date.

1062 cdType should be either 1 (or) 2 (or) 8 (or) 9

(or) 13 (or) 14 (or) 15 (or) 16 (or) 17 (or) 52

when cdCategory is 1

1063 The format of the tsCreated is not correct.


1064 The format of the tsOccured is not correct.


1065 The format of the contactDate is not correct.


1066 RDC Device Type is not a valid value

1067 GPS Device Type is not a valid value

1068 RDC Work Type is not a valid value



2.10.10. XML Processing Case Notes and XML gets saved in FSFN only after the input data goes through all the validation checks

for both required fields and valid values.


ORG_WORKER_ROLE X

ASSIGNMENT X

GPS_COORD X

RDC_EVENTS X

RDC_XML_REPOSITORY X

CAN_PART X

CAN_TEXT_EVENT X

CAN_TEXT X

CAN_EVENT_TYPE X

APPROVAL X


SAFETY_PLAN X



of 252

Revision 2.0

2.11. Web Service: getCaseDataXmlList 2.11.1. Functional Description

This web service retrieves a list of XMLs saved for a case using 'saveCaseDataXML' web service.

The actual XMLs are not returned, just the identifying information.


<xsd:element name="rDCgetXMLListInput" type="RDCgetXMLListInput"/>

<xsd:complexType name="RDCgetXMLListInput">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


XML Tag

Name

Descripti

on

FSFN Database Mapping


Data Type

rDCgetXMLListInput

The form class

that holds the

input elements

to be passed to

invoke the

getCaseDataX

ml

web method

N/A N/A

caseId The caseId

element holds

the unique Id to

retrieve the xml

list.

RDC_XML_REPOSI

TORY.ID_CASE

Maintain Case page –

header Numeri

c

workerRoleId Worker ID for

the workers role

unique to the

worker. No

effect on output.

ORG_WORKER_ROLE.

ID_WORKER_ROLE

N/A Numeri

c



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCaseDataXmlList</jav:methodName>



of 252

Revision 2.0

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<rDCgetXMLListInput>



</rDCgetXMLListInput>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="rDCgetXMLListOutputForm" type="RDCgetXMLListOutputForm"/>

<xsd:complexType name="RDCgetXMLListOutputForm">

<xsd:sequence>

<xsd:element name="rDCgetXMLList" type="RDCgetXMLList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="RDCgetXMLList">

<xsd:sequence>

<xsd:element name="rDCgetXML" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>






</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0

2.11.6. Output Variables XML Tag Name Description FSFN Database

Mapping FSFN Frontend Mapping

Data Type/ Length

rDCgetXMLListOutputForm

The form class that

holds the output

elements to be


saveCaseNote web

method

N/A N/A

rDCgetXMLList Array of

rDCGetXML

objects

N/A N/A

rDCgetXML Object containing a

single RDC XML

output.

N/A

workerRoleId Worker ID for the

workers role unique to

the worker. No effect

on output.

ORG_WORKER_RO

LE.ID_WORKER_R

OLE


workerFirstName Worker First Name ORG_WORKER

_ROLE Maintain Worker String/40

workerLastName Worker Last Name ORG_WORKER

_ROLE Maintain Worker String / 40

rDCXMLId XML Id RDC_XML_RE

POSITORY N/A Numeric

tsCreated Created Date and

time

RDC_XML_RE

POSITORY N/A String/10


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDataXmlList</java:methodName>





<rDCgetXMLListOutput>

<rDCgetXMLList>

<rDCgetXML>




of 252

Revision 2.0




<tsCreated>2009-06-17T00:00:00.000-04:00</tsCreated>

</rDCgetXML>

</rDCgetXMLList>

</rDCgetXMLListOutput>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


1401 rDCXMLId is a required field

1402 Worker role Id is required








2.11.11. CRUD Matrix



ORG_WORKER_ROLE X

2.12. Web Service: getCaseDataXml 2.12.1. Functional Description

This method provides the Mobile Data Capture Solution with the blob sent to FSFN via the web

service SaveCaseDataXML. This allows the user to retrieve the blob and view the information later

from the Mobile Data Capture Solution.



of 252

Revision 2.0


<xsd:element name="rDCgetXMLInput" type="RDCgetXMLInput"/>

<xsd:complexType name="RDCgetXMLInput">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database Mapping


Data Type

rDCgetXMLInput The form class that holds the


invoke the getCaseDataXml

web method. Holds all

following values.

RDC_X

ML_RE

POSIT

ORY

form

rDCXMLId The rDCXMLId element

holds the unique Id to

retrieve the xml blob that

was sent in

the saveCaseDataXml web

service.

RDC_X

ML_RE

POSIT

ORY

Integer

workerRoleId Worker ID for the workers role

unique to the worker. No effect

on output.

RDC_X

ML_RE

POSIT

ORY

Integer

RDCgetXMLOutput The form class that holds the

output data.

RDC_X

ML_RE

POSIT

ORY

form




of 252

Revision 2.0

Full sample input of a request POST to the webservice. Key changes to the standard request have been

highlighted.

2.12.5. Output Schema Note: The actual output is not fully explained by the schema, which fits everything into a generic string

object. The actual output is accurately represented by the structure used in the saveCaseDataXML

webservice. See section 2.10.2 Input Schema.


<xsd:element name="rDCgetXMLOutput" type="RDCgetXMLOutput"/>



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCaseDataXml</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<rDCgetXMLInput>



</rDCgetXMLInput>

]]>

</jav:inputXML>

<jav:outputXML>

<![CDATA[

<RDCgetXMLOutput/>

]]>

</jav:outputXML>


</mob:p_form>


</jav:Body>

</jav:Envelope>



of 252

Revision 2.0

<xsd:complexType name="RDCgetXMLOutput">

<xsd:sequence>

<xsd:element name="xmlData" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Note: the actual output is not fully explained by the schema, which fits everything into a generic string

object. The actual output is accurately represented by the structure used in the saveCaseDataXML

webservice. See section 2.10.3 Input Variables.



<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCaseDataXml</java:methodName>





<rDCgetXMLOutput>

<xmlData><?xml version="1.0" encoding="UTF-

8" standalone="yes"?>

<rDCsaveXMLInput>




<caseNotesList>

<caseNote>

<cdType>1</cdType>

<cdCategory>1</cdCategory>

<tsOccured>2017-11-29T19:04:35-05:00</tsOccured>

<noteText>

Sample narrative. Sample narrative.




</noteText>


<contactEndDate>2017-11-29T20:41:00-05:00</contactEndDate>

<cdWrkrActCode>3</cdWrkrActCode>

<contactInformationList>



<contactName>Sampleman, Jimbo</contactName>




of 252

Revision 2.0

2.12.8. Error Guide If something is wrong with the input, the Mobile webservice will return an error code and error text

(highlighted in the example).


1101 rDCXMLId is a required field

1102 Worker role Id is required











ORG_WORKER_ROLE X

PERSON

2.13. Web Service: saveMobileCaseDocument



</contactInformationList>

</caseNote>

</caseNotesList>

</rDCsaveXMLInput>

</xmlData>

</rDCgetXMLOutput>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>



of 252

Revision 2.0

2.13.1. Functional Description

This web service saves the case document (PDF, DOC) for the case Id and the document

stream passed in the input XML to the database. The documents which are created in the

field, and uploaded into FSFN, are displayed on the FSFN Desktop within the File Cabinet

icon, and display the imaging category

“Mobile Document.” The imaging category will allow the user to distinguish those

documents which have been uploaded from the Remote Data Capture Solution.


<xsd:element name="saveMobileCaseDocumentInputForm"

type="saveMobileCaseDocumentInputForm"/>

<xsd:complexType name="saveMobileCaseDocumentInputForm">

<xsd:sequence>





<xsd:element name="imageType" type="xsd:decimal"/>


<xsd:element name="comments" type="xsd:string"/>


<xsd:element name="outOfHomePlanId" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveMobileCaseDocu

mentInputForm

The form class that holds the


invoke the SaveMobileCas

eDocument web method

N/A N/A N/A

fileName The filename element holds

the filename information of

the document to

be saved.

IMAGING_MGM

T.TX_FILE_NAM

E

N/A String / 100



of 252

Revision 2.0

imageType The imageType element holds

the type of work information

of the document to be saved

(77 – TANF

Funds/Eligibility

Determination 78 – Out of

Home Plan

79 – Safety Plan 80 – Family

Visitation Plan 81 –

Verification of ICWAE

82 – Child Visitation Case

Note

)

IMAGING_MGM

T.CD_IMG_TYPE


caseId The caseId element holds the

case Id information of the

document to

be saved.

CASE_MASTER.I

D_CASE

Maintain Case

page – header Numeric

comments The comments element holds

the comments that are entered

for the document to be

saved.

Y Imaging page String / 500

personId The personId element holds

Person Id. PERSON.ID_PRS

N

Person

Management Numeric

documentStream The documentStream holds

the stream of the file that

needs to be saved to the

database.

This should be in Hex

format.

IMAGING.BL_I

MAGE (UDB)

N/A String



of 252

Revision 2.0


unique to the worker. Must be a

worker role that exists.

ORG_WORKER_

ROLE.ID_WORK

ER_ROLE

N/A Numeric

safetyPlanId Safety Plan Id SAFETY_PLAN_

OH

N/A Numeric

outOfHomePlanId Out of home Plan Id SAFETY_PLAN_

OH

N/A Numeric



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>saveMobileCaseDocument</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveMobileCaseDocumentInputForm>

<fileName>NaveenTest</fileName>


<imageType>78</imageType>

<comments>Naveen is Testing</comments>


<documentStream>****This will be the hex data of the document

sent****</documentStream>


<safetyPlanId></safetyPlanId>

<outOfHomePlanId>9500166</outOfHomePlanId>

</saveMobileCaseDocumentInputForm>

]]>



of 252

Revision 2.0

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="saveMobileCaseDocumentOutputForm"

type="saveMobileCaseDocumentOutputForm"/>

<xsd:complexType name="saveMobileCaseDocumentOutputForm">

<xsd:sequence>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>



FSFN

Fronte

nd

Mapping

Data Type/

Length

saveMobileCaseDocumentOutputForm The form class that

holds the status of

the

web method

N/A N/A N/A

documentId The

DocumentTextId


of the document text

and is part of the

primary key for

identifying a

document that is

retrieved for the case

Id

IMAGING.

ID_IMAGIN

G_MGMT

N/A Numeric


<env:Header/>

<env:Body>



<java:methodName



of 252

Revision 2.0

xmlns:java="java:com.ams.sacwis.mobile.services">saveMobileCaseDocument</java:methodName>





<saveMobileCaseDocumentOutputForm>


</saveMobileCaseDocumentOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.13.8. Error Guide



802 File Name is a required field

803 Image Type is a required field

804 Document Stream is a required field

805 Comments is a required field

806 Image Type should be either 77,78,79,80,81,82


808 IOException message





assignment to the case to upload the document.




For SaveCaseDocument (Clients using the .NET framework):

2. Clients are not required to encode the image in the .NET code and they are not required to

be aware of the decoding part on the server side. The only information they need to know



of 252

Revision 2.0

is to send the photo via the XML in the form of Hexadecimal and we will decode it on our

end and convert it into blob and save it in our database.

For SaveCaseDocument (Clients using the Java framework):

1. Clients are required to encode the image to Hexadecimal in java and they are not required

to be aware of the decoding part on the server side. Once the image is received on our

end we will decode it, convert it into blob and save it in our database.

Document gets saved in FSFN only after the input data goes through all the validation

checks for both required fields and valid values.



ORG_WORKER_ROLE X

IMAGING_MGMT X X

IMAGING X

IMAGING_PART X

SAFETY_PLAN X



of 252

Revision 2.0

2.14. Web Service: getMobileCaseDocumentList 2.14.1. Functional Description

This webservice retrieves the list of documents that were saved using

'saveMobileCaseDocument' web service for a specified case.

2.14.2. Input Schema XML Tag Name Description FSFN

Database

Mapping

FSFN

Frontend

Mapping

Data

Type

mobileCaseDocumentListInp

utForm



invoke the getMobileCaseDocu

mentList web

method

N/A N/A N/A

caseId The caseId element holds the Id

of the case whose documents

needs to

be fetched

CASE_MAST

ER.ID_CASE

Maintain Case

page – header Numeric


unique to the worker. No effect on

output.

N/A N/A Numeric

2.14.3. Input Variables <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:element name="mobileCaseDocumentListInputForm"

type="MobileCaseDocumentListInputForm"/>

<xsd:complexType name="MobileCaseDocumentListInputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getMobileCaseDocumentList</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<mobileCaseDocumentListInputForm>


<imageType>78</imageType>


</mobileCaseDocumentListInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>

2.14.5. Output Schema


<xsd:element name="mobileCaseDocumentListOutputForm"

type="MobileCaseDocumentListOutputForm"/>

<xsd:complexType name="MobileCaseDocumentListOutputForm">

<xsd:sequence>

<xsd:element name="mobileCaseDocument" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>









of 252

Revision 2.0

<xsd:element name="documentName" type="xsd:string"/>

<xsd:element name="mobileDocumentId" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getMobileCaseDocumentList</java:methodName

>





<mobileCaseDocumentListOutputForm>

<mobileCaseDocument>





<documentName>Out of Home Plan</documentName>

<mobileDocumentId>990000033</mobileDocumentId>

</mobileCaseDocument>

</mobileCaseDocumentListOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>



of 252

Revision 2.0



Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

mobileCaseDocumentList

OutputForm


the array of

returned documents for

the input case Id

N/A N/A N/A

mobileCaseDocument The form class that holds

the DocumentId and

worker id.

N N/A N/A

mobileDocumentId This element holds the

document Id of the

document, pass this id to

'getMobileDocument'

web service to get the

content of the actual

document.

IMAGING_

MGMT.ID_

IMAGING_

MGMT

N/A Numeric

personId The participantId

element holds the Id of

the case participant for

which the

document is created (if

available).

PERSON Case

Information

Page

Numeric

personFirstName The personFirstName

element holds the name

of the case participant

for which the

document is created (if

available).

PERSON Case

Information

Page

String/40

personLastName The personLastName

element holds the name of

the case participant for

which the document is

created (if available).

PERSON Case

Information

Page

String/40

workerRoleId Worker ID for the workers

role unique to the worker.

No effect on output.

N/A Case Numeric

workerFirstName First name of the worker

who created the document

ORG_WOR

KER_ROLE

Case

Information

String/40



of 252

Revision 2.0

Page

workerLastName Last name of the worker

who created the document

ORG_WOR

KER_ROLE

Case String/40

documentName Document Name. IMAGING_

MGMT

N/A String/40

2.14.8. Error Guide







The output XML sent will be sorted by document name.






IMAGING_MGMT X

IMAGING_PART X

ORG_WORKER_ROLE X

PERSON X

2.15. Web Service: getMobileCaseDocument 2.15.1. Functional Description

This webservice returns the specified document, in soft copy, from the FSFN document

repository, based on the document selected from the getMobileDocument list. .


<xsd:element name="mobileCaseDocumentInputForm" type="MobileCaseDocumentInputForm"/>

<xsd:complexType name="MobileCaseDocumentInputForm">

<xsd:sequence>

<xsd:element name="mobileDocumentId" type="xsd:decimal"/>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0




Data Type

mobileCaseDocumentI

nputForm



invoke the

getMobileCaseDocument web

method

N/A N/A N/A

mobileDocumentId The documentId element holds

the Id of the document to be

fetched

IMAGING_MGMT

.ID_IMAGING_M

GMT

N/A Numeric

workerRoleId Worker Role Id. No effect on

output.

N/A N/A Numeric



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getMobileCaseDocument</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<mobileCaseDocumentInputForm>

<mobileDocumentId>990000033</mobileDocumentId>


</mobileCaseDocumentInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>



of 252

Revision 2.0

</jav:Envelope>


<xsd:element name="mobileCaseDocumentOutputForm" type="MobileCaseDocumentOutputForm"/>

<xsd:complexType name="MobileCaseDocumentOutputForm">

<xsd:sequence>



</xsd:sequence>

</xsd:complexType>

</xsd:schema>



Mapping

FSFN

Frontend

Mapping

Data Type/

Length

mobileCaseDocument

OutputForm

The form class that

holds the String of the

document that is

returned for the

input document Id.

N/A N/A N/A

documentStream The documentStream

element holds String

information of the

document in hex format.

IMAGING.BL_IM

AGE (UDB)

N/A BLOB(10485

76)


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getMobileCaseDocument</java:methodName>





<mobileCaseDocumentOutputForm>

<fileName>NaveenTest</fileName>

<documentStream>…hexadecimal representation of document

here…</documentStream>

</mobileCaseDocumentOutputForm>

</java:outputXML>



of 252

Revision 2.0



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.15.8. Error Guide


1301 Document Id is a required field





N/A






IMAGING X

IMAGING_MGMT X

2.16. Web Service: getReferenceData 2.16.1. Functional Description

This webservice retrieves the Reference Data values for the specified Table and Group

Name.


<xsd:element name="referenceDataInputForm" type="ReferenceDataInputForm"/>

<xsd:complexType name="ReferenceDataInputForm">

<xsd:sequence>


<xsd:element name="tableName" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



of 252

Revision 2.0



Mapping

FSFN Frontend

Mapping

Data Type/

Length

referenceDataInput

Form

The form class that

holds the input

elements to be passed

to invoke the

getReferenceData web

method

N/A N/A N/A

groupName Group Name *.ID_GRP of any

reference data table

N/A String/12

tableName Table Name CODE_DECODE,

CODE_DESC_FN

CL,

CODE_DESC_LR

G,CODE_DESC_S

TATIC

N/A String/20



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getReferenceData</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<referenceDataInputForm>

<groupName>CASETYPE</groupName>

<tableName>CODE_DESC</tableName>

</referenceDataInputForm>

]]>

</jav:inputXML>



</mob:p_form>




of 252

Revision 2.0

</jav:Body>

</jav:Envelope>


<xsd:element name="referenceDataOutputForm" type="ReferenceDataOutputForm"/>

<xsd:complexType name="ReferenceDataOutputForm">

<xsd:sequence>

<xsd:element name="referenceData" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="description" type="xsd:string"/>


<xsd:element name="id" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>



Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

referenceDataOutput

Form

The form class that

holds the array of returned

list of values

N/A N/A N/A

referenceData The form class that

holds the GroupId,

Group Name and

GroupDescription

information

N/A N/A N/A

id The GroupId element

holds the group id for

the

particular group

Any column from

the reference data

tables containing

‘GRPI’

N/A Numeric

description The GroupDescription

element holds the

group description for the

particular group

Any column from

the reference data

tables containing

‘TX’

N/A String/60

groupName The GroupName

element holds the

group Name.

Any column from

the reference data

tables containing

‘GRP’

N/A String/8



of 252

Revision 2.0

2.16.7. Example Output Note: output has been truncated for brevity. All structural elements remain.


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getReferenceData</java:methodName>





<referenceDataOutputForm>

<referenceData>

<description>In-Home - Non-Judicial</description>


<id>1</id>

</referenceData>

<referenceData>

<description>In-Home - Court Ordered Supervision</description>


<id>2</id>

</referenceData>

<referenceData>

<description>Out-of-Home - Non-Judicial</description>


<id>3</id>

</referenceData>

<referenceData>

<description>Out-of-Home - Court Ordered</description>


<id>4</id>

</referenceData>

</referenceDataOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>



of 252

Revision 2.0

2.16.8. Error Guide


1601 tableName should be valid name.

1602 groupName is a required field




The output XML sent will be sorted by group Id.






CODE_DESC X

CODE_DECODE X

CODE_DESC_FNCL X

CODE_DESC_LRG X

CODE_DESC_STATIC X

2.17. Web Service: getAssignedCaseListLite 2.17.1. Functional Description

The getAssignedCaseListLite web service will retrieve basic information about all

cases assigned to a worker.


<xsd:element name="assignedCaseListLiteInputForm" type="AssignedCaseListLiteInputForm"/>

<xsd:complexType name="AssignedCaseListLiteInputForm">

<xsd:sequence>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

AssignedCaseListLiteI

nputForm

An array inputs for the

webservice.



of 252

Revision 2.0

loginId Login Id of the worker WORKER.ID_LO

GIN

Maintain

Worker

String/20



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getAssignedCaseListLite</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<assignedCaseListLiteInputForm>


</assignedCaseListLiteInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="assignedCaseListLiteOutputForm"

type="AssignedCaseListLiteOutputForm" />

<xsd:complexType name="AssignedCaseListLiteOutputForm">

<xsd:sequence>

<xsd:element name="assignedCaseList" type="AssignedCaseList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="AssignedCaseList">

<xsd:sequence>

<xsd:element name="AC" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="CID" type="xsd:decimal" />

<xsd:element name="CN" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="WRID" type="xsd:decimal" />

<xsd:element name="LCN" type="xsd:string" />

<xsd:element name="CPS" type="CPS" />

<xsd:element name="DFTMP" type="DFTMPLA" />

<xsd:element name="ASGNL" type="ASGNS" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CPS">

<xsd:sequence>

<xsd:element name="CP" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="CPID" type="xsd:decimal" />

<xsd:element name="CPNM" type="xsd:string" />

<xsd:element name="BD" type="xsd:string" />

<xsd:element name="PG" type="xsd:decimal" />

<xsd:element name="PGT" type="xsd:string" />

<xsd:element name="CG" type="xsd:decimal" />

<xsd:element name="CGT" type="xsd:string" />

<xsd:element name="DTEFF" type="xsd:string" />

<xsd:element name="LCSCD" type="xsd:decimal" />

<xsd:element name="LCUSCD" type="xsd:decimal"

/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ASGNS">

<xsd:sequence>

<xsd:element name="ASGN" minOccurs="1" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="AWRID" type="xsd:decimal" />

<xsd:element name="WRNM" type="xsd:string" />

<xsd:element name="ASGNRO" type="xsd:string" />

<xsd:element name="DTSTRT" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="DFTMPLA">

<xsd:sequence>

<xsd:element name="CNTYID" type="xsd:decimal" />

<xsd:element name="JNM" type="xsd:string" />

<xsd:element name="JID" type="xsd:string" />

<xsd:element name="MNM" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="MID" type="xsd:string" />

<xsd:element name="ATNM" type="xsd:string" />

<xsd:element name="ATID" type="xsd:string" />

<xsd:element name="CRTCASELIST" type="CRTCASENUMS" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CRTCASENUMS">

<xsd:sequence>

<xsd:element name="CRTCASENUM" minOccurs="1"


<xsd:complexType>

<xsd:sequence>

<xsd:element name="NUM" type="xsd:string" />

<xsd:element name="CRTTYP" type="xsd:decimal"

/>

<xsd:element name="TSCR" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

AssignedCaseList An array of AC

AC Array assigned cases

CID Case ID CASE_MASTER.ID

_CASE

Maintain Case Integer

CN Case Name CASE_MASTER String

WRID Person unto whom the case

is assigned

ASSIGNMENT.ID_

PRSN

N/A Integer

LCN The legal name of case CASE_MASTE.

NM_CHLD_LGL_S

RVC_CASE

Maintain Case String

CPS Array of CP

CP Array case participants and

their case plan goals

CPID Case participant ID CASE_PART.ID_P

RSN


CPNM Case participant name PERSON.NM_* Maintain Case String

BD Date of birth PERSON.DT_BRT

H

Person

Management

Timestamp

PG Primary prior goal ID LEGAL_ACTION Case Plan Integer

PGT Primary prior goal narrative LEGAL_ACTION Case Plan String



of 252

Revision 2.0

CG Concurrent prior goal ID LEGAL_ACTION Case Plan Integer

CGT Concurrent prior goal

narrative

LEGAL_ACTION Case Plan String

DTEFF Effective date of goal LEGAL_ACTION Case Plan Timestamp

LCSCD Legal case status LEGAL_ACTION.

CD_LEGAL_CASE

_STAT

Case Plan String

LCUSCD Legal custody status LEGAL_ACTION.

CD_LEGAL_CUST

_STAT

Case Plan String

DFTMPLA Array of legal actions in the

case

CNTYID County Id LEGAL_ACTION.

CD_COUNTY

Legal Action

JNM Judge name JUDICIAL_GROUP

_DETAIL,

JUDICIAL_GROUP

_MAIN

Where

JUDICIAL_GROUP

_DETAIL.ID_JUDI

CIAL_GRP_TYPE

= 2072

Legal Action String

MNM Magistrate Name JUDICIAL_GROUP

_DETAIL,

JUDICIAL_GROUP

_MAIN

Where

JUDICIAL_GROUP

_DETAIL.ID_JUDI

CIAL_GRP_TYPE

= 2073

Legal Action String

MID Magistrate ID LEGAL_ACTION.I

D_MAGISTRATE

Legal Action Integer

ATNM Attorney Name LEGAL_ACTION.

NM_ATTORNY

Legal Action String

ATID Attorney ID LEGAL_ACTION.I

D_DCF_ATTRNY


CRTCASENUMS Array of CRTCASENUM

CRTCASENUM Array of Court Case

Numbers

NUM Court case numbers LEGAL_ACTION.T

X_CASE_NUMBE

R


CRTTYP Case type LA_CASE_NBRS.

CD_COURT

Legal Action

TSCR Time created LEGAL_ACTION.T Legal Action Timestamp



of 252

Revision 2.0

S_CR

ASGNS Array of ASGN

ASGN Array of assigned workers to

the case

AWRID Worker Id of the assignee ASSIGNMENT.ID_

PRSN

Create Worker

Assignment

Integer

WRNM Worker name of the assignee PERSON.NM_* Create Worker

Assignment

String

ASGNRO Worker assignment role ASSIGNMENT.CD

_ASGN_ROLE

Create Worker

Assignment

Integer

DTSTRT Assignment start date ASSIGNMENT.DT

_STRT

Create Worker

Assignment

timestamp


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getAssignedCaseListLite</java:methodName>





<assignedCaseListLiteOutputForm>

<assignedCaseList>

<AC>

<CID>990000011</CID>

<CN>ztest, mother</CN>

<WRID>200005420</WRID>

<LCN></LCN>

<CPS>

<CP>

<CPID>990000031</CPID>

<CPNM>ztest, mother</CPNM>

<BD>1969-01-01 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000032</CPID>

<CPNM>ztest, chilone</CPNM>

<BD>2005-04-04 00:00:00.0</BD>

</CP>

</CPS>

<DFTMP/>

<ASGNL/>

</AC>

<AC>

<CID>990000074</CID>



of 252

Revision 2.0

<CN>Brandt, Jim Jim</CN>

<WRID>200005420</WRID>

<LCN></LCN>

<CPS>

<CP>

<CPID>990000142</CPID>

<CPNM>Brandt, James</CPNM>

<BD>1975-01-01 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000143</CPID>

<CPNM>Brandt, Jim Jim</CPNM>

<BD>2015-01-01 00:00:00.0</BD>

</CP>

</CPS>

<DFTMP/>

<ASGNL/>

</AC>

<AC>

<CID>990000032</CID>

<CN>Investigate, Child</CN>

<WRID>200005420</WRID>

<LCN></LCN>

<CPS>

<CP>

<CPID>990000079</CPID>

<CPNM>Investigate, Child</CPNM>

<BD>2007-09-04 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000080</CPID>

<CPNM>Child, test</CPNM>

<BD>2013-05-05 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000081</CPID>

<CPNM>parent, test</CPNM>

<BD>1978-06-01 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000094</CPID>

<CPNM>Regresssion, Son</CPNM>

<BD>2004-09-09 00:00:00.0</BD>

</CP>

<CP>

<CPID>990000135</CPID>

<CPNM>ReserveBed, Test</CPNM>

<BD>2004-09-09 00:00:00.0</BD>

</CP>

</CPS>

<DFTMP/>



of 252

Revision 2.0

<ASGNL/>

</AC>

</assignedCaseList>

</assignedCaseListLiteOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


1004 SQL Exception occurred

1005 General exception occurred

1006 No cases assigned to this login ID

2.17.9. Sort Sequence Sorted by ID descending for each section.



LEGAL_ACTION X

WORKER X

CASE_PART X

JUDICIAL_GROUP_MAIN X

JUDICIAL_GROUP_DETAIL_ X

2.18. Web Service: updateLegalAction 2.18.1. Functional Description

This webservice is used to update existing scheduled legal actions.

IMPORTANT NOTE: All legal actions created after September 2018 will have a null Case ID. This

webservice will fail with a “1005” error for those legal actions.


<xsd:element name="updLegalActionInputForm" type="UpdateLegalActionInputForm"/>

<xsd:complexType name="UpdateLegalActionInputForm">

<xsd:sequence>

<xsd:element name="CID" type="xsd:decimal"/>

<xsd:element name="CPID" type="xsd:decimal"/>

<xsd:element name="LAID" type="xsd:decimal"/>



of 252

Revision 2.0

<xsd:element name="WRID" type="xsd:decimal"/>

<xsd:element name="TSUP" type="xsd:string"/>

<xsd:element name="SCHDT" type="xsd:date"/>

<xsd:element name="CMPLTDT" type="xsd:date"/>

<xsd:element name="LARST" type="xsd:decimal"/>

<xsd:element name="RQSTBY" type="xsd:decimal"/>

<xsd:element name="RSNFORREQ" type="xsd:decimal"/>

<xsd:element name="ORGSCHDDT" type="xsd:date"/>

<xsd:element name="NEXTSCHDT" type="xsd:date"/>

<xsd:element name="SCTHELDDT" type="xsd:date"/>

<xsd:element name="GRNTD" type="xsd:string" />

<xsd:element name="CNTY" type="xsd:decimal"/>

<xsd:element name="JDGID" type="xsd:decimal"/>

<xsd:element name="MGSID" type="xsd:decimal"/>

<xsd:element name="CLSATRNY" type="xsd:decimal"/>

<xsd:element name="LACSST" type="xsd:decimal"/>

<xsd:element name="LACUSST" type="xsd:decimal"/>

<xsd:element name="ADTNLCOMM" type="xsd:string"/>

<xsd:element name="CLSDRFORD" type="xsd:decimal"/>

<xsd:element name="DTEFF" type="xsd:date"/>

<xsd:element name="POUTCM" type="xsd:decimal"/>

<xsd:element name="PNWGL" type="xsd:decimal"/>

<xsd:element name="COUTCM" type="xsd:decimal"/>

<xsd:element name="CNWGL" type="xsd:decimal"/>


<xsd:element name="DEVTYP" type="xsd:decimal" />

<xsd:element name="WRKTYP" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>


<xsd:sequence>

<xsd:element name="CRTCASENUM" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="IDCSNBR" type="xsd:decimal" />


<xsd:element name="CRTTYP" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length



of 252

Revision 2.0

UpdateLegalActio

nInputForm

An array of inputs for the

webservice.

N/A N/A Form

CID Case ID. Must match with

existing case in which the

update will take place.

LEGAL_ACTION Maintain Case Integer

CPID Case participant person ID.

Must match with existing

participant of case (CID)

LEGAL_ ACTION,

PERSON


LAID Unique Identifier of Legal

Action Table. Must match

with the existing Legal

Record.

LEGAL_ACTION N/A Integer

WRID

Worker role ID who is

updating the record. Must

be an existing worker role

with assignment to the

case.

LEGAL_ACTION N/A Integer/40

TSUP Time of the last update to

the record. Must match the

current TS_UP in

LEGAL_ACTION or it

will return error 10021.

LEGAL_ACTION.T

S_UP

N/A Timestamp

SCHDT Scheduled date LEGAL_ACTION Legal Record >>

Legal Action Timestamp

CMPLTDT Completed date LEGAL_ACTION Legal Record >>


LARST Result LEGAL_ACTION Legal Record >>

Legal Action String

RQSTBY Requested By LEGAL_ACTION Legal Record >>

Legal Action String

RSNFORREQ Reason for Request LEGAL_ACTION Legal Record >>

Legal Action String

ORGSCHDDT Original Scheduled Date LEGAL_ACTION Legal Record >>


NEXTSCHDT Next Scheduled Date LEGAL_ACTION Legal Record >>


SCTHELDDT Actual Held Date LEGAL_ACTION Legal Record >>


GRNTD Granted LEGAL_ACTION Legal Record >>

Legal Action Integer/1

CNTY County LEGAL_ACTION Legal Record >>


JDGID Judge LEGAL_ACTION Legal Record >>

Legal Action String

MGSID Magistrate LEGAL_ACTION Legal Record >>

Legal Action String



of 252

Revision 2.0

CLSATRNY CLS Attorney LEGAL_ACTION Legal Record >>

Legal Action String

LACSST Legal Case Status LEGAL_ACTION Legal Record >>


LACUSST Legal Custody Status LEGAL_ACTION Legal Record >>


ADTNLCOM Additional Comment LEGAL_ACTION Legal Record >>

Legal Action String

CLSDRFORD CLS Draft Order Required LEGAL_ACTION Legal Record >>

Legal Action String/1

DTEFF Effective Date LEGAL_ACTION Legal Record >>


POUTCM Outcome (primary) LEGAL_ACTION Legal Record >>


PNWGL New Goal (primary) LEGAL_ACTION Legal Record >>


COUTCM Outcome (Concurrent) LEGAL_ACTION Legal Record >>


CNWGL New Goal (Concurrent) LEGAL_ACTION Legal Record >>


DEVTYP

Device Type LEGAL_ACTION Legal Record >>


CRTCASENUMS An array of

CRTCASENUM

LA_CASE_NBRS Legal Record >>

Legal Action

CRTCASENUM An array of court case

numbers and types

LA_CASE_NBRS Legal Record >>

Legal Action

IDCSNBR Unique Identifier of court

case numbers

LEGAL_ACTION Legal Record >>


NUM

Court Case Number LEGAL_ACTION Legal Record >>


CRTTYP

Court Type LEGAL_ACTION Legal Record >>


2.18.4. Example Input Note: the below example input is the bare minimum input required to update the legal record and only

updates the TS_UP on the LEGAL_ACTION table for the specified LAID. To update any of the other

variables listed in the Input Variables, add them within updLegalActionInputForm in addition to the

necessary input listed below.



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>updateLegalAction</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>




of 252

Revision 2.0


</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<updLegalActionInputForm>

<CID>101952322</CID>

<CPID>107125508</CPID>

<WRID>990000212</WRID>

<LAID>5138594</LAID>

<CNTY>17</CNTY>

<TSUP>2019-09-10 17:29:41.40851</TSUP>

</updLegalActionInputForm>

]]>

</jav:inputXML>

<jav:outputXML>?

</jav:outputXML>


</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="updateLegalActionOutputForm" type="updateLegalActionOutputForm" />

<xsd:complexType name="updateLegalActionOutputForm">

<xsd:sequence>

<xsd:element name="LAID" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

updateLegalActionOut

putForm

An array of output data

for the webservice

N/A N/A N/A

LAID The legal action ID LEGAL_ACTION N/A Integer



of 252

Revision 2.0


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">updateLegalAction</java:methodName>





<updateLegalActionOutputForm>

<LAID>5138594</LAID>

</updateLegalActionOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


1001 Case ID is required.

1002 Person ID is required.

1003 Legal Action ID is not valid.

1004 Legal Action County is required.

1005 Completed Date is required for the result selected

1006 Legal Action Case Status is required for the selected Legal Action Case

Custody Status.

1007 Legal Action Case Custody Status is required for the selected Legal

Action Case Status.

1008 Legal Action Court Case Number is required for the Court selected.

1009 Legal Action Court Type is required for the Court Case Number selected.

10010 Legal Action ID, Case ID and Case Participant ID is not a valid

combination.

10011 Worker's role has been changed in FSFN since case was downloaded.

Legal Action can not be submitted from mobile device.

10012 Worker with this profile doesn't have security to update the legal action

record.

10013 Worker doesn’t have open assignment to the case.

10014 Case ID and Case Participant ID combination is not valid.

10015 The Legal Action Result is invalid and doesn't correspond to the Legal

Action Initiated value.



of 252

Revision 2.0

2.18.9. Sort Sequence N/A



LEGAL_ACTION X X

10016 The combination of county and judge is invalid.

10017 The combination of county and magistrate is invalid.

10018 Judge is Inactive, legal action can't be saved.

10019 Magistrate is Inactive, legal action can't be saved.

10020 When there is no new goal or outcome, effective date should be blank.

10021 Legal action has been updated in FSFN since last download to mobile

device.

10022 The case has been closed in FSFN.

10023 Scheduled Date must be equal to or less than Completed Date.

10024 When result is Continued or Due Date Extended, Requested By is

required.

10025 When result is Continued or Due Date Extended, Reason for Request is

required.

10026 When result is Continued or Due Date Extended, Original Scheduled

Date is required.

10027 When result is Continued or Due Date Extended, Next Scheduled Date is

required.

10028 If Requested By, Reason for Request, Original Scheduled Date or Next

Scheduled Date are not blank, Result should be Continued or Due Date

Extended.

10029 The Effective Date must be greater than the Effective Date <effective

date> of the previously documented Court Approved Permanency Goal.

10030 Effective Date is required when a Primary or Concurrent New Goal is

selected.

10031 Effective Date is required when an Outcome is selected associated with a

Primary or Concurrent New Goal.

10032 Outcome is required when a Primary or Concurrent New Goal is

selected.

10033 Primary or Concurrent New Goal is required when an Outcome is

selected.

10034 When there is no Primary New goal and Outcome or no Concurrent new

goal and Outcome, effective date should be blank.

10035 The Case Participant’s most recent Legal Case Status must either be

blank or ‘No Legal Case Status,’ ‘Jurisdiction Terminated,’ ‘Jurisdiction

of Other State,’ or ‘Voluntary,’ in order to save this Legal Action

Initiated.

10036 'Requested By' is invalid.

10037 'Reason for Request' is invalid.

10038 'Concurrent Outcome' is invalid.

10039 'Concurrent New Goal' is invalid.



of 252

Revision 2.0

ORG_WORKER_ROLE X

LA_CASE_NBRS X X X

DOC_NARRATIVE X X

SCRTY_GRP_PRFL X

RDC_EVENTS X

CASE_MASTER X

JUDICIAL_GROUP_DETAIL X

CASE_PART X

PERSON X

ASSIGNMENT X

2.19. Web Service: saveK12ReportCard 2.19.1. Functional Description

This webservice inserts report card data into OLTP tables EDU_K12_RPT_CARD and

EDU_K12_RPT_CARD_DETAILS. These tables are not read by any part of FSFN or its batch processes

other than this webservice, but can still be accessed by reporting tools.


<xsd:element name="saveK12ReportCardInputForm" type="SaveK12ReportCardInputForm"

/>

<xsd:complexType name="SaveK12ReportCardInputForm">

<xsd:sequence>


<xsd:element name="CPId" type="xsd:decimal" />

<xsd:element name="OWRID" type="xsd:decimal" />

<xsd:element name="TSSRVYDT" type="xsd:date" />

<xsd:element name="CMNTS" type="xsd:string" />

<xsd:element name="dType" type="xsd:decimal" />

<xsd:element name="gpsType" type="xsd:decimal" />

<xsd:element name="gpsAcracy" type="xsd:string" />

<xsd:element name="wType" type="xsd:decimal" />

<xsd:element name="qaLst" type="QALST" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="QALST">

<xsd:sequence>

<xsd:element name="QA" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="QID" type="xsd:decimal" />

<xsd:element name="AID" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>




of 252

Revision 2.0


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

SaveK12ReportCardInputF

orm

Container form for all

input data

N/A N/A N/A

CID Case ID EDU_K12_RPT_C

ARD

N/A Integer

CPId Case participant person

ID

EDU_K12_RPT_C

ARD

N/A Integer

OWRID Worker role ID of the

worker making the insert

ORG_WORKER_

ROLE.ID_WORK

ER_ROLE

N/A Integer

TSSRVYDT Unused element. N/A N/A N/A

CMNTS Comments for the report

card

EDU_K12_RPT_C

ARD

N/A String

dType Device type RDC_EVENTS N/A Integer

gpsType GPS type RDC_EVENTS N/A Integer

gpsAcracy GPS accuracy RDC_EVENTS N/A String

wType Work type RDC_EVENTS N/A String

qaLst Array of QA

QA Array of questions and

answers

QID Question bank ID. Must

be an integer 1 through 11

EDU_RPTCARD_

QSTN_BANK

N/A Integer

AID Question answer bank ID.

Must be an appropriate

answer corresponding to

each question. (possible

answers are integers 1 -

77, but each question has

a corresponding range of

answers.

EDU_RPTCARD_

ANSWR_BANK

N/A Integer

2.19.4. Example Input Note: Each AID is the highest possible integer allowed for each QID.



<jav:Header/>

<jav:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>saveK12ReportCard</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>




of 252

Revision 2.0


</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveK12ReportCardInputForm>

<CID>101952322</CID>

<CPId>107125508</CPId>

<OWRID>990000212</OWRID>

<CMNTS>This is a comment</CMNTS>

<dType>423</dType>

<gpsType>17</gpsType>

<gpsAcracy>23</gpsAcracy>

<wType></wType>

<qaLst>

<QA>

<QID>1</QID>

<AID>7</AID>

</QA>

<QA>

<QID>2</QID>

<AID>14</AID>

</QA>

<QA>

<QID>3</QID>

<AID>21</AID>

</QA>

<QA>

<QID>4</QID>

<AID>28</AID>

</QA>

<QA>

<QID>5</QID>

<AID>35</AID>

</QA>

<QA>

<QID>6</QID>

<AID>42</AID>

</QA>

<QA>

<QID>7</QID>

<AID>49</AID>

</QA>

<QA>

<QID>8</QID>

<AID>56</AID>

</QA>

<QA>

<QID>9</QID>



of 252

Revision 2.0

<AID>63</AID>

</QA>

<QA>

<QID>10</QID>

<AID>70</AID>

</QA>

<QA>

<QID>11</QID>

<AID>77</AID>

</QA>

</qaLst>

</saveK12ReportCardInputForm>

]]>

</jav:inputXML>

<jav:outputXML>?

</jav:outputXML>


</mob:p_form>


</jav:Body>

</jav:Envelope>


<xsd:element name="saveK12ReportCardOutputForm"

type="SaveK12ReportCardOutputForm" />

<xsd:complexType name="SaveK12ReportCardOutputForm">

<xsd:sequence>

<xsd:element name="IDEDURPTCARD" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data

Type/

Length

SaveK12ReportCardOutput

Form


output data

N/A N/A N/A

IDEDURPTCARD ID of created report card

record. Does not function.

Will not return anything,

but the record inserted will

have an ID, regardless.

N/A N/A Integer



of 252

Revision 2.0


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">saveK12ReportCard</java:methodName>





<saveK12ReportCardOutputForm/>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>

2.19.8. Error Guide





906 FSFN Application Exception - Please contact system administrator

(uncaught SQL exception)


(uncaught exception)

1509 Case ID is required

1510 Case Participant ID is required

1504 Case closed in FSFN, Education Report Card can't be inserted.

1505 Invalid worker role ID

1506 Child has been inactivated in FSFN

1512 Device Type is required

915 Worker Role ID passed is not assigned to the case

1518 All Questions must be answered

1516 Invalid Question ID

1517 Invalid Answer ID

1515 Question and answer combination is invalid

1507 Comments are required when any question is rated other than 4 or 5



of 252

Revision 2.0


EDU_K12_RPT_CARD_DETAILS X

EDU_K12_RPT_CARD X

CASE_MASTER X

ORG_WORKER_ROLE X

CASE_PART X

EDU_RPTCARD_QSTN_BANK X

EDU_RPTCARD_ANSWR_BANK X

RDC_EVENTS X

2.20. Web Service: saveNote 2.20.1. Functional Description

The saveNote web service will create an investigation note in FSFN. This webservice will receive the

case, ARID and person Id's for which the note needs to be created. ARID will be required only when note

being created is for a child, adult or special conditions investigation (when category is 3,4 or 5).

If ARID is passed then the category and type will be validated for the combination of category and type

corresponding to child, adult and special conditions investigation. ARID is the unique identifier of an

intake with a sequence. Each sequence of an Intake will be a different ARID. Notes can be created for

Initial and sequences of the Initial Intake. It will also receive the notes text, contact dates, face-to-face

information. When a note is created Contact Information list (CIL) and Other Contact Information list

(OCL) is not required. saveNote webservice will also insert a record into RDC_EVENTS if any of the

following elements are sent in inputXML: Device Type,Service Type, Work Type or GPS accuracy.


<xsd:element name="saveNoteInputForm" type="SaveNoteInputForm" />

<xsd:complexType name="SaveNoteInputForm">

<xsd:sequence>



<xsd:element name="ARID" type="xsd:decimal" />

<xsd:element name="latitude" type="xsd:decimal" />

<xsd:element name="longitude" type="xsd:decimal" />

<xsd:element name="altitude" type="xsd:decimal" />

<xsd:element name="tsCreated" type="xsd:date" />

<xsd:element name="deviceType" type="xsd:decimal" />

<xsd:element name="gpseviceType" type="xsd:decimal" />

<xsd:element name="gpsAccuracy" type="xsd:string" />

<xsd:element name="workType" type="xsd:decimal" />

<xsd:element name="cn" type="CN" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CN">

<xsd:sequence>

<xsd:element name="partl" type="PARTL" />

<xsd:element name="CT" type="xsd:decimal" />

<xsd:element name="CC" type="xsd:decimal" />

<xsd:element name="WAC" type="xsd:decimal" />

<xsd:element name="CBD" type="xsd:dateTime" />



of 252

Revision 2.0

<xsd:element name="CED" type="xsd:dateTime" />

<xsd:element name="CRDT" type="xsd:dateTime" />

<xsd:element name="NT" type="xsd:string" />

<xsd:element name="cil" type="CIL" />

<xsd:element name="ocl" type="OCL" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CIL">

<xsd:sequence>

<xsd:element name="CI" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="PID" type="xsd:decimal" />

<xsd:element name="CNM" type="xsd:string" />

<xsd:element name="FTF" type="xsd:string" />

<xsd:element name="RNS" type="xsd:decimal" />

<xsd:element name="CD" type="xsd:dateTime" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="OCL">

<xsd:sequence>

<xsd:element name="OC" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="OCN" type="xsd:string" />

<xsd:element name="AFF" type="xsd:string" />

<xsd:element name="TT" type="xsd:string" />

<xsd:element name="OCD" type="xsd:dateTime" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="PARTL">

<xsd:sequence>

<xsd:element name="PARTList" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="PartID" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>



of 252

Revision 2.0

</xsd:schema>

2.20.3. Input Variables Note: the input contains several nested forms. Use the schema and example input to understand the nature

of the hierarchy.


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveNoteInputForm Container form for all

input data

N/A N/A N/A

WRID Worker role ID ORG_WORKER_R

OLE

N/A Integer

CID Case ID CASE_MASTER Maintain Case Integer

ARID Access Report (Intake) ID ACCESS_REPORT.

ID_ACCESS_REPO

RT

N/A Integer

latitude GPS coordinate fragment RDC_EVENTS N/A Decimal

longitude GPS coordinate fragment RDC_EVENTS N/A Decimal

altitude GPS coordinate fragment RDC_EVENTS N/A Decimal

tsCreated GPS coordinate timestamp

created

RDC_EVENTS N/A Timestamp

deviceType RDC device type RDC_EVENTS N/A

gpseviceType GPS device type RDC_EVENTS N/A Integer

gpsAccuracy GPS accuracy RDC_EVENTS N/A String

workType ID Worker RDC_EVENTS N/A Integer

CN Container form for case

notes

form

CT Category type CATEGORY_TYPE

.CD_TYPE

N/A Integer

CC The service category the

specific subservice

component is related to

CATEGORY_TYPE

.CD_CATEGORY

N/A Integer

WAC Worker action code CAN_TEXT_EVEN

T

N/A Integer

CBD Contact begin date CAN_TEXT_EVEN

T

Case Note Timestamp

CED Contact end date CAN_TEXT_EVEN

T

Case Note Timestamp

CRDT Note creation date CAN_TEXT_EVEN

T

Case Note Timestamp

NT Note text CAN_TEXT_EVEN

T

Case Note String

CIL Container form array of

Contact Information List

form

PID Person ID INVESTIGATION_ Case Note >> Integer



of 252

Revision 2.0

CNTC Contact

Information

CNM Contact name INVESTIGATION_

CNTC

Case Note >>

Contact

Information

String

FTF Face to Face INVESTIGATION_

CNTC

Case Note >>

Contact

Information

String

RNS Reason not seen INVESTIGATION_

CNTC

Case Note >>

Contact

Information

Integer

CD Contact Date INVESTIGATION_

CNTC

Case Note >>

Contact

Information

Timestamp

OCL Container form array of

OC

form

OC Container form of Other

Contact Information (non-

face-to-face)

form

OCN Other contact name INVESTIGATION_C

NTC

Case Note >>

Non-face-to-

face contact

information

String

AFF Affiliation INVESTIGATION_C

NTC

Case Note >>

Non-face-to-

face contact

information

String

TT Title INVESTIGATION_C

NTC

Case Note >>

Non-face-to-

face contact

information

String

OCD Other contact date INVESTIGATION_C

NTC

Case Note >>

Non-face-to-

face contact

information

Timestamp

PARTL Container form of

PARTList

form

PARTList Array of Case Note

participants

form

PartID Participant IDs CASE_PART,

PERSON

N/A Integer

2.20.4. Example Input <x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"


<x:Header/>

<x:Body>

<mob:mobileService>



of 252

Revision 2.0

<mob:p_form>

<jav:methodName>saveNote</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveNoteInputForm>

<WRID>150001980</WRID>

<CID>100324229</CID>

<ARID>100898118</ARID>

<cn>

<partl>

<PARTList>

<PartID>101289280</PartID>

</PARTList>

<PARTList>

<PartID>12509094</PartID>

</PARTList>

</partl>

<CT>2</CT>

<CC>5</CC>

<WAC>4</WAC>

<CBD>2010-10-10T09:30:00-04:00</CBD>

<CED>2010-10-26T16:28:00-04:00</CED>

<CRDT>2010-10-20T13:10:00-04:00</CRDT>

<NT> Special Condition</NT>

<cil>

<CI>

<PID>101164847</PID>

<CNM>Unknown, FSFN</CNM>

<FTF>A</FTF>

<RNS>5</RNS>

<CD>2010-10-12T14:05:43-04:00/CD>

</CI>

<CI>

<PID>101501321</PID>

<CNM>Florida,FSFN</CNM>

<FTF>A</FTF>

<RNS>1</RNS>

<CD>2010-10-12T14:05:43-04:00</CD>

</CI>

</cil>

<ocl>



of 252

Revision 2.0

<OC>

<OCN>Doug williams</OCN>

<AFF>Neighbour</AFF>

<TT>Next Door</TT>

<OCD>2010-10-12T14:05:43-04:00</OCD>

</OC>

<OC>

<OCN>Peter williams</OCN>

<AFF>Relative</AFF>

<TT>Uncle</TT>

<OCD>2010-10-12T14:05:43-04:00</OCD>

</OC>

</ocl>

</cn>

</saveNoteInputForm>

]]>

</jav:inputXML>

<jav:outputXML>?

</jav:outputXML>


</mob:p_form>


</x:Body>

</x:Envelope>


<xsd:element name="saveNoteOutputForm" type="SaveNoteOutputForm"/>

<xsd:complexType name="SaveNoteOutputForm">

<xsd:sequence>

<xsd:element name="noteID" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveNoteOutputForm Container form of all

output

N/A N/A form

noteID Note ID of the saved

note

CAN_TEXT_EVE

NT

N/A Integer




of 252

Revision 2.0


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">saveNote</java:methodName>





<saveNoteOutputForm>

<noteID>910000723</noteID>

</saveNoteOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>




3003 Category is required.

3004 Note Type is required.

3005 Contact Begin Date is required.

3006 NoteText is required.

3007 Contact End Date is a required field.




3011 Category and Type combination is not valid.

3012 personId is a required field.

3013 contactName is a required field.

3014 faceToFaceContact is a required field.

3015 reasonNotSeen is a required field.

3016 contactDate is a required field.




3019 Contact Begin Date should not be a future date.

3020 Contact End Date can not be before Contact Begin

Date.



of 252

Revision 2.0

3021 ARID and Case ID combination is invalid

3022 ARID is required if category corresponds to an

Investigation.

3033 ARID is invalid

3034 Note Creation Date is a required field.

999 Exception occurred while converting Timestamp.

3035 A Note can't be created for the values passed. Only

commencement notes can be created for Intake

sequences.




CAN_TEXT_EVENT X

CAN_EVENT_TYPE X

CAN_TEXT X

CAN_PART X


ORG_WORKER_ROLE X

CATEGORY_TYPE X

ACCESS_REPORT X

CASE_PART X

PERSON X

RDC_EVENTS X

GPS_COORD X


2.21. Web Service: getScheduledLegalActions 2.21.1. Functional Description

This webservice receives the FSFN Worker Login ID , case ID (optional) and Scheduled Date Range

(optional) in the input XML. The webservice will return all the scheduled legal actions associated with

the worker login ID passed within the scheduled legal action date range. If a case ID is received, only the

legal actions corresponding to that case ID within the scheduled legal action date range are sent. If no

case ID is received all the scheduled legal actions within the specified range corresponding to all the

profiles of that worker will be sent.

If no scheduled dates are sent, the webservice will return all scheduled legal actions for the case ID

received or all scheduled Legal actions corresponding to all the cases that the worker has assignment to.

The webservice will also validate if the case id requested in input XML has an assignment to one of the

profiles of the user ID passed.


<xsd:element name="getScheduledLegalActionsInputForm"

type="ScheduledLegalActionsInputForm"/>

<xsd:complexType name="ScheduledLegalActionsInputForm">

<xsd:sequence>



of 252

Revision 2.0

<xsd:element name="LGNID" type="xsd:string"/>


<xsd:element name="SCHFRMDT" type="xsd:string"/>

<xsd:element name="SCHTODT" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

ScheduledLegalActio

nsInputForm


input data

N/A N/A N/A

LGNID Login ID of the worker WORKER.ID_LOG

IN

Maintain

Worker

String

CID Case ID CASE_MASTER Maintain Case decimal

SCHFRMDT Scheduled from date LEGAL_ACTION Legal Action String

SCHTODT Scheduled to date LEGAL_ACTION Legal Action String



<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getScheduledLegalActions</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<getScheduledLegalActionsInputForm>

<LGNID>ds65506</LGNID>

<CID>101619779</CID>

</getScheduledLegalActionsInputForm>

]]>

</jav:inputXML>



</mob:p_form>



of 252

Revision 2.0


</x:Body>

</x:Envelope>


<xsd:element name="getScheduledLegalActionsOutputForm"

type="ScheduledLegalActionsOutputForm"/>

<xsd:complexType name="ScheduledLegalActionsOutputForm">

<xsd:sequence>

<xsd:element name="scheduledActionsList" type="ScheduledActionsList"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ScheduledActionsList">

<xsd:sequence>

<xsd:element name="SLA" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>


<xsd:element name="CPL" type="CPS"/>


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CPS">

<xsd:sequence>

<xsd:element name="CP" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="CPID" type="xsd:decimal" />

<xsd:element name="SCHLGLACTNL" type="SCHLGLACTN"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="SCHLGLACTN">

<xsd:sequence>

<xsd:element name="SCHLA" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>


<xsd:element name="TSUP" type="xsd:string" />

<xsd:element name="LSTUPBY" type="xsd:string" />

<xsd:element name="LACTGRY" type="xsd:decimal" />

<xsd:element name="LAINT" type="xsd:decimal" />



of 252

Revision 2.0

<xsd:element name="SCHDT" type="xsd:string" />

<xsd:element name="LARST" type="xsd:decimal"/>

<xsd:element name="LACNTY" type="xsd:decimal"/>

<xsd:element name="MGID" type="xsd:decimal"/>

<xsd:element name="JDGID" type="xsd:decimal"/>

<xsd:element name="ATRYID" type="xsd:decimal"/>

<xsd:element name="ATRYNM" type="xsd:string"/>

<xsd:element name="LCSST" type="xsd:decimal"/>

<xsd:element name="LCUSTST" type="xsd:decimal"/>

<xsd:element name="CLSDRFTODR" type="xsd:string" />

<xsd:element name="DTEFF" type="xsd:string" />

<xsd:element name="PPG" type="xsd:decimal" />

<xsd:element name="POTCM" type="xsd:decimal" />

<xsd:element name="PNG" type="xsd:decimal" />

<xsd:element name="CPG" type="xsd:decimal" />

<xsd:element name="COTCM" type="xsd:decimal" />

<xsd:element name="CNG" type="xsd:decimal" />

<xsd:element name="ADNTCMNTS" type="xsd:string" />


<xsd:element name="CRPEXT" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>


<xsd:sequence>

<xsd:element name="CRTCASENUM" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="IDCSNBR" type="xsd:decimal" />


<xsd:element name="CRTTYP" type="xsd:decimal" />

<xsd:element name="CRTSUP" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN Frontend

Mapping

Data Type/

Length

ScheduledLegalActi

onsOutputForm


output

N/A N/A form

CID Case ID LEGAL_ACTI

ON

Legal Action

Page>General

Information group

Decimal



of 252

Revision 2.0

box on the

header>Case Name

(ID associated with

this Case Name).

Case ID can be

obtained from

Maintain Case page.

CPL List of Case Participants CASE_PART List of CPS

WRID Unique Identifier of a

worker with a particular

role

ORG_WORKE

R_ROLE

Not shown in FSFN Decimal

CPID casePartId CASE_PART Legal Action

Page>General

Information group

box on the

header>Case

Participant Name

(ID associated with

the participant

name). Person ID

can be obtained from

person management

screen.

Decimal

SCHLGLACTNL List of scheduled Legal

Actions

(SCHLGLACTN)

N/A N/A List of

SCHLGLACT

N

LAID Unique Identifier of

Legal Action Table

LEGAL_ACTI

ON

Not shown in FSFN.

(Unique Identifier of

a Legal Action page

in FSFN)

Decimal

TSUP Last Updated

Timestamp

LEGAL_ACTI

ON

Legal Action

Page>General

Information group

box on the

header>Date/Time

Updated

String (yyyy-

MM-dd-

HH.mm.ss.fffff

f)

LSTUPBY Last Updated By Worker LEGAL_ACTI

ON

Legal Action

Page>General

Information group

box on the

header>Last

Updated By

String (Work

Name in Last

Name Sfx, First

Name Middle

Initial format)

LACTGRY Legal Action Category LEGAL_ACTI

ON

Legal Action

Page>General

Information group

box on the header>

Legal Action

Decimal (Code

Group -

LACTGRY)



of 252

Revision 2.0

Category

LAINT Legal Action Initiated LEGAL_ACTI

ON

Legal Action

Page>General

Information group

box on the header>

Legal Action

Initiated

Decimal (Code

Group -

LAINIT)

SCHDT Scheduled Date LEGAL_ACTIO

N Legal Action

Page>General

Information group

box on the

header>Scheduled

Date

String (yyyy-

MM-dd-

HH.mm.ss.fffff

f)

LARST Result LEGAL_ACTIO

N Legal Action

Page>General

Information group

box on the header>

Results

Decimal (Code

Group -

LARESULT)

LACNTY County LEGAL_ACTIO

N Legal Action

Page>General

Information group

box on the

header>County

Decimal (Code

Group -

REGION)

MGID Magistrate LEGAL_ACTIO

N Legal Action

Page>Legal Action

and Status Tab>

Magistrate

Decimal(ID_JU

DICIAL_GRP_

DETAIL in

JUDICIAL_GR

OUP_DETAIL

table)

JDGID Judge LEGAL_ACTIO

N Legal Action

Page>Legal Action

and Status Tab>

Judge

Decimal

(ID_JUDICIAL

_GRP_DETAI

L in

JUDICIAL_GR

OUP_DETAIL

table)

ATRYID CLS Attorney LEGAL_ACTIO

N Legal Action

Page>Legal Action

and Status Tab> Id

associated with CLS

Attorney

Decimal (ID

WORKER

ROLE)

ATRYNM CLS Attorney LEGAL_ACTIO

N Legal Action

Page>Legal Action

and Status Tab>

CLS Attorney

String (Work

Name in Last

Name Sfx, First

Name Middle

Initial format)

LCSST Legal Case Status LEGAL_ACTIO Legal Action Decimal (Code



of 252

Revision 2.0

N Page>Legal Action

and Status

Tab>Legal Case

Status

Group -

LEGLSTAT)

LCUSTST Legal Custody Status LEGAL_ACTIO

N Legal Action

Page>Legal Action

and Status

Tab>Legal Custody

Status

Decimal(Code

Group -

LACUST)

CLSDRFTODR CLS Draft Order

Required

LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>CLS Draft

Order Required

String (Y or N)

DTEFF Effective Date LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking

Tab>Effective Date

Gregorian

Calendar

(2010-12-

29T18:26:41-

00:00)

PPG Primary Prior Goal LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking Tab>

Primary Prior Goal

Decimal (Code

Group -

CASEPLGL)

POTCM Primary Outcome LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking Tab>

Primary Outcome

Decimal (Code

Group -

LAOUTCME)

PNG Primary New Goal LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking Tab>

Primary New Goal

Decimal (Code

Group -

CASEPLGL)

CPG Concurrent Prior Goal LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking Tab>

Concurrent Prior

Goal

Decimal (Code

Group -

CASEPLGL).E

xcept for

Maintain and

Strengthen

(1984) &

Reunification

with parent(s)

(1985).

COTCM Concurrent Outcome LEGAL_ACTIO

N Legal Action

Page>Tracking

Tab>Tracking Tab>

Concurrent

Outcome

Decimal (Code

Group -

LAOUTCME)

CNG Concurrent New Goal LEGAL_ACTIO

N Legal Action

Page>Tracking

Decimal (Code

Group -



of 252

Revision 2.0

Tab>Tracking Tab>

Concurrent New

Goal

CASEPLGL).E

xcept for

Maintain and

Strengthen

(1984) &

Reunification

with parent(s)

(1985).

ADNTCMNTS Additional Comment DOC_NARRA

TIVE

Additional

Comments

(Tracking Tab) is

stored in

DOC_NARRATIVE

table

(CD_WRK_TYPE =

1216, CD_QTYPE =

‘LA’) and

TX_NARR field.

String (32000)

CRTCASELIST A list of court case

numbers

(CRTCASENUMS)

N/A N/A form

CRPEXT Citizen Review Panel

Exists

LEGAL_ACTI

ON

Legal Action

Page>Legal Action

and Status

Tab>Corresponds to

Citizen Review

Panel (Y when

Citizen Review

Panel is selected, N

when Citizen

Review Panel

doesn't exist)

String (Y or N)

IDCSNBR Unique Identifier of

Court Case Number (in

FSFN)

LA_CASE_N

BRS

Legal Record page >

Legal Action Page>

Legal Action and

Status Tab> Court

Case Number> Case

Number(s) Group

Box> Unique

Identifier associated

with each row.

Decimal

NUM General case number

(universal)

LA_CASE_N

BRS

Legal Record page >

Legal Action Page>

Legal Action and

Status Tab> Court

Case Number> Case

Number(s) Group

Box> Number

String (20)



of 252

Revision 2.0

CRTTYP Court type LA_CASE_N

BRS

Legal Record page>

Legal Action Page>

Legal Action and

Status Tab> Court

Case Number>

Case Number(s)

Group Box> Court

drop down

Decimal ( Code

Group -

LACOURT)

TSUP Timestamp Update LA_CASE_N

BRS

Not shown in FSFN String (yyyy-

MM-dd-

HH.mm.ss.fffff

f)


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getScheduledLegalActions</java:methodName>





<getScheduledLegalActionsOutputForm>

<scheduledActionsList>

<SLA>

<CID>101619779</CID>

<CPL>

<CP>

<CPID>3213299</CPID>

<SCHLGLACTNL/>

</CP>

<CP>

<CPID>6142603</CPID>

<SCHLGLACTNL/>

</CP>

<CP>

<CPID>11491058</CPID>

<SCHLGLACTNL/>

</CP>

<CP>

<CPID>104174519</CPID>

<SCHLGLACTNL/>

</CP>

<CP>

<CPID>104236467</CPID>

<SCHLGLACTNL/>



of 252

Revision 2.0

</CP>

<CP>

<CPID>105978007</CPID>

<SCHLGLACTNL/>

</CP>

<CP>

<CPID>106093661</CPID>

<SCHLGLACTNL/>

</CP>

</CPL>

<WRID>200005420</WRID>

</SLA>

</scheduledActionsList>

</getScheduledLegalActionsOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


10001 FSFN worker login ID is not valid.

10002 FSFN Case ID is not a valid active case.

10003 Scheduled From Date is Required when Scheduled To Date is sent

10004 Scheduled To Date is Required when Scheduled From Date is sent

10005 Scheduled To Date should be greater than or equal to Scheduled From Date.

10006 FSFN Worker doesn't have active assignment to the case.

10007 No results returned

2.21.9. Sort Sequence Ordered by ascending CPID.



WORKER X

ASSIGNMENT X

CASE_MASTER X

ORG_WORKER_ROLE X

CASE_PART X

LEGAL_ACTION X

LA_CASE_NBRS X



of 252

Revision 2.0

2.22. Web Service: getEducationReportCardQuestionaire 2.22.1. Functional Description

Gets all Report Card data saved by a given worker from any of their profiles.

2.22.2. Input Schema


<xsd:element name="educationReportCardQuestionaireInputForm"

type="EducationReportCardQuestionaireInputForm"/>

<xsd:complexType name="EducationReportCardQuestionaireInputForm">

<xsd:sequence>


</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

EducationReportCar

dQuestionaireInputF

orm


input data

N/A N/A form

loginId The worker’s username. WORKER Maintain

Worker

String



<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getEducationReportCardQuestionaire</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<educationReportCardQuestionaireInputForm>


</educationReportCardQuestionaireInputForm>



of 252

Revision 2.0

]]>

</jav:inputXML>



</mob:p_form>


</x:Body>

</x:Envelope>


<xsd:element name="educationReportCardQuestionaireOutputForm"

type="EducationReportCardQuestionaireOutputForm"/>

<xsd:complexType name="EducationReportCardQuestionaireOutputForm">

<xsd:sequence>

<xsd:element name="qLst" type="QLST"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="QLST">

<xsd:sequence>

<xsd:element name="QL" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="txctg" type="xsd:string"/>

<xsd:element name="idctg"

type="xsd:decimal"/>

<xsd:element name="qstn" type="QSTN"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="QSTN">

<xsd:sequence>

<xsd:element name="Q" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="QID" type="xsd:decimal"/>

<xsd:element name="qIndx" type="xsd:string"/>

<xsd:element name="txqstn" type="xsd:string"/>

<xsd:element name="ansLst" type="ALST"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ALST">

<xsd:sequence>

<xsd:element name="A" minOccurs="0" maxOccurs="unbounded">



of 252

Revision 2.0

<xsd:complexType>

<xsd:sequence>

<xsd:element name="AID" type="xsd:decimal"/>

<xsd:element name="txans" type="xsd:string"/>

<xsd:element name="scr" type="xsd:string"/>

<xsd:element name="txscr"

type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Mapping

FSFN

Frontend

Mapping

Data Type/

Length

EducationReportCard

QuestionaireOutputF

orm


output data

N/A N/A form

QLST Array of QL N/A N/A form

QL Array Question Lists form

txctg Question category CODE_DECODE N/A String

idctg Question ID CODE_DECODE N/A Integer

qstn Array of Q N/A N/A form

Q Array of questions N/A N/A form

QID Question ID EDU_RPTCARD_Q

STN_BANK

N/A Integer

qIndx Question Index EDU_RPTCARD_Q

STN_BANK

N/A String

txqstn Question text EDU_RPTCARD_Q

STN_BANK

N/A String

ansLst Array of A N/A N/A form

A Array of answers N/A N/A form

AID Answer ID EDU_RPTCARD_A

NSWR_BANK

N/A Integer

txans Answer text EDU_RPTCARD_A

NSWR_BANK.TX_

K12_ANSWR

N/A String

scr Answer assigned score

value

EDU_RPTCARD_A

NSWR_BANK.QT_

ASSIGNED_SCOR

E_VAL

N/A String

txscr Possible score value EDU_RPTCARD_A

NSWR_BANK.TX_

POSSIBLE_SCORE

N/A String



of 252

Revision 2.0

_VAL


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getEducationReportCardQuestionaire</java:meth

odName>





<educationReportCardQuestionaireOutputForm>

<qLst>

<QL>

<txctg>School Stability</txctg>

<idctg>2145</idctg>

<qstn>

<Q>

<QID>1</QID>

<qIndx>1a</qIndx>

<txqstn>Child has been enrolled in same school during school

year.</txqstn>

<ansLst>

<A>

<AID>1</AID>

<txans>Remains in same school attended at removal</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>2</AID>

<txans>Has changed schools once during removal episode but not during school

year</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>3</AID>

<txans>Has changed schools once during school year, but change occurred at end of

grading period</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>4</AID>

<txans>Has changed schools 1 time during grading period or has had 2



of 252

Revision 2.0

changes</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>5</AID>

<txans>Has changed schools 3 or more times</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>6</AID>

<txans>Unknown</txans>

<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>7</AID>

<txans>Not Applicable</txans>

<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

<Q>

<QID>2</QID>

<qIndx>1b</qIndx>

<txqstn>If child changed schools during school year, he/she was

enrolled;</txqstn>

<ansLst>

<A>

<AID>8</AID>

<txans>Within one school day.</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>9</AID>

<txans>Within two school days.</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>10</AID>

<txans>Within three school days.</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>11</AID>

<txans>Within five school days.</txans>



of 252

Revision 2.0

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>12</AID>

<txans>Over five school days.</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>13</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>14</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Attendance</txctg>

<idctg>2146</idctg>

<qstn>

<Q>

<QID>3</QID>

<qIndx>2</qIndx>

<txqstn>The child is free of absences and tardiness.</txqstn>

<ansLst>

<A>

<AID>15</AID>

<txans>Zero absences and zero tardies</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>16</AID>

<txans>One excused absence, rare tardies</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>17</AID>

<txans>Two or more excused absences, occasional tardies</txans>

<scr>3</scr>

<txscr>3 </txscr>



of 252

Revision 2.0

</A>

<A>

<AID>18</AID>

<txans>One unexcused absence, occasional tardies</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>19</AID>

<txans>Two or more unexcused absences, frequent tardies</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>20</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>21</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Performance</txctg>

<idctg>2147</idctg>

<qstn>

<Q>

<QID>4</QID>

<qIndx>3a</qIndx>

<txqstn>Passing courses. The child is:</txqstn>

<ansLst>

<A>

<AID>22</AID>

<txans>Passing all courses and excelling in majority of classes</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>23</AID>

<txans>Passing all courses with average scores/grades</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>



of 252

Revision 2.0

<AID>24</AID>

<txans>Passing, but struggling</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>25</AID>

<txans>Failing, but in only one or two courses</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>26</AID>

<txans>Failing majority of courses taken</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>27</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>28</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

<Q>

<QID>5</QID>

<qIndx>3b</qIndx>

<txqstn>Age-appropriate level for Reading and Math. The child

scored:</txqstn>

<ansLst>

<A>

<AID>29</AID>

<txans>Above the appropriate level in both reading and math</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>30</AID>

<txans>At the appropriate level in both reading and math</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>31</AID>



of 252

Revision 2.0

<txans>At/above in one but below in the other</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>32</AID>

<txans>Marginally below in both</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>33</AID>

<txans>Significantly below in both</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>34</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>35</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Student Involvement</txctg>

<idctg>2148</idctg>

<qstn>

<Q>

<QID>6</QID>

<qIndx>4</qIndx>

<txqstn>Involvement in extra-curricular programs.</txqstn>

<ansLst>

<A>

<AID>36</AID>

<txans>The child has been consistently involved in at least one extra-curricular

(school or other) program for more than 3 months</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>37</AID>

<txans>The child became involved in an activity within the prior 3



of 252

Revision 2.0

months</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>38</AID>

<txans>There are plans for the child to begin an activity or child recently completed

one</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>39</AID>

<txans>Caregiver/child are willing to explore an activity but no plans are

made</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>40</AID>

<txans>There is no willingness to participate</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>41</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>42</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Parent Involvement</txctg>

<idctg>2149</idctg>

<qstn>

<Q>

<QID>7</QID>

<qIndx>5</qIndx>

<txqstn>Parent or caregiver actively communicates with teacher(s) of the child and

participates in school events. The Parent or caregiver:</txqstn>

<ansLst>

<A>



of 252

Revision 2.0

<AID>43</AID>

<txans>Has frequent, active communication with the teacher and often participates

in school events</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>44</AID>

<txans>Has regular, active communication and occasionally participates in school

events</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>45</AID>

<txans>Has regular communication but does not participate in school

activities</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>46</AID>

<txans>Rarely communicates with the teacher and does not

participate</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>47</AID>

<txans>Has had no communication</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>48</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>49</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>ESE</txctg>



of 252

Revision 2.0

<idctg>2150</idctg>

<qstn>

<Q>

<QID>8</QID>

<qIndx>6</qIndx>

<txqstn>Exceptional Child Education (ESE) needs OR Individual Education Plan (IEP).

The child:</txqstn>

<ansLst>

<A>

<AID>50</AID>

<txans>Has been assessed (or functions such that clearly no formal assessment is

needed) and has no ESE needs OR a current IEP is in place</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>51</AID>

<txans>Current educational setting appears to be appropriate</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>52</AID>

<txans>Is in the process of being assessed for educational needs or it is known that

an IEP should be developed</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>53</AID>

<txans>Has known ESE needs that are not being addressed but someone is

advocating</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>54</AID>

<txans>Has known ESE needs and there is no plan or action steps to

address</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>55</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>56</AID>




of 252

Revision 2.0

<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Graduation Progress</txctg>

<idctg>2151</idctg>

<qstn>

<Q>

<QID>9</QID>

<qIndx>7</qIndx>

<txqstn>On schedule to graduate from High School or obtain a

GED</txqstn>

<ansLst>

<A>

<AID>57</AID>

<txans>No barriers that would delay timely graduation OR child is of an age where

it is clearly known that he/she is on track</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>58</AID>

<txans>May be some barriers but still believed child will be on track to graduate

timely</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>59</AID>

<txans>Sufficient risk factors that make timely graduation an

uncertainty</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>60</AID>

<txans>Not on track, but it is possible to remedy the situation</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>61</AID>

<txans>Significantly behind and will require a strong plan</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>



of 252

Revision 2.0

<AID>62</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>63</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Behavior</txctg>

<idctg>2152</idctg>

<qstn>

<Q>

<QID>10</QID>

<qIndx>8</qIndx>

<txqstn>Exhibits age appropriate school behavior and participation. The

child:</txqstn>

<ansLst>

<A>

<AID>64</AID>

<txans>Models positive behaviors and often assumes leadership role to positively

influence peers and others</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>65</AID>

<txans>Receives all positive feedback from the school for behavior and

participation (home notes or citizenship scores on report card)</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>

<AID>66</AID>

<txans>Receives occasional, minor comments/intervention related to behavior or

participation</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>67</AID>

<txans>Receives frequent teacher comments or occasional disciplinary

action</txans>

<scr>2</scr>



of 252

Revision 2.0

<txscr>2 </txscr>

</A>

<A>

<AID>68</AID>

<txans>Requires frequent teacher comments/disciplinary action and/or

parent/teacher conferences or is suspended or expelled from school or becomes involved with Law

Enforcement for school or school related actions.</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>69</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>70</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

<QL>

<txctg>Mentor</txctg>

<idctg>2153</idctg>

<qstn>

<Q>

<QID>11</QID>

<qIndx>9</qIndx>

<txqstn>Child has a connection to the community.</txqstn>

<ansLst>

<A>

<AID>71</AID>

<txans>Child has connection thru tutor, surrogate parent for education, big

brother/sister, mentor from formal mentoring prgrm, adult voluntary in a svc learning project,

etc.</txans>

<scr>5</scr>

<txscr>5 </txscr>

</A>

<A>

<AID>72</AID>

<txans>Child referred and on waitlist for approp. connection

program.</txans>

<scr>4</scr>

<txscr>4 </txscr>

</A>

<A>



of 252

Revision 2.0

<AID>73</AID>

<txans>Child in process of being referred for approp. connection

program.</txans>

<scr>3</scr>

<txscr>3 </txscr>

</A>

<A>

<AID>74</AID>

<txans>Child not yet been referred to a connection program.</txans>

<scr>2</scr>

<txscr>2 </txscr>

</A>

<A>

<AID>75</AID>

<txans>Child has no connection AND appropriate program does not

exist</txans>

<scr>1</scr>

<txscr>1 </txscr>

</A>

<A>

<AID>76</AID>


<scr>0</scr>

<txscr>U </txscr>

</A>

<A>

<AID>77</AID>


<scr>0</scr>

<txscr>NA</txscr>

</A>

</ansLst>

</Q>

</qstn>

</QL>

</qLst>

</educationReportCardQuestionaireOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>




of 252

Revision 2.0

2.22.9. Sort Sequence Ordered by QID and then AID within each QID.



CODE_DECODE X

EDU_RPTCARD_QSTN_BANK X

EDU_RPTCARD_ANSWR_BANK X

2.23. Web Service: getIntakeInvsDetails 2.23.1. Functional Description

This webservice references data points that no longer exist; therefore, it is non-functional.

This webservice will accept the Intake ID and will return Intake details. The Intake ID passed should be

the ARID, returned from the output of getAssignedCaseCPI webservice. The ARID is the unique

identifier of an intake. Each sequence in an intake will have a unique ARID. The ARID will be passed to

saveInvestigation webservice to create an investigation. This web service will return most of the

information that is on Intake module of FSFN.

This method provides various pieces of information, relative to the specified Intake ID as part of the input

XML and will return Intake details. This webservice will return the following information.

• Intake information

• List of Participants

• List of Allegations

• List of Relationships

• CI Unit and Reporter information

2.23.2. Input Schema There is a schema file, but its empty. This is what the input schema used to be:


<xsd:element name="intakeInvsDetailsInputForm"

type="IntakeInvsDetailsInputForm"/>

<xsd:complexType name="IntakeInvsDetailsInputForm">

<xsd:sequence>

<xsd:element name="ARID" type="xsd:decimal"/>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

intakeInvsDetailsInp

utForm


input data

N/A N/A form





of 252

Revision 2.0

ARID Intake ID ACCESS_REPOR

T

N/A Integer


<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"


<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getIntakeInvsDetails</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<intakeInvsDetailsInputForm>

<ARID>105424495</ARID>

</intakeInvsDetailsInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</x:Body>

</x:Envelope>


<xsd:element name="intakeInvsDetailsOutputForm" type="IntakeInvsDetailsOutputForm" />

<xsd:complexType name="IntakeInvsDetailsOutputForm">

<xsd:sequence>

<xsd:element name="ARID" type="xsd:decimal" />

<xsd:element name="INTKNM" type="xsd:string" />

<xsd:element name="INTKID" type="xsd:string" />

<xsd:element name="SEQ" type="xsd:string" />

<xsd:element name="INTKDT" type="xsd:string" />

<xsd:element name="INTKCNTY" type="xsd:string" />

<xsd:element name="INVSTYPE" type="xsd:string" />

<xsd:element name="INVSSUBTYPE" type="xsd:string" />

<xsd:element name="PRVNM" type="xsd:string" />

<xsd:element name="RTM" type="xsd:string" />

<xsd:element name="LAWNTF" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="PRINVL" type="xsd:string" />

<xsd:element name="rptR" type="RPTR" />

<xsd:element name="PRMLNG" type="xsd:string" />

<xsd:element name="IN" type="xsd:string" />

<xsd:element name="DVH" type="xsd:string" />

<xsd:element name="parinfo" type="PARINFO" />

<xsd:element name="alinfo" type="ALINFO" />

<xsd:element name="ALNR" type="xsd:string" />

<xsd:element name="rptrsinfo" type="RPTRSINFO" />

<xsd:element name="ciunit" type="CIUNIT" />

<xsd:element name="rell" type="RELL" />

<xsd:element name="WSC" type="xsd:string" />

<xsd:element name="NWSC" type="xsd:string" />

<xsd:element name="CALLNUM" type="xsd:string" />

<xsd:element name="DESWRKRNM" type="xsd:string" />

<xsd:element name="DESSTATUS" type="xsd:string" />

<xsd:element name="DESDT" type="xsd:string" />

<xsd:element name="DESREASON" type="xsd:string" />

<xsd:element name="DESEXP" type="xsd:string" />

<xsd:element name="PRPI" type="xsd:string" />

<xsd:element name="SPLCONDTYPE" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="RPTR">

<xsd:sequence>

<xsd:element name="NM" type="xsd:string" />

<xsd:element name="STREET" type="xsd:string" />

<xsd:element name="UNIT" type="xsd:string" />

<xsd:element name="CITY" type="xsd:string" />

<xsd:element name="COUNTY" type="xsd:string" />

<xsd:element name="STATE" type="xsd:string" />

<xsd:element name="ZIPCODE" type="xsd:string" />

<xsd:element name="PH" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="PARINFO">

<xsd:sequence>

<xsd:element name="PARINF" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="PARTNM" type="xsd:string" />

<xsd:element name="ID" type="xsd:decimal" />

<xsd:element name="ROLE1" type="xsd:string" />





<xsd:element name="GNDR" type="xsd:string" />

<xsd:element name="DOB" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="AGE" type="xsd:string" />

<xsd:element name="ETHN" type="xsd:string" />

<xsd:element name="RACE" type="xsd:string" />

<xsd:element name="HISPANIC" type="xsd:string"

/>

<xsd:element name="INDNTRB1" type="xsd:string"

/>

<xsd:element name="INDNTRB2" type="xsd:string"

/>

<xsd:element name="ICWA" type="xsd:string" />

<xsd:element name="HMPHONE" type="xsd:string"

/>

<xsd:element name="WRKPHONE"


<xsd:element name="WRKEXT" type="xsd:string" />

<xsd:element name="CELLPHONE"


</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ALINFO">

<xsd:sequence>

<xsd:element name="ALINF" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="VIC" type="xsd:string" />

<xsd:element name="MAL" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="RPTRSINFO">

<xsd:sequence>

<xsd:element name="RPTRNM" type="xsd:string" />

<xsd:element name="TYPE" type="xsd:string" />

<xsd:element name="CLID" type="xsd:string" />

<xsd:element name="CLIDNA" type="xsd:string" />

<xsd:element name="REQCNT" type="xsd:string" />

<xsd:element name="RPTM" type="xsd:string" />

<xsd:element name="MTEL" type="xsd:string" />

<xsd:element name="CFAX" type="xsd:string" />

<xsd:element name="FSUB" type="xsd:string" />

<xsd:element name="RPTHOM" type="xsd:string" />

<xsd:element name="RPTWORK" type="xsd:string" />

<xsd:element name="RPTOTH" type="xsd:string" />

<xsd:element name="RPTNAR" type="xsd:string" />



of 252

Revision 2.0

<xsd:element name="RPTINFO" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CIUNIT">

<xsd:sequence>

<xsd:element name="BCKSUM" type="xsd:string" />

<xsd:element name="ATMPTDT" type="xsd:string" />

<xsd:element name="CMPLTDT" type="xsd:string" />

<xsd:element name="CALOG" type="xsd:string" />

<xsd:element name="CIWRKR" type="xsd:string" />

<xsd:element name="CLDTO" type="xsd:string" />

<xsd:element name="CIASGNDT" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="RELL">

<xsd:sequence>

<xsd:element name="REL" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="SUB1" type="xsd:string" />

<xsd:element name="REL" type="xsd:string" />

<xsd:element name="SUB2" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

2.23.6. Output Variables N/A

2.23.7. Example Output N/A


1001 Intake ID is a required field

1002 Invalid Intake ID


1005 General exception occurred



2.23.11. CRUD Matrix N/A



of 252

Revision 2.0

2.24. Web Service: getCLSActiveEntities 2.24.1. Functional Description

This webservice will return all the counties in FSFN and the Judges, Magistrates, Citizen Review Panel

and Attorneys associated with each county. Only active judicial groups will be returned. In FSFN, a

judicial group is active if the individual group is active and the overall group it belongs to is active. This

applies for all judicial groups i.e. Judge, Magistrate, Attorney and Citizen Review Panel.

The inputXML of this webservice consists of entity type list and county list. Entity type list can be one or

more entities types. Counties can be one or more counties. If a specific entity type is passed, then the

output will contain data corresponding to just that type. At least one entity type should be passed in the

input.

If a county list is received in input, only the judicial groups associated with those counties are sent back.

If no county is received, all county codes for which active judicial groups exists are sent back. TYPEID is

the code value for code group JDCLGRP.



<xsd:element name="cLSActiveEntitiesInputForm" type="CLSActiveEntitiesInputForm" />

<xsd:complexType name="CLSActiveEntitiesInputForm">

<xsd:sequence>

<xsd:element name="ENTTYP" type="TYPELIST" />

<xsd:element name="CNTYCD" type="CNTYLIST" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="TYPELIST">

<xsd:sequence>

<xsd:element name="TYPEID" type="xsd:decimal" minOccurs="0"

maxOccurs="unbounded" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CNTYLIST">

<xsd:sequence>

<xsd:element name="CNTYID" type="xsd:decimal" minOccurs="0"


</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

CLSActiveEntitiesInput Container form for all input N/A N/A form



of 252

Revision 2.0

Form data

ENTTYP Container form for

TYPELIST array

form

TYPELIST Array of TYPEID JUDICIAL_

GROUP_DE

TAIL

N/A form

TYPEID Type ID of the Judicial

Group

JUDICIAL_

GROUP_DE

TAIL

N/A Integer

CNTYCD Container form of

CNTYLIST

form

CNTYLIST Array of CNTYID form

CNTYID County ID JUDICIAL_

GROUP_DE

TAIL

N/A Integer



<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>getCLSActiveEntities</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<cLSActiveEntitiesInputForm>

<ENTTYP>

<TYPEID>2072</TYPEID>

<TYPEID>2073</TYPEID>

</ENTTYP>

<CNTYCD>

<CNTYID>1</CNTYID>

<CNTYID>2</CNTYID>

<CNTYID>3</CNTYID>

</CNTYCD>

</cLSActiveEntitiesInputForm>

]]>

</jav:inputXML>





of 252

Revision 2.0

</mob:p_form>


</x:Body>

</x:Envelope>


<xsd:element name="cLSActiveEntitiesOutputForm" type="CLSActiveEntitiesOutputForm"

/>

<xsd:complexType name="CLSActiveEntitiesOutputForm">

<xsd:sequence>

<xsd:element name="entyList" type="EntyList" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="EntyList">

<xsd:sequence>

<xsd:element name="ENTY" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="CNTYCD" type="xsd:decimal"

/>

<xsd:element name="ENTYNM" type="xsd:string" />

<xsd:element name="JGRPID" type="xsd:decimal" />

<xsd:element name="JTYPID" type="xsd:decimal" />

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

CLSActiveEntitiesOutpu

tForm

Container form for all output

data

N/A N/A form

EntyList Container form of ENTY N/A N/A form

ENTY Array of judicial information N/A N/A form

CNTYCD County code JUDICIAL_G

ROUP_DETA

IL

N/A Integer

ENTYNM Entity Name JUDICIAL_G

ROUP_DETA

IL

N/A String

JGRPID Judicial Group ID JUDICIAL_G

ROUP_DETA

IL

N/A Integer



of 252

Revision 2.0

JTYPID Judicial Group Type JUDICIAL_

GROUP_DE

TAIL

N/A Integer


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getCLSActiveEntities</java:methodName>





<cLSActiveEntitiesOutputForm>

<entyList>

<ENTY>

<CNTYCD>1</CNTYCD>

<ENTYNM>Cates, Robert P.</ENTYNM>

<JGRPID>324</JGRPID>

<JTYPID>2072</JTYPID>

</ENTY>

<ENTY>

<CNTYCD>1</CNTYCD>

<ENTYNM>Coker, Mary Day</ENTYNM>



</ENTY>

<ENTY>

<CNTYCD>1</CNTYCD>

<ENTYNM>Davis, William E.</ENTYNM>



</ENTY>

<ENTY>

<CNTYCD>1</CNTYCD>

<ENTYNM>Glant, David</ENTYNM>



</ENTY>

<ENTY>

<CNTYCD>1</CNTYCD>

<ENTYNM>Griffis, III, Stanley H.</ENTYNM>



</ENTY>

<ENTY>

<CNTYCD>1</CNTYCD>



of 252

Revision 2.0

<ENTYNM>Hulslander, Victor L.</ENTYNM>



</ENTY>

</entyList>

</cLSActiveEntitiesOutputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body>

</env:Envelope>


1604 One or more Counties are invalid.

1605 One or more Judicial Groups are invalid.

1606 SQL Exception occurred.

1607 General exception occurred.

1608 No data returned.

1609 Judicial Group is a required field.





2.25. Web Service: saveChildLegalAction 2.25.1. Functional Description

This method saves the new Legal Action, including related information like Case Id, Case Participant Id,

Legal Action Categoy, Legal Action Initiated, Date Completed, Legal Action Result, Judge Id, Magistrate

Id, Attorney Id, Legal Case Status, Legal Custody Status, Court Case Number, Court Type, Effective

Date, Legal Primary Outcome, Legal Primary New Goal, Created TIMESTAMP, Worker Role Id,

Additional Comments, Device type, GPS Service Type, GPS Accuracy and Work type in the input XML.

saveLegalAction provides the capability of saving the same legal action for multiple case participants as

long as all the case participants are active. If any case participant is inactive, legal actions will not be

saved for any participant and an exception will be thrown in exceptionXML. Similarly, if any participant

in the list is not a participant in the case in FSFN, legal actions will not be saved for any case participant

and an exception will be thrown. When multiple participants are sent, no permanency goal information

will be allowed. A validation will be performed to check this and save won't be performed in FSFN and



of 252

Revision 2.0

an exception will be sent back.

A validation will be added to check if the scheduled date in the legal action is less than or equal to

completed date. A validation will be added to verify if Requested By, Reason for Request, Original

Scheduled Date, and Next Scheduled Date are sent in the inputXML when the result is Continued or Due

Date Extended.

If the Legal Action ‘End Voluntary Services’ is sent, but there is no existing Legal Action of ‘Start

Voluntary Services’ the following validation message will be sent back by FSFN webservice: The Legal

Action ‘End Voluntary Services’ can't be saved because no Legal Action of 'Start Voluntary Services'

exists.

If the Legal Action ‘Custody of Other State-End’ is sent, but there is no existing Legal Action of

‘Custody of Other State-Begin’ the following validation message will be sent back by FSFN webservice:

The Legal Action of 'Custody of Other State-End' can't be saved because no Legal Action of ‘Custody of

Other State-Begin’ exists.

If any of the following four legal actions are sent: ‘Start Voluntary Services,’ ‘Custody of Other State-

Begin,’ ‘End Voluntary Services,’ or ‘Custody of Other State-End’, the saveLegalaction webservice will

save the legal action only when the most recent Legal Case Status is ‘NULL,’ ‘Jurisdiction Terminated,’

‘Jurisdiction of Other State,’ or ‘Voluntary.’ If these conditions are not met, the following exception will

be thrown: ‘The Case Participant’s most recent Legal Case Status must either be NULL or ‘No Legal

Case Status,’ ‘Jurisdiction Terminated,’ ‘Jurisdiction of Other State,’ or ‘Voluntary,’ in order to save this

Legal Action Initiated.

If the user attempts to create a new goal with an effective date that is equal or prior to that of the

previously documented ‘Court Approved Permanency Goal’ in FSFN, the legal action will not be saved

and the exception is sent: The Effective Date entered must be greater than the Effective Date <effective

date> of the previously documented Court Approved Permanency Goal.



<xsd:element name="saveChildLegalActionInputForm"

type="saveChildLegalActionInputForm" />

<xsd:complexType name="saveChildLegalActionInputForm">

<xsd:sequence>

<xsd:element name="caseId" type="xsd:decimal" />

<xsd:element name="casePartList" type="CPL" />

<xsd:element name="lActionCtgry" type="xsd:decimal" />

<xsd:element name="lActionIntd" type="xsd:decimal" />

<xsd:element name="dateCompleted" type="xsd:date" />

<xsd:element name="lResult" type="xsd:decimal" />

<xsd:element name="lCounty" type="xsd:decimal" />

<xsd:element name="lJudge" type="xsd:decimal" />

<xsd:element name="lMagistrate" type="xsd:decimal" />

<xsd:element name="lAttorney" type="xsd:decimal" />

<xsd:element name="lCaseStatus" type="xsd:decimal" />

<xsd:element name="lCustodyStatus" type="xsd:decimal" />

<xsd:element name="lCourtNum" type="xsd:string" />

<xsd:element name="lCourtNumCD" type="xsd:decimal" />

<xsd:element name="dateEffective" type="xsd:date" />



of 252

Revision 2.0

<xsd:element name="lOutcome" type="xsd:decimal" />

<xsd:element name="lNewGoal" type="xsd:decimal" />

<xsd:element name="tsCreated" type="xsd:date" />

<xsd:element name="workerRoleId" type="xsd:decimal" />

<xsd:element name="addtnlComments" type="xsd:string" />

<xsd:element name="deviceType" type="xsd:decimal" />

<xsd:element name="gpseviceType" type="xsd:decimal" />

<xsd:element name="gpsAccuracy" type="xsd:string" />

<xsd:element name="workType" type="xsd:decimal" />

<xsd:element name="dateSchd" type="xsd:date" />

<xsd:element name="lCOutcome" type="xsd:decimal" />

<xsd:element name="lCNewGoal" type="xsd:decimal" />

<xsd:element name="lRqstdBy" type="xsd:decimal" />

<xsd:element name="lRsnforReq" type="xsd:decimal" />

<xsd:element name="dateOrgSchd" type="xsd:date" />

<xsd:element name="dateNextSchd" type="xsd:date" />

<xsd:element name="dateActHeld" type="xsd:date" />

<xsd:element name="lFlGrntd" type="xsd:string" />

<xsd:element name="clsdrftodr" type="xsd:string" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="CPL">

<xsd:sequence>

<xsd:element name="CPID" type="xsd:decimal" minOccurs="0"


</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveChildLegalActionIn

putForm

Container form for all input

data

N/A N/A form

CPL Array of CPIDs N/A N/A form

CPID Case participant ID CASE_PAR

T


caseId Case ID CASE_PAR

T


lActionCtgry Action Category code CODE_DEC

ODE.ID_GR

P


lActionIntd Legal Action initiated code CODE_DEC

OE.ID_GRP

I


dateCompleted Date Legal Action completed LEGAL_AC Legal Action Timestamp



of 252

Revision 2.0

TION

lResult Result code LEGAL_AC

TION


lCounty Judicial Group county code LEGAL_AC

TION.CD_C

OUNTY


lJudge Legal Action Judge ID LEGAL_AC

TION

Integer

lMagistrate Legal Action Magistrate ID LEGAL_AC

TION


lAttorney Legal Action Attorney ID LEGAL_AC

TION


lCaseStatus Legal Case Status LEGAL_AC

TION.CD_L

EGAL_CAS

E_STAT


lCustodyStatus Legal custody status LEGAL_AC

TION.CD_L

EGAL_CUS

T_STAT


lCourtNum Court case number (FSFN

specific)

LA_CASE_

NBRS

Legal Action String

lCourtNumCD Court case code (General) LA_CASE_

NBRS

Legal Action String

dateEffective Date effective. NOTE: this

value can default to an invalid

value, causing the webservice

to fail.

LEGAL_AC

TION


lOutcome Legal Action outcome code LEGAL_AC

TION


lNewGoal LEGAL_AC

TION


tsCreated Timestamp created LEGAL_AC

TION


workerRoleId Worker role ID of the worker

saving this legal action

LEGAL_AC

TION.ID_C

R


addtnlComments Additional Comments LEGAL_AC

TION

Legal Action String

deviceType RDC Device Type RDC_EVEN

TS


gpseviceType GPS device type RDC_EVEN

TS


gpsAccuracy GPS accuracy RDC_EVEN

TS

Legal Action String

workType Work type RDC_EVEN

TS




of 252

Revision 2.0

dateSchd Date scheduled LEGAL_AC

TION


lCOutcome Outcome LEGAL_AC

TION


lCNewGoal New Goal LEGAL_AC

TION


lRqstdBy Requested by (whom) LEGAL_AC

TION


lRsnForReq Reason for request LEGAL_AC

TION


dateOrgSchd date originally scheduled LEGAL_AC

TION


dateNextSchd date next scheduled LEGAL_AC

TION


dateActHeld date actually held LEGAL_AC

TION


lFlGrntd Granted flag LEGAL_AC

TION

Legal Action String

clsdrftodr Flag for cls dft request date LEGAL_AC

TION

Legal Action String



<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>

<jav:methodName>saveChildLegalAction</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveChildLegalActionInputForm>


<casePartList>

<CPID>11491058</CPID>

</casePartList>

<lActionCtgry>2074</lActionCtgry>

<lActionIntd>846</lActionIntd>

<dateCompleted>2010-12-31T18:26:41-00:00</dateCompleted>

<lResult>1084</lResult>

<lCounty>1</lCounty>



of 252

Revision 2.0

<lCaseStatus>1025</lCaseStatus>

<lCustodyStatus>1036</lCustodyStatus>

<lCourtNum>ABC-8</lCourtNum>

<lCourtNumCD>1040</lCourtNumCD>

<dateEffective>2010-12-31T19:26:41-00:00</dateEffective>

<lOutcome>1054</lOutcome>

<lNewGoal>363</lNewGoal>



<addtnlComments>Testing creation of legal action</addtnlComments>



<dateSchd>2010-12-30T18:26:41-00:00</dateSchd>

<lRqstdBy>1012</lRqstdBy>

<lRsnforReq>1017</lRsnforReq>

<dateOrgSchd>2011-03-03T18:26:41-00:00</dateOrgSchd>

<dateNextSchd>2011-03-03T18:26:41-00:00</dateNextSchd>

<dateActHeld>2011-03-05T18:26:41-00:00</dateActHeld>

<lFlGrntd>Y</lFlGrntd>

</saveChildLegalActionInputForm>

]]>

</jav:inputXML>



</mob:p_form>


</x:Body>

</x:Envelope>


<xsd:element name="saveChildLegalActionOutputForm"

type="saveChildLegalActionOutputForm" />

<xsd:complexType name="saveChildLegalActionOutputForm">

<xsd:sequence>

<xsd:element name="LAOUT" type="LALIST" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="LALIST">

<xsd:sequence>

<xsd:element name="LA" minOccurs="1" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="PRSNID" type="xsd:decimal"

/>


<xsd:element name="TSCR" type="xsd:string" />



of 252

Revision 2.0

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:schema>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveChildLegalActionO

utputForm


data

N/A N/A form

LALIST Container form of LA N/A N/A form

LA Legal action container array N/A N/A form

PRSNID Person ID LEGAL_AC

TION

Legal Action form

LAID Legal Action ID LEGAL_AC

TION


TSCR Timestamp created LEGAL_AC

TION

N/A Timestamp


<env:Header/>

<env:Body>



<java:methodName xmlns:java="java:com.ams.sacwis.mobile.services">

saveChildLegalActionOutputForm</java:methodName>





< saveChildLegalActionOutputForm > <LA>

<PRSNID>91000231</PRSNID>

<LAID>93000234</LAID>

<TSCR> 2019-09-03T18:26:41-00:00</TSCR>

</LA>

</ saveChildLegalActionOutputForm >

</java:outputXML>



<webServiceError>


</webServiceError>




of 252

Revision 2.0



</env:Body> </env:Envelope>



1002 Person Id is required.

10001 Legal Action Initiated is required.

10002 Legal Action County is required.

10003 Completed Date is required for the result selected

10004 Legal Action Case Status is required for the selected Legal Action

Case Custody Status.

10005 Legal Action Case Custody Status is required for the selected Legal

Action Case Status.

10006 Legal Action Court Case Number is required for the Court selected.

10007 Legal Action Court Type is required for the Court Case Number

selected.

10008 Effective Date is required when a Primary or Concurrent New Goal is

selected.

10009 Effective Date is required when an Outcome is selected associated

with a Primary or Concurrent New Goal.

10010 Outcome is required when a Primary or Concurrent New Goal is

selected.

10011 Primary or Concurrent New Goal is required when an Outcome is

selected.

10012 Date/Time created is required.

10013 Created By Worker is required.

10015 Invalid date/time format for Created Timestamp.

10016 Timestamp Created should not be a future date.

10017 WorkerRoleId is invalid.

10018 WorkerRoleId doesn’t have open assignment to the case.

10019 Case ID and Case Participant Id combination is not valid.

10020 The combination of Legal Action Category and Legal Action Initiated

is invalid.

10021 The combination of Legal Action Initiated and Legal Action Result is

invalid.

10022 The combination of county and judge is invalid.

10023 The combination of county and magistrate is invalid.

10025 Judge is Inactive, legal action can't be saved.

10026 Magistrate is Inactive, legal action can't be saved.

10027 When there is no Primary New goal and Outcome or no Concurrent

new goal and Outcome, effective date should be blank.

10028 Legal Action Category is required.

10029 Legal Action Category and legal Action Initiated are required.

10030 Scheduled Date must be equal to or less than Completed Date.

10031 When result is Continued or Due Date Extended, Requested By is

required.



of 252

Revision 2.0

10032 When result is Continued or Due Date Extended, Reason for Request is

required.

10033 When result is Continued or Due Date Extended, Original Scheduled

Date is required.

10034 When result is Continued or Due Date Extended, Next Scheduled Date

is required.

10035 If Requested By, Reason for Request, Original Scheduled Date or

Next Scheduled Date are not blank, Result should be Continued or

Due Date Extended.

10036 Participant <Participant Name> is not active in the FSFN case.

10037 The Effective Date must be greater than the Effective Date <effective

date> of the previously documented Court Approved Permanency

Goal.

10038 No Permanency Goal information allowed when multiple participants

sent.

10039 The Legal Action ‘End Voluntary Services’ can't be saved because no

Legal Action of 'Start Voluntary Services' exists.

10040 The Legal Action of 'Custody of Other State-End' can't be saved

because no Legal Action of ‘Custody of Other State-Begin’ exists.

10041 The Case Participant’s most recent Legal Case Status must either be

blank or ‘No Legal Case Status,’ ‘Jurisdiction Terminated,’

‘Jurisdiction of Other State,’ or ‘Voluntary,’ in order to save this

Legal Action Initiated.

10042 Please make sure atleast one participant is sent.

10043 'Requested By' is invalid.

10044 'Reason for Request' is invalid.

10045 'Concurrent Outcome' is invalid.

10046 'Concurrent New Goal' is invalid.




LEGAL_ACTION X X

LA_CASE_NBRS X

LEGAL_RECORD X X

ORG_WORKER_ROLE X

CASE_PART X

ASSIGNMENT X

RDC_EVENTS X

CODE_DECODE X

CODE_XREF X


PERSON X

2.26. Web Service: saveInvestigation



of 252

Revision 2.0

2.26.1. Functional Description The save investigation will create an investigation in FSFN for a given Intake. It will receive the ARID,

which is the unique identifier for an intake and create an Investigation in FSFN. The webservice will

return the unique identifier of the investigation created.

The ARID passed in inputXML will be retrieved from the ARID returned by getAssignedCaseCPI. If an

investigation is already created for the intake ID sent in inputXML, then the webservice will simply

return the existing investigation ID for that intake. Investigation will only be created when the ARID

passed in inputXML corresponds to an Initial Intake and an investigation has already not been created. If

the ARID is the intake id of an intake sequence, then this intake will be linked to the investigation that the

Initial Intake is linked to. Also, if the ARID passed is of an Initial Child Intake then a Child Investigation

will be created. If ARID is of an Initial Adult intake, then an Adult Investigation will be created. If ARID

is of a Special Conditions Intake, then a Special Condition Referral will be created. This webservice will

be used by CPI application.

Note: the conditions must be exactly as described above, or it is likely the webservice will throw a general

exception (with no detail on why exactly it failed).

2.26.2. Input Schema No output schema exists, but the java form itself contains a rough copy of what the original schema may

have looked like.

<complexType name="SaveInvestigationInputForm">

<complexContent>

<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">

<sequence>

<element name="WRID" type="{http://www.w3.org/2001/XMLSchema}decimal"/>

<element name="ARID" type="{http://www.w3.org/2001/XMLSchema}decimal"/>

</sequence>

</restriction>

</complexContent>

</complexType>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

SaveInvestigationInputF

orm

Container form for all input

data

N/A N/A form

WRID Worker role ID ORG_WOR

KER_ROLE

Maintain

Worker

Integer

ARID Intake ID ACCESS_R

EPORT

Integer



<x:Header/>

<x:Body>

<mob:mobileService>

<mob:p_form>



of 252

Revision 2.0

<jav:methodName>saveInvestigation</jav:methodName>

<jav:loginXML>

<![CDATA[

<mobileLogonForm>



</mobileLogonForm>

]]>

</jav:loginXML>

<jav:inputXML>

<![CDATA[

<saveInvestigationInputForm>

<WRID>910002505</WRID>

<ARID>105424298</ARID>

</saveInvestigationInputForm>

]]>

</jav:inputXML>

<jav:outputXML>?

</jav:outputXML>


</mob:p_form>


</x:Body>

</x:Envelope>

2.26.5. Output Schema No output schema exists, but the java form itself contains a rough copy of what the original schema may

have looked like.

<complexType name="SaveInvestigationOutputForm">

<complexContent>

<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">

<sequence>

<element name="InvsID" type="{http://www.w3.org/2001/XMLSchema}decimal"/>

</sequence>

</restriction>

</complexContent> </complexType>


Database

Mapping

FSFN

Frontend

Mapping

Data Type/

Length

saveChildLegalActionO

utputForm


data

N/A N/A form



of 252

Revision 2.0

LALIST Container form of LA N/A N/A form

LA Legal action container array N/A N/A form

PRSNID Person ID LEGAL_AC

TION

Legal Action form

LAID Legal Action ID LEGAL_AC

TION


TSCR Timestamp created LEGAL_AC

TION

N/A Timestamp


<env:Header/>

<env:Body>



<java:methodName

xmlns:java="java:com.ams.sacwis.mobile.services">getScheduledLegalActions</java:methodName>





< saveInvestigationOutputForm >

<InvsID>93000024</InvsID>

</ saveInvestigationOuputForm>

</java:outputXML>



<webServiceError>


</webServiceError>




</env:Body> </env:Envelope>

2.26.8. Error Guide



2010 Invalid Worker ID

2003 Intake ID passed is not valid

2005 Case is not assigned to the worker role id passed

2008 Must first commence01 sequence or create investigation shell in FSFN

906 FSFN Application Exception - Please contact system administrator (SQL

error)


(general non-SQL error)



of 252

Revision 2.0

N/A



ACCESS_REPORT X

ASSIGNMENT X

INVESTIGATION X X

INTAKE_PART X X

*see Intake topic

paper, as this service

directly uses the same

processes to create an

investigation

3. Outliner Changes 3.1. Description

When any of the five identified Mobile Data Capture Solution Documents are uploaded into FSFN,

the user is able to access them from their FSFN Desktop Outliner. These five documents include:

Request for TANF Funds/Eligibility Determination, Verification of Indian Child Welfare Act

Eligibility, Out of Home Plan, Safety Plan and Family Visitation Plan. These documents are not the

documents launched and created in FSFN, but are individual documents uploaded into FSFN from

the Remote Data Capture Solution, through the two-way data interchange process. Once the

document has been successfully uploaded into FSFN, the user expands the Cases expando and drills

down on the appropriate Case Folder. Once the user has drilled down upon the appropriate Case

Folder, s/he must drill down on the File Cabinet icon to view all scanned/uploaded documents

associated with the selected case, which includes those uploaded from the Remote Data Capture

Solution. Upon drilling down on the File Cabinet icon, all documents that have either been scanned

or uploaded into FSFN will be displayed as hyperlinks. See Screenshot #1 below, for an example.

Family Visitation Plan can also be viewed from the planning expando under the cases expando along

with the Family Visitation Plan forms created by the FSFN application. The Out of Home plan and

Safety Plan documents uploaded into FSFN by the saveMobileCaseDocument web service can also

be accessed by expanding the out of home plan and safety plan under the planning expando of the

cases expando.

Screenshot #1



of 252

Revision 2.0

Mobile

Document –

Family

Visitation Plan

04/22/2009 ,

Estefan,

Gloria;

Mobile

Docum

ent –

Safety

Plan

04/22/

2009 ,

Estefa

n,

Gidget;

Mobile

Document –

Out of

Home Plan

04/22/2009

Mobile Document – Request for

TANF Funds/Eligibility Determination

04/22/2009

Mobile Document – Verification of

Indian Child Welfare Act Eligibility

04/22/2009 , Estefan, Gloria;

Estefan, Gidget;



of 252

Revision 2.0

Those forms loaded into FSFN from the Remote Data Capture Solution will be displayed as a

hyperlink with an indicator of „Mobile Document‟ preceding the name of the form. Displayed

beneath the hyperlink will be the date the form was uploaded into FSFN successfully, as well

as the participant(s) associated with the document. If the form that is uploaded into FSFN is

not associated with a participant, only the date the form was uploaded in FSFN successfully

will be displayed. Please note that the name of the form displayed on the desktop outliner is

based on the information entered into the Remote Data Capture Solution, and is not

determined by the FSFN system. Selecting the hyperlink will launch the Imaging page. See

Screenshot #2 below, for an example.

Screenshot #2

Within the Participant Details group box, the Case Name, Case Id, and Worker who uploaded

the document, will be displayed. In addition, if a participant(s) is associated with the document,

the name(s) will be displayed within the Participant group box. Within the Image Details group

box, the following information will be displayed: Date Document scanned (date the document

was successfully uploaded into FSFN), Image (Category the document falls in, which is

„Mobile Document‟), Type (name of the form), File Name (name of the form.pdf), and any

comments that are associated with the document, which were sent via the two-way data

interchange process, if applicable. The Imaging page will be displayed in view only format

along with the GPS coordinates. For each document uploaded to FSFN, a



of 252

Revision 2.0

„View‟ and „Delete‟ hyperlink will be displayed next to the File Name. Selecting the „View‟

hyperlink launches the PDF document in view only mode. Changes cannot be made to the form

loaded into FSFN from the Remote Data Capture Solution. Selecting the „Delete‟ hyperlink

triggers a dialog prompt to display, asking if the user is sure they want to delete the image from

the record. See Screenshot #3 below, for an example.

Screenshot #3

Selecting „Yes‟ will delete the file associated with the Imaging page, and the „View‟ and

„Delete‟ hyperlinks will no longer be displayed. However, the Imaging page itself is not

deleted. In addition, the system will automatically display the text „ImageDeleted‟ next to the

File Name, and will automatically display the following in the Comments field: null [image

was deleted by <worker last name, worker first name, worker middle initial> on

MM/DD/YYYY tt:tt am/pm]. See Screenshot #4 below, for an example.

Screenshot #4



of 252

Revision 2.0

The ability to delete the file from the Imaging page provides the user with flexibility in the

event the wrong category or type is selected from the client side, on the Mobile Data Capture

Solution, for the document that was uploaded. Once the file is deleted from the Imaging page,

the user must perform another upload to FSFN, which will create new imaging pages for any

documents uploaded. However, the previous Imaging page, which no longer contains a file,

will remain. This way the system is able to maintain a history of any documents that were

uploaded, and subsequently deleted.

Screenshot #5

The GPS coordinates will be shown on the View Image pop-up launched from the View

hyperlink of the Image details pop-up launched from the image history pop up page. Image

history pop up is launched from View Photo History of the Additional Tab of the Person

Management screen. The GPS coordinates can also be viewed from the View Image pop-up

launched from the View Current Photo hyperlink on the Additional Tab of the Person

Management screen.



of 252

Revision 2.0

o Display Data Capture Documents in Context with view Action

3.2. Audit Information The Soap Request and Response corresponding to the mobile webservice will be

intercepted to retrieve the soap body and record in FSFN audit data. This information will

be stored in two tables.

TRAN_STAT and TRAN_AUDIT_LOG. The TRAN_STAT table holds the basic information

on the request, the path, action, user IP from where the request came from, user host and

number of seconds to execute the call. The TRAN_AUDIT_LOG table contains the blob of

the actual soap request and response. The TX_PATH for the audit will be /MobileService and

ACTION will be the method name that is supplied in the input XML. This will indicate the

webservice method that is getting called. The Id_TRAN_STAT can be used to get the blob

that is inserted in the TRAN_AUDIT_ LOG. The Blob can be converted into the XML to

retrieve the soap request and response.

Florida Safe Families...

Documents

Transcript of Florida Safe Families...