Department of Social Services CCMS - Service Provider Interface Technical Specifications
Child Care Management System
Service Provider Interface
Technical Specifications
Version Number: / 1.70 v0.04 DraftRevision Date: / 22 March 2016
Date of Effect: / 13 June 2016
Table of Contents
1 Overview 3
2 Interface Overview 3
2.1 CCB Approval and Service Provider Details 3
2.2 CCB Enrolments 3
2.3 Attendance Details 3
2.4 Service Provider Other Details 3
3 Interface Details 3
3.1 Transport Protocol / Technical Infrastructure 3
3.2 Interface Messages 3
3.3 Security and Authentication 3
3.4 Interface Errors 3
3.4.1 SOAP Faults 3
3.4.2 Return Code, Return Errors and Return Message 3
3.4.3 WSDL Import Considerations 3
4 Interface Data 3
4.1 Data Formats 3
4.2 Source System Code 3
4.3 Service Provider Reference 3
4.4 Attendance Batch Number 3
4.5 CCB Approval Id 3
4.6 FaCSIA Enrolment Id 3
4.7 FaCSIA Attendance Id 3
4.8 Transaction Id 3
4.9 Authorised Person data 3
4.9.1 Authorised Person Id 3
4.10 Service Client Ids 3
4.11 IS Case Ids 3
4.12 IS Case Claim Ids 3
5 Query Interfaces 3
5.1 Basic Operation of the query 3
5.2 Page Size 3
5.3 Page Number 3
5.4 Last Page Indicator 3
6 Interface Examples 3
6.1 Example Request Message 3
6.2 Example Response Message 3
6.3 Example SOAP Fault 3
6.4 Example Non Zero Return Code 3
7 Interface Availability 3
7.1 Production 3
7.2 Test System 3
8 Interface Development and Testing 3
8.1 Release of Updated Specification 3
8.2 Test System Available 3
8.3 Software Registration 3
8.4 Piloting 3
9 Appendix A – Glossary 3
10 Appendix B – Interface Listing 3
10.1 CCB Approval Interface 3
10.2 Enrolment Interface 3
10.3 Attendance Interface 3
10.4 Entitlement Adjustment Interface 3
10.5 IS Case Interface 3
10.6 IS Case Claim Interface 3
10.7 Messages Interface 3
10.8 Care Provided and Vacancy Interface 3
10.9 Remittance Interface 3
10.10 Diagnostic Interface 3
11 Appendix C – CCB Approval Interface 3
11.1 Query CCB Approval 3
11.1.1 Query CCB Approval Request Message Data Definition 3
11.1.2 Query CCB Approval Request Data Rules 3
11.1.3 Query CCB Approval Allowable Values – Request 3
11.1.4 Query CCB Approval Response Message Data Definition 3
11.1.5 Query CCB Approval Allowable Values – Response Message 3
11.2 Update Profile 3
11.2.1 Update Profile Request Message Data Definition 3
11.2.2 Update Profile Request Data Rules 3
11.2.3 Update Profile Allowable Values – Request 3
11.2.4 Update Profile Response Message Data Definition 3
11.2.5 Update Profile Allowable Values – Response Message 3
11.3 Update All Personnel 3
11.3.1 Update All Personnel Request Message Data Definition 3
11.3.2 Update All Personnel Request Data Rules 3
11.3.3 Update All Personnel Allowable Values – Request 3
11.3.4 Update All Personnel Response Message Data Definition 3
11.3.5 Update All Personnel Allowable Values – Response Message 3
11.4 Update Fees 3
11.4.1 Update Fees Request Message Data Definition 3
11.4.2 Update Fees Request Data Rules 3
11.4.3 Update Fees Allowable Values – Request 3
11.4.4 Update Fees Response Message Data Definition 3
11.4.5 Update Fees Allowable Values – Response Message 3
12 Appendix D – Enrolment Interface 3
12.1 Create Enrolment 3
12.1.1 Create Enrolment Request Message Data Definition 3
12.1.2 Create Enrolment Request Data Rules 3
12.1.3 Create Enrolment Allowable Values – Request 3
12.1.4 Create Enrolment Response Message Data Definition 3
12.1.5 Create Enrolment Allowable Values – Response Message 3
12.2 Formalise Enrolment 3
12.2.1 Formalise Enrolment Request Message Data Definition 3
12.2.2 Formalise Enrolment Request Data Rules 3
12.2.3 Formalise Enrolment Allowable Values - Request Message 3
12.2.4 Formalise Enrolment Response Message Data Definition 3
12.2.5 Formalise Enrolment Allowable Values – Response Message 3
12.3 Update Enrolment 3
12.3.1 Update Enrolment Request Message Data Definition 3
12.3.2 Update Enrolment Request Data Rules 3
12.3.3 Update Enrolment Allowable Values - Request Message 3
12.3.4 Update Enrolment Response Message Data Definition 3
12.3.5 Update Enrolment Allowable Values – Response Message 3
12.4 Cancel Enrolment 3
12.4.1 Cancel Enrolment Request Message Data Definition 3
12.4.2 Cancel Enrolment Request Data Rules 3
12.4.3 Cancel Enrolment Allowable Values - Request Message 3
12.4.4 Cancel Enrolment Response Message Data Definition 3
12.4.5 Cancel Enrolment Allowable Values – Response Message 3
12.5 Query Enrolments 3
12.5.1 Query Enrolment Request Message Data Definition 3
12.5.2 Query Enrolment Request Data Rules 3
12.5.3 Query Enrolment Allowable Values – Request Message 3
12.5.4 Query Enrolment Response Message Data Definitions 3
12.5.5 Query Enrolment Allowable Values – Response Message 3
13 Appendix E – Attendances Interface 3
13.1 Create Attendances 3
13.1.1 Create Attendance Request Message Data Definition 3
13.1.2 Create Attendance Request Data Rules 3
13.1.3 Create Attendance Allowable Values - Request Message 3
13.1.4 Create Attendance Response Message Data Definition 3
13.1.5 Create Attendance Allowable Values - Response Message 3
13.2 Query Attendances 3
13.2.1 Query Attendance Request Message Data Definition 3
13.2.2 Query Attendance Request Data Rules 3
13.2.3 Query Attendance Allowable Values – Request Message 3
13.2.4 Query Attendance Response Message Data Definition 3
13.2.5 Query Attendance Allowable Values – Response Message 3
13.3 Cancel Attendance 3
13.3.1 Cancel Attendance Request Message Data Definition 3
13.3.2 Cancel Attendance Request Data Rules 3
13.3.3 Cancel Attendance Allowable Values – Request Message 3
13.3.4 Cancel Attendance Response Message Data Definitions 3
13.3.5 Cancel Attendance Allowable Values – Response Message 3
14 Appendix F – Entitlement Adjustments Interface 3
14.1 Create CPOFR 3
14.1.1 Create CPOFR Request Message Data Definition 3
14.1.2 Create CPOFR Request Data Rules 3
14.1.3 Create CPOFR Allowable Values - Request Message 3
14.1.4 Create CPOFR Response Message Data Definition 3
14.1.5 Create CPOFR Allowable Values - Response Message 3
14.2 Cancel CPOFR 3
14.2.1 Cancel CPOFR Request Message Data Definition 3
14.2.2 Cancel CPOFR Request Data Rules 3
14.2.3 Cancel CPOFR Allowable Values - Request Message 3
14.2.4 Cancel CPOFR Response Message Data Definition 3
14.2.5 Cancel CPOFR Allowable Values - Response Message 3
14.3 Query CPOFR 3
14.3.1 Query CPOFR Request Message Data Definition 3
14.3.2 Query CPOFR Request Data Rules 3
14.3.3 Query CPOFR Allowable Values - Request Message 3
14.3.4 Query CPOFR Response Message Data Definition 3
14.3.5 Query CPOFR Allowable Values - Response Message 3
15 Appendix G – IS Case Interface 3
15.1 Query IS Case 3
15.1.1 Query IS Case Request Message Data Definition 3
15.1.2 Query IS Case Request Data Rules 3
15.1.3 Query IS Case Allowable Values – Request Message 3
15.1.4 Query IS Case Response Message Data Definition 3
15.1.5 Query IS Case Allowable Values – Response Message 3
15.2 Query IS Innovative Solutions Case 3
15.2.1 Query IS Innovative Solutions Case Request Message Data Definition 3
15.2.2 Query IS Innovative Solutions Case Request Data Rules 3
15.2.3 Query IS Innovative Solutions Case Allowable Values – Request Message 3
15.2.4 Query IS Innovative Solutions Case Response Message Data Definition 3
15.2.5 Query IS Case Allowable Values – Response Message 3
16 Appendix H – IS Case Claims Interface 3
16.1 Create IS Case Claim 3
16.1.1 Create IS Case Claim Request Message Data Definition 3
16.1.2 Create IS Case Claim Request Data Rules 3
16.1.3 Create IS Case Claim Allowable Values 3
16.1.4 Create IS Case Claim Response Message Data Definition 3
16.1.5 Create IS Case ClaimAllowable Values – Response Message 3
16.2 Query IS Case Claims 3
16.2.1 Query IS Case Claim Request Message Data Definition 3
16.2.2 Query IS Case ClaimRequest Data Rules 3
16.2.3 Query IS Case Claim Allowable Values – Request Message 3
16.2.4 Query IS Case Claim Response Message Data Definition 3
16.2.5 Query IS Case Claim Allowable Values – Response Message 3
16.3 Query IS Innovative Solutions Case Claims 3
16.3.1 Query IS Innovative Solutions Case Claims Request Message Data Definition 3
16.3.2 Query IS Innovative Solutions Case Claim Request Data Rules 3
16.3.3 Query IS Innovative Solutions Case Claim Allowable Values – Request Message 3
16.3.4 Query IS Innovative Solutions Case Claim Response Message Data Definition 3
16.3.5 Query IS Innovative Solutions Case Claim Allowable Values – Response Message 3
16.4 Cancel IS Case Claim 3
16.4.1 Cancel IS Case Claim Request Message Data Definition 3
16.4.2 Cancel IS Case Claim Request Data Rules 3
16.4.3 Cancel IS Case Claim Response Message Data Definitions 3
16.4.4 Cancel IS Case Claim Allowable Values – Response Message 3
17 Appendix I – Messages Interface 3
17.1 Retrieve Messages 3
17.1.1 Retrieve Messages Request Message Data Definition 3
17.1.2 Retrieve Messages Request Data Rules 3
17.1.3 Retrieve Messages Allowable Values – Request Message 3
17.1.4 Retrieve Messages Response Message Data Definition 3
17.1.5 Retrieve Messages Allowable Values - Response Message 3
18 Appendix J – Vacancy Interface 3
19 Appendix K – Care Provided and Vacancy Interface 3
19.1 Update Care Provided 3
19.1.1 Update Care Provided Request Message Data Definition 3
19.1.2 Update Care Provided Request Data Rules 3
19.1.3 Update Care Provided Allowable Values – Request Message 3
19.1.4 Update Care Provided Response Message Data Definition 3
20 Appendix L – Remittance Interface 3
20.1 Query Remittance by Payee 3
20.1.1 Query Remittance by Payee Request Message Data Definition 3
20.1.2 Query Remittance by Payee Request Data Rules 3
20.1.3 Query Remittance by Payee Allowable Values – Request Message 3
20.1.4 Query Remittance by Payee Response Message Data Definition 3
20.2 Query Payments for CCB Approval 3
20.2.1 Query Payments for CCB Approval Request Message Data Definition 3
20.2.2 Query Payments for CCB Approval Request Data Rules 3
20.2.3 Query Payments for CCB Approval Allowable Values – Request Message 3
20.2.4 Query Payments for CCB Approval Response Message Data Definition 3
21 Appendix M – Diagnostic Interface 3
21.1 Ping Interface 3
21.1.1 Ping Interface Request Message Data Definition 3
21.1.2 Ping Interface Request Data Rules 3
21.1.3 Ping Interface Response Message Data Definition 3
22 Appendix N – Summing and Counting Rules for Attendance 3
23 Appendix O – Data Model 3
24 Appendix P – Document Change History 3
24.1 Changes from Version 1.62 v1.00 to Version 1.70 v0.01 draft 3
24.2 Changes from Version 1.70 v0.01 to Version 1.70 v0.02 draft 3
Appendix Q – Special Characters 3
1 Overview
The Child Care Management Solution is a national child care computer system for the administration and payment of Child Care Benefit fee relief on behalf of parents to approved child care services. It will also provide for the collection of information about the supply and usage of child care across Australia.
The CCMS will allow all CCB approved child care services to provide information directly to DSS via the internet to facilitate the calculation and payment of CCB fee reduction on behalf of children in their service.
Services will use software available from third party Software Providers to record child and attendance information. This information will be transferred through the Service Provider Interface to DSS.
This document provides the technical specifications for the Service Provider Interface and is intended to provide information for third party Software Providers to the child care industry. It covers the following:
· Interface Details – technical infrastructure, interface messages and security and authentication and errors
· Interface Data – data formats and commonly used data terms
· Explanation of the Query Interface
· Interface Examples
· Interface Availability
· Development and Testing Process
· Detailed Specifications
2 Interface Overview
In order to interact with the CCMS, Service Providers will be required to use software that is capable of transferring enrolment, attendance and service data to DSS. The software will send the data through a Web Service / SOAP interface that is accessible via the Internet.
Figure 1 – High Level Technical Architecture
The transfer of data will occur via a secure HTTPS connection and Service Providers will need to authenticate via a username and password.
The software used by Service Providers will interface the following data to and from DSS:
· Limited Service Provider and CCB Approval details
· CCB Enrolments
· Weekly Attendance Details
· Vacancy Reporting
· Message for Service Providers
2.1 CCB Approval and Service Provider Details
Service Providers will be able to retrieve and update limited details relating to their Service and their CCB Approval. To facilitate this, the Service Provider Interface provides the functions to query Service and CCB Approval details, as well as update Personnel details, Operational Profile details and Fee details.
2.2 CCB Enrolments
Service Providers will need to create and update enrolment details for each child that attends care at their service. To facilitate this, the Service Provider Interface provides the functions to create, update and query enrolment details.
2.3 Attendance Details
Service Providers will need to provide attendance and session information to DSS on a weekly basis for each child who attends care. The Attendance record contains detailed information about the hours, type and fee charged for care so that the CCB fee reductions can be determined. The Service Provider Interface provides the function to create, query and cancel attendance details.
2.4 Service Provider Other Details
The Service Provider Interface also provides the ability to transfer care provided and vacancy information to DSS on a weekly basis. In addition, an interface will be provided to enable Service Providers to receive messages from DSS regarding their service.
3 Interface Details
The following section provides an overview of the technical specifications of the Service Provider Interface.
3.1 Transport Protocol / Technical Infrastructure
The Service Provider Interface will be available via the Internet; therefore an Internet connection is required to access the interface. It is anticipated that Service Providers will use a commercially available ISP (Internet Service Provider) via a broadband or similar connection to access the Internet. The speed of the Internet connection will influence performance of the data transfer.