E-Portal/Electronic Service List Web Service Operations

Contents

Document Version Control

Objective

Reference Documents

Assumptions

Symbols and Abbreviations

Terms and Definitions

ElectronicServiceList Web Service Deployment View

Message Flows between External System and E-Portal

Operations, Messages

Operations

Types

FilerCaseListType – Summary information about a service list case. Part of GetElectronicServiceListCases operation response

CaseType - Detailed information about a service list case including filers and other recipients. Part of GetElectronicServiceListCase operation response

FilerType – Information about a filer on service list case

Message Formats

Specifying Service information in a Review Filing Request

ElectronicServiceList Web Service Operation Implementation Notes

Specifying Credentials

Checking for Operation Success/Failure

All opreration responses derive from BaseResponseType and include a list of errors and or warnings. See documentation in the WSDL

GetElectronicServiceListCasesOperation

Minimum Required Elements

Validations

Response

GetElectronicServiceListCase Operation

Minimum Required Elements

Validations

Response

UpdateElectronicServiceListCase Operation

Minimum Required Elements

Validations

Response

Document Version Control

Date / Version # / Editor / Description of Change
09/01/2013 / 1.00 / D V Rao / Initial Draft
9/26/2013 / 2.00 / Jennifer Fishback/Carolyn Weber / Questions and editing
10/07/2013 / 2.01 / D V Rao / Removed Update Operations

Objective

The objective of this document is to document the Electronic Service List Web Service operations. Electronic Service List Web Service is part of the eservice implementation. As part of eservice implementation at the portal, service list (List of names and email addresses) that can receive documents for a given case is maintained. External applications can access to the service list through Electronic Service List Web Service

Electronic Service List Web Service implements following operations

1)“GetElectronicServiceListCases” – Get a summary of cases associated with a portal user

2)“GetElectronicServiceListCase” – Get Service list for a given case by UCN or Portal Case ID

Reference Documents

Electronic Service List WSDL

Assumptions

Electronic Service List Operations are implemented as Web Services, and are accessible over a public network,and use XML messaging for data exchange. Web services complies with the following web service interoperability specifications:

WS-I Basic Profile Version 1.1
W3C Simple Object Access Protocol (SOAP) 1.1
WS-I Simple SOAP Binding Profile Version 1.0
W3C Web WSDL 1.1
W3C XML Schema 1.0
W3C Namespaces in XML.

External Systems are required to provide credentials provided by portal operators to consume the service operations.

Symbols and Abbreviations

OASIS

Organization for the Advancement of Structured Information Standards

ECF 4.0

Electronic Court Filing 4.0 Specification

GJXDM

Global Justice XML Data Model

NIEM

National Information Exchange Model

MDE

Major Design Element

W3C

World Wide Web Consortium

WS-I

Web Services Interoperability organization

CMS

Case Maintenance System

DMS

Document Management System

Terms and Definitions

E-Portal

Common entry point for court electronic filings in the state of Florida

Service List for a case

List of Names and email addresses that can receive service on a given case

Electronic Service List Web Service

Web Service to retrieve or update Service List information

ElectronicServiceList Web Service Deployment View

Message Flows between External System and E-Portal

Page 1 of 15

Operations, Messages

Operations

Operation / Called By / Output / Parameters
GetElectronicServiceListCases / External Application / GetElectronicServiceListCasesResponse / GetElectronicServiceListCasesRequest
GetElectronicServiceListCase / External Application / GetElectronicServiceListCaseResponse / GetElectronicServiceListCase Request

Types

FilerCaseListType–Summary information about a service list case. Part of GetElectronicServiceListCases operation response

XML Name Space

<xsd:complexTypename="FilerCaseListType"

<xsd:sequence

<xsd:elementminOccurs="1"maxOccurs="1"name="Id"type="xsd:long"

<xsd:annotation

<xsd:documentationUnique System Assigned ID. This is the Primary key.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="UniformCaseNumber"type="xsd:string"

<xsd:annotation

<xsd:documentationUniform Case Number. Also has a unique index</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="ClerkCaseNumber"type="xsd:string"

<xsd:annotation

<xsd:documentationClerk Case Number.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="CreationDate"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationDate when Service List entry is first created.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="OrganizationId"type="xsd:int"

<xsd:annotation

<xsd:documentationPortal Organization Id. For Trial Courts , this is the same CCIS county number </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Organization"type="xsd:string"

<xsd:annotation

<xsd:documentationOrganziation Name.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="CaseStyle"type="xsd:string"

<xsd:annotation

<xsd:documentationCase Style (AKA Name).</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="CaseType"type="xsd:string"

<xsd:annotation

<xsd:documentationHuman Redable Case Type. Currently Not used</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="Remarks"type="xsd:string"

<xsd:annotation

<xsd:documentationRemarks. Currently Not used</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Active"type="xsd:boolean"

<xsd:annotation

<xsd:documentationAlways true</xsd:documentation

</xsd:annotation

</xsd:element

</xsd:sequence

</xsd:complexType

CaseType - Detailed information about a service list case including filers and other recipients. Part of GetElectronicServiceListCase operation response

<xsd:complexTypename="CaseType"

<xsd:sequence

<xsd:elementminOccurs="1"maxOccurs="1"name="Id"type="xsd:long"

<xsd:annotation

<xsd:documentationUnique System Assigned ID. This is the Primary key.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="UniformCaseNumber"type="xsd:string"

<xsd:annotation

<xsd:documentationUniform Case Number. Also has a unique index</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="ClerkCaseNumber"type="xsd:string"

<xsd:annotation

<xsd:documentationClerk Case Number.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="CreationDate"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationDate when Service List entry is first created.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="OrganizationId"type="xsd:int"

<xsd:annotation

<xsd:documentationPortal Organization Id. For Trial Courts , this is the same CCIS county number </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Organization"type="xsd:string"

<xsd:annotation

<xsd:documentationOrganziation Name.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUserId"type="xsd:int"

<xsd:annotation

<xsd:documentationLast Updated Portal User Id .</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUser"type="xsd:string"

<xsd:annotation

<xsd:documentationLast Updated User.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedTime"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationLast Updated Time.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="CaseStyle"type="xsd:string"

<xsd:annotation

<xsd:documentationCase Style (AKA Name).</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="CaseTypeDescription"type="xsd:string"

<xsd:annotation

<xsd:documentationHuman Redable Case Type. Currently Not used</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="Remarks"type="xsd:string"

<xsd:annotation

<xsd:documentationRemarks. Currently Not used</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="unbounded"name="Filers"type="ess:FilerType"

<xsd:annotation

<xsd:documentationList of Portal users that filed into this case and any other names , email addresses associated with the filer for this case </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="unbounded"name="Filings"type="ess:FilingType"

<xsd:annotation

<xsd:documentationList of Filings.Currently Not used </xsd:documentation

</xsd:annotation

</xsd:element

</xsd:sequence

</xsd:complexType

FilerType – Information about a filer on service list case

<xsd:complexTypename="FilerType"

<xsd:sequence

<xsd:elementminOccurs="1"maxOccurs="1"name="EPortalUserId"type="xsd:int"

<xsd:annotation

<xsd:documentationPortal User Id of the filer that filed into this case . </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Name"type="xsd:string"

<xsd:annotation

<xsd:documentationFiler Name .</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="UseProfileInformationForService"type="xsd:boolean"

<xsd:annotation

<xsd:documentationUsing Filers Profile email addresses for Service. Current Profile Email addresses are listed under PrimaryEmailAddress , AlternateEmailAddress1 and AlternateEmailAddress2</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Active"type="xsd:boolean"

<xsd:annotation

<xsd:documentationtrue- Filer is accepting service on this case. false - filer is no longer accepting service on this case </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="PrimaryEmailAddress"type="xsd:string"

<xsd:annotation

<xsd:documentationPrimary Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="AlternateEmailAddress1"type="xsd:string"

<xsd:annotation

<xsd:documentationFirst Alternate Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="AlternateEmailAddress2"type="xsd:string"

<xsd:annotation

<xsd:documentationSecond Alternate Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUserId"type="xsd:int"

<xsd:annotation

<xsd:documentationLast Updated Portal User Id .</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUser"type="xsd:string"

<xsd:annotation

<xsd:documentationLast Updated User.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedTime"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationLast Updated Time.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="unbounded"name="OtherServiceRecipients"type="ess:OtherServiceRecipientType"

<xsd:annotation

<xsd:documentationOther names , email addresses associated with the filer for this case .</xsd:documentation

</xsd:annotation

</xsd:element

</xsd:sequence

</xsd:complexType

OtherServiceRecipientType – Information about other service recipients associated with a filer on a given case

xsd:complexTypename="OtherServiceRecipientType"

<xsd:sequence

<xsd:elementminOccurs="1"maxOccurs="1"name="SequenceNumber"type="xsd:int"

<xsd:annotation

<xsd:documentationSequence Number . System Assigned </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="EPortalUserId"type="xsd:int"

<xsd:annotation

<xsd:documentationPortal User Id of the filer that filed into this case. If the person is not registered at the portal then this value will be -1 </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="Name"type="xsd:string"

<xsd:annotation

<xsd:documentationName</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="UseProfileInformationForService"type="xsd:boolean"

<xsd:annotation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="PrimaryEmailAddress"type="xsd:string"

<xsd:annotation

<xsd:documentationPrimary Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="AlternateEmailAddress1"type="xsd:string"

<xsd:annotation

<xsd:documentationFirst Alternate Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="1"name="AlternateEmailAddress2"type="xsd:string"

<xsd:annotation

<xsd:documentationSecond Alternate Email Address</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUserId"type="xsd:int"

<xsd:annotation

<xsd:documentationLast Updated Portal User Id .</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedUser"type="xsd:string"

<xsd:annotation

<xsd:documentationLast Updated User.</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="LastUpdatedTime"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationLast Updated Time.</xsd:documentation

</xsd:annotation

</xsd:element

</xsd:sequence

</xsd:complexType

Message Formats

See WSDL at

Specifying Service information in a Review Filing Request

ReviewFilingRequest (urn:oasis:names:tc:legalxml-courtfiling:wsdl:WebServiceMessagingProfile-Definitions-4.0:ReviewFilingRequestMessageType) includes “ElectronicServiceInformation” elements and this element is used to specify the service recipients. It should be noted that you do not need to consume Electronic Service List Web Service operations in order to generate ElectronicServiceInformation element. It can be generated using information that SA/PD applications have access to already. Sample XML for “ElectronicServiceInformation” element is as below.

<ecf:ElectronicServiceInformation s:id="1">

<ecf:ServiceRecipientID s:id="14" s:metadata="Garrison 425 Keiler JR">

<nc:IdentificationID>;;</nc:IdentificationID>

<nc:IdentificationCategoryText>Electronic</nc:IdentificationCategoryText>

</ecf:ServiceRecipientID>

</ecf:ElectronicServiceInformation>

ElectronicServiceListWeb Service Operation Implementation Notes

Specifying Credentials

All operations require authentication and service consumer must include username and password with each request. [JF1]These credentials are used for authentication only and doe not authorize caller any other access to the portal functions or services

Checking for Operation Success/Failure

All operation responses derive from BaseResponseType and include a list of errors and or warnings. See documentation in the WSDL

<xsd:complexTypename="BaseResponseType"

<xsd:annotation

<xsd:appinfo

<keepNamespaceDeclarationsnamespaces</keepNamespaceDeclarations

</xsd:appinfo

</xsd:annotation

<xsd:sequence

<xsd:elementminOccurs="0"maxOccurs="unbounded"name="Errors"type="xsd:string"

<xsd:annotation

<xsd:documentationErrors</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="0"maxOccurs="unbounded"name="Warnings"type="xsd:string"

<xsd:annotation

<xsd:documentationWarnings</xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="OperationSuccessful"type="xsd:boolean"

<xsd:annotation

<xsd:documentationtrue - operation completed successfully. false otherwise. OperationSuccessful will be true even if there are warnings or no matching data found </xsd:documentation

</xsd:annotation

</xsd:element

<xsd:elementminOccurs="1"maxOccurs="1"name="ResponseTime"type="xsd:dateTime"

<xsd:annotation

<xsd:documentationTimestamp</xsd:documentation

</xsd:annotation

</xsd:element

</xsd:sequence

</xsd:complexType

Page 1 of 15

GetElectronicServiceListCasesOperation

GetElectronicServiceListCases operation takes as input a portal user id and returns a summary of service list cases associated with that filer.

Minimum Required Elements

1)LogonName

2)Password

3)FilerID – E-Portal Unique User ID

Validations

Portal Logon Name must be provided
Portal Password must be provided
Portal User Account must be active
FilerID must be a valid ID in the system

Response

Collection of FilerCaseListType

GetElectronicServiceListCase Operation

GetElectronicServiceListCase operation takes as input a portal case id or Uniform Case Number and returns a service list

Minimum Required Elements

1)LogonName

2)Password

3)FilerID – E-Portal Unique User ID

Validations

Portal Logon Name must be provided
Portal Password must be provided
Portal User Account must be active

Response

CaseType

Page 1 of 15

[JF1]Is this a user id and password from the potal registered users? Does that mean anyone registered on the portal can receive the eService list?