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
GetOutletActivities Request Message Definition Field Mandatory Conditional Optional Data Type Length Reference Date Comments Validation Rules GetOutletActivities Mandatory N/A N/A An empty node to indicate a GetOutletActivities Request. GetOutletActivities Example Request Message <GetOutletActivitiesRequest> </GetOutletActivitiesRequest> GetOutletActivities Response Message Definition If the transaction is successful, the following structure will be returned. Field Data Type Length Reference Date Comments Validation Rules TransactionStatus OutletActivities Array OutletActivity OutletActivityId Int DSS’s OutletActivityId OutletId Int DSS’s OutletId OutletName String DSS’s Outlet Name ActivityName String DSS’s Activity Name ProgramName String DSS’s Program name StartDate Date StartDate of OutletActivity EndDate Date EndDate of OutletActivity
CountryOfBirthCode Mandatory String Must be a valid Country code. Can be retrieved using GetReferenceData operation. LanguageSpokenAtHomeCode Mandatory String Must be a valid Language code retrieved using GetReferenceData operation. AboriginalOrTorresStraitIslanderOriginCode Mandatory String Must be a valid AboriginalOrTorresStraitIslanderOrigin code retrieved using GetReferenceData operation. HasDisabilities Mandatory Boolean If True, then minimum of one Disability code is required. If False, then no Disability code should be IsHomeless Optional Boolean Homeless indicator HouseholdCompositionCode Conditional Optional Boolean Must be a valid HouseholdCompositionCode retrieved using GetReferenceData operation. MainSourceOfIncomeCode Optional String Must be a valid MainSourceOfIncomeCode retrieved using GetReferenceData operation. IncomeFrequencyCode Optional String Must be a valid Disability code retrieved using GetReferenceData operation. The combination of Disability codes must be valid. An example of invalid combination is: Learning, Physical and NotStated IncomeAmount Optional Int Must be sent as true for the client to be added. FirstArrivalMonth Optional String Month Client first arrived in Australia Full name of the month: January, February, March, April, May, June, July, August, September, October, November, December FirstArrivalYear Optional Int Year Client first arrived in Australia
Did Legal Practitioner Assist With Formalising Agreement Boolean Was Legal Practitioner, when ParentingAgreement was formalised Section 60I Section 60I Type Code String DSS’s Section60IType code. Date Issued DateTime Date Section60 Certificate is issued GetCase Example Response Message <GetCaseResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/> </TransactionStatus> <Case> <CaseDetail> <CaseId>CA0050</CaseId> <OutletActivityId>946</OutletActivityId> <OutletName>AAAAustralianSupportServices</OutletName> <ProgramActivityName>Children'sContactServices</ProgramActivityName> <TotalNumberOfUnidentifiedClients>28</TotalNumberOfUnidentifiedClients> <ParentingAgreementOutcomeCode>Full</ParentingAgreementOutcomeCode> </CaseDetail> <CreatedDateTime>2014-05-14T14:52:05.92</CreatedDateTime> <Clients> <CaseClient> <ClientId>DT7</ClientId> <ReasonsForAssistance/> <ReferralSourceCode/> <ExitReasonCode/> </CaseClient> <CaseClient> <ClientId>079</ClientId> <ReasonsForAssistance/>
UpdateCase Example Request Definition Field Mandatory Conditional Optional Data Type Length Reference Date Comments Validation Rules Case CaseId Mandatory String 50 Provider’s Case Id. It is used to retrieve and update the Case record in DSS database. CaseId cannot be updated to new value. OutletActivityId Mandatory Int DSS’s OutletActivityId. Must be for an active OutletActivity. Can be retrieved using GetOutletActivities operation. Cannot be updated for Cases which have Sessions attached. TotalNumberOfUnidentifiedClients Mandatory Int Number of unidentified clients. Allowed range 0-999. Clients Optional Array (String) Zero or More Provider CaseClient to be associated with the Case. The Client should already be registered for the user’s organisation. The existing attached CaseClient which are not passed in the request will be removed. CaseClient Conditional Mandatory String ClientId Conditional Mandatory String Provider’s Client Id. Mandatory If Client is provided It has to be unique for all the clients registered with the Organisation. ReasonsForAssistance Optional
Referral Optional Client Referral at the Session TypeCode Conditional Mandatory String DSS’s Referral Type Code Mandatory If Referral is provided Can be retrieved using GetReferenceData operation. PurposeCodes Conditional Mandatory Array (string) List Of DSS’s Referral Purpose codes Mandatory If Referral is provided Purpose Conditional Mandatory String DSS’s Referral Purpose codes Mandatory If Referral is provided Can be retrieved using GetReferenceData operation. AddSession Example Request Message <AddSessionRequest> <!--typestring--> <CaseId>UTCa11082014</CaseId> <Session> <!--typestring--> <SessionId>UTSe11082014</SessionId> <!--typedateTime--> <SessionDate>2014-05-10T190103+1100</SessionDate> <!--typeint--> <ServiceTypeId>22</ServiceTypeId> <!--typeint--> <TotalNumberOfUnidentifiedClients>3</TotalNumberOfUnidentifiedClients> <!--Optional--> <!--typedecimal--> <FeesCharged>1000.00</FeesCharged> <!--Optional--> <!--typestring-->
</Clients> </Session> </AddSessionRequest> AddSession Response Message Definition If the transaction is successful, the following structure will be returned. Field Data Type Reference Date Comments Validation Rules TransactionStatus AddSession Example Response Message <AddSessionResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/> </TransactionStatus> </AddSessionResponse> GetSession GetSession operation can be used to retrieve details of a Session within a Case. The operation also returns the clients attached to the Session. GetSession Request Message Definition Field Mandatory Conditional Optional Data Type Length Reference Date Comments Validation Rules CaseId Mandatory String 30 Provider’s Case Id. SessionId Mandatory String 30 Provider’s Session Id.
<Assessment> <AssessmentPhaseCode>PRE</AssessmentPhaseCode> <ScoreTypeCode>CIRCUMSTANCES</ScoreTypeCode> <Scores> <ScoreCode>AGE1</ScoreCode> </Scores> </Assessment> </ClientAssessments> </SessionClientExtendedDetail> </Clients> <SessionAssessments> <Assessment> <AssessmentPhaseCode>PRE</AssessmentPhaseCode> <ScoreTypeCode>GROUP</ScoreTypeCode> <Scores> <ScoreCode>ORGSKILLS1</ScoreCode> </Scores> </Assessment> </SessionAssessments> </Session> </GetSessionResult> </GetSessionResponse> UpdateSession The UpdateSession operation is to be used when a Service Provider wishes to updated previously submitted Session data to DSS. This includes adding additional clients, removing clients, etc. UpdateSession Request Message Definition Field Mandatory Conditional Optional Data Type Length Date Comments Validation Rules CaseId Mandatory String Provider’s Case Id. Must be an existing Case which is not locked.
Session SessionId Mandatory String 30 Provider’s Session Id. Session Id and Case Id are used to identify a unique Session record which is updated. SessionId cannot be updated to new value. SessionDate Mandatory Date of the Session. Must be in Past and within OutletActivity date range. ServiceTypeId Mandatory Int DSSs ServiceTypeId. Can be retrieved using GetServiceTypeForOutletActivity. TotalNumberOfUnidentifiedClients Mandatory Int Cannot exceed TotalNumberOfUnidentifiedClients in a Case. FeesCharged Optional Decimal Fess Charges to Client for selective service Types Optional String DSS’s Money Business Community Education Workshop Code Can be retrieved using GetReferenceData operation. InterpreterPresent Optional Boolean Specifying where interpreter was present for a session ExtraItems Optional Array Optional according to Activity and Service type ExtraItem Optional String Quantity Optional Int Optional according to Activity and Service type Time Optional Int Optional according to Activity and Service type
<!--Zeroormorerepetitions--> <SessionClient> <!--typestring--> <ClientId>CL0050</ClientId> <!--typestring--> <ParticipationCode>SUPPORT</ParticipationCode> <!--Optional--> <ClientReferralOutWithPurpose> <!--Zeroormorerepetitions--> <Referral> <!--typestring--> <TypeCode>ERNAL</TypeCode> <PurposeCodes> <!--Zeroormorerepetitions--> <!--typestring--> <Purpose>AGE</Purpose> </PurposeCodes> </Referral> </ClientReferralOutWithPurpose> </SessionClient> </Clients> </UpdateSessionRequest> UpdateSession Response Message Definition If the transaction is successful, the following structure will be returned. Field Data Type Reference Date Comments Validation Rules TransactionStatus UpdateSession Example Response Message <UpdateSessionResponse> <TransactionStatus> <TransactionStatusCode>Success</TransactionStatusCode> <Messages/>
HasDisabilities Specifying if Client has disabilities IsHomeless Homeless indicator HouseholdCompositionCode String HouseholdCompositionCode Code value MainSourceOfIncomeCode String MainSourceOfIncomeCode Code value IncomeFrequencyCode String IncomeFrequencyCode Code value IncomeAmount Int Client IncomeAmount FirstArrivalMonth String Month Client first arrived in Australia Full name of the month: January, February, March, April, May, June, July, August, September, October, November, December FirstArrivalYear Int Year Client first arrived in Australia MigrationVisaCategoryCode String MigrationVisaCategoryCode Code value AncestryCode String AncestryCode Code value Disabilities Array DisabilityCode String The Disability code value CreatedDateTime DateTime Client was created in DSSs database
AGDTYPE Case: ParentingAgreementOutcome: ParentingAgreementOutcomeCode, DateOfParentingAgreement, Section60I: Section60ICertificateTypeCode DateIssued Session: FeesCharged When applied to an Activity, “ParentingAgreementOutcomeCode”, “DateOfParentingAgreement”, ”DidLegalPractitionerAssistWithFormalisingAgreement”, “Section60ICertificateTypeCode” and “DateIssued” properties on Case and “FeesCharged” property on Session can be supplied. EXITCASE Case Client: ExitReasonCode When applied to an Activity, “ExitReasonCode” property for the Case Client can be supplied