GetSession Gets the specified session details along with session clients DeleteSession Deletes a specified Session UpdateSession Updates the following given details for specified session: CaseId (Unique Provider’s Case Id) Session Id (Unique Provider’s Session Id) Session Date Service Type Id No of unidentified Clients Fee Charged Money Business Community Education Workshop Code Session Client Details Identified Client Ids (Provider’s Client Ids) Participation Code Client Referral Out With Purpose DataCollection.Assessments Operation Date Locking Description UpdateClientAsssements Add or Updates the following given details for specified client in a session: Case Id (Provider’s Case Id) Session Id (Provider’s Session Id within a case) Client Id (Provider’s Client Id associated with the case) Assessments and Scores UpdateSessionAssessments Add or Updates the following given details for specified session in a case: Case Id (Provider’s Case Id) Session Id (Provider’s Session Id within a case) Assessments and Scores
DeleteClient Example Request Message <DeleteClientRequest> <!--type: string--> <ClientId>123456</ClientId> </DeleteClientRequest> DeleteClient Response Message Definition If the transaction is successful, the following structure will be returned. Field Optional Data Type Reference Date Comments Validation Rules TransactionStatus DeleteClient Example Response Message <DeleteClientResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/> </TransactionStatus> </DeleteClientResponse> DataCollection.Case AddCase The AddCase operation is to be used when a Service Provider wishes to submit data to in order to create a Case. This operation also allows attaching registered clients to the Case being created.
ReasonForAssistance Optional If one or more reasons are sent, One must indicate one reason as the primary reason for seeking assistance. The user can send multiple secondary reasons for seeking assistance AssistanceNeededCode Conditional Mandatory String DSS’s AssistanceNeededCode. Can be retrieved using GetReferenceData operation. IsPrimary Conditional Mandatory Boolean Specify if this reason is primary or not ReferralSourceCode Conditional Mandatory String Client referral received from ParentingAgreementOutcome Optional ParentingAgreementOutcomeCode Conditional Mandatory String Must be a valid ParentingAgreementOutcome code. Can be retrieved using GetReferenceData operation. DateOfParentingAgreement Conditional Mandatory DateTime ParentingAgreementOutcome Date Conditional Mandatory Boolean Was Legal Practitioner, when ParentingAgreement was formalised Section60I Optional Section60I Section60ITypeCode Conditional Mandatory String Must be a valid Section60IType code. Can be retrieved using GetReferenceData operation.
DeleteCase Request Message Definition Field Mandatory Conditional Optional Data Type Length Reference Date Comments Validation Rules CaseId Mandatory String Provider’s Case Id. DeleteCase Example Request Message <DeleteCaseRequest> <!--type:string--> <CaseId>CA0050</CaseId> </DeleteCaseRequest> DeleteCase Response Message Definition If the transaction is successful, the following structure will be returned. Field Data Type Reference Date Comments Validation Rules TransactionStatus DeleteCase Example Response Message <DeleteCaseResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/> </TransactionStatus> </DeleteCaseResponse>
Field Data Type Reference Date Comments Validation Rules TransactionStatus UpdateSession Example Response Message <UpdateSessionResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/> </TransactionStatus> </UpdateSessionResponse> DeleteSession DeleteSession operation can be used to delete a Session attached to a Case. DeleteSession Request Message Definition Field Mandatory Conditional Optional Data Type Length Reference Date Comments Validation Rules CaseId Mandatory String Provider’s Case Id. SessionId Mandatory String Provider’s Session Id for the Session to be deleted. DeleteSession Example Request Message <DeleteSessionRequest> <!--typestring--> <CaseId>0050</CaseId> <!--typestring--> <SessionId>0001</SessionId> </DeleteSessionRequest>